Debian Codegraph @

src/ansiblelint/schemas/playbook.json

raw
1 {
2 "$comment": "Generated from ansible.json, do not edit.",
3 "$defs": {
4 "ansible.builtin.import_playbook": {
5 "additionalProperties": false,
6 "oneOf": [
7 {
8 "not": {
9 "required": [
10 "import_playbook"
11 ]
12 },
13 "required": [
14 "ansible.builtin.import_playbook"
15 ]
16 },
17 {
18 "not": {
19 "required": [
20 "ansible.builtin.import_playbook"
21 ]
22 },
23 "required": [
24 "import_playbook"
25 ]
26 }
27 ],
28 "patternProperties": {
29 "^(ansible\\.builtin\\.)?import_playbook$": {
30 "markdownDescription": "* Includes a file with a list of plays to be executed.\n * Files with a list of plays can only be included at the top level.\n * You cannot use this action inside a play.\n\nSee [import_playbook](https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/import_playbook_module.html)",
31 "title": "Import Playbook",
32 "type": "string"
33 },
34 "name": {
35 "title": "Name",
36 "type": "string"
37 },
38 "tags": {
39 "$ref": "#/$defs/tags"
40 },
41 "vars": {
42 "title": "Vars",
43 "type": "object"
44 },
45 "when": {
46 "$ref": "#/$defs/complex_conditional",
47 "title": "When"
48 }
49 },
50 "type": "object"
51 },
52 "become_method": {
53 "anyOf": [
54 {
55 "enum": [
56 "ansible.builtin.sudo",
57 "ansible.builtin.su",
58 "community.general.pbrun",
59 "community.general.pfexec",
60 "ansible.builtin.runas",
61 "community.general.dzdo",
62 "community.general.ksu",
63 "community.general.doas",
64 "community.general.machinectl",
65 "community.general.pmrun",
66 "community.general.sesu",
67 "community.general.sudosu"
68 ],
69 "type": "string"
70 },
71 {
72 "$ref": "#/$defs/full-jinja"
73 },
74 {
75 "pattern": "[A-Za-z0-9_\\.]+",
76 "type": "string"
77 }
78 ],
79 "markdownDescription": "See [become](https://docs.ansible.com/projects/ansible/latest/user_guide/become.html)",
80 "title": "Become Method"
81 },
82 "block": {
83 "properties": {
84 "always": {
85 "items": {
86 "anyOf": [
87 {
88 "$ref": "#/$defs/task"
89 },
90 {
91 "$ref": "#/$defs/block"
92 }
93 ]
94 },
95 "title": "Always",
96 "type": "array"
97 },
98 "any_errors_fatal": {
99 "$ref": "#/$defs/templated-boolean",
100 "title": "Any Errors Fatal"
101 },
102 "become": {
103 "$ref": "#/$defs/templated-boolean",
104 "title": "Become"
105 },
106 "become_exe": {
107 "title": "Become Exe",
108 "type": "string"
109 },
110 "become_flags": {
111 "title": "Become Flags",
112 "type": "string"
113 },
114 "become_method": {
115 "$ref": "#/$defs/become_method"
116 },
117 "become_user": {
118 "title": "Become User",
119 "type": "string"
120 },
121 "block": {
122 "items": {
123 "anyOf": [
124 {
125 "$ref": "#/$defs/task"
126 },
127 {
128 "$ref": "#/$defs/block"
129 }
130 ]
131 },
132 "markdownDescription": "Blocks create logical groups of tasks. Blocks also offer ways to handle task errors, similar to exception handling in many programming languages. See [blocks](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_blocks.html)",
133 "title": "Block",
134 "type": "array"
135 },
136 "check_mode": {
137 "$ref": "#/$defs/complex_conditional",
138 "title": "Check Mode"
139 },
140 "collections": {
141 "items": {
142 "type": "string"
143 },
144 "title": "Collections",
145 "type": "array"
146 },
147 "connection": {
148 "title": "Connection",
149 "type": "string"
150 },
151 "debugger": {
152 "title": "Debugger",
153 "type": "string"
154 },
155 "delegate_facts": {
156 "title": "Delegate Facts",
157 "type": "boolean"
158 },
159 "delegate_to": {
160 "title": "Delegate To",
161 "type": "string"
162 },
163 "diff": {
164 "$ref": "#/$defs/templated-boolean",
165 "title": "Diff"
166 },
167 "environment": {
168 "$ref": "#/$defs/environment"
169 },
170 "ignore_errors": {
171 "$ref": "#/$defs/ignore_errors"
172 },
173 "ignore_unreachable": {
174 "$ref": "#/$defs/templated-boolean",
175 "title": "Ignore Unreachable"
176 },
177 "module_defaults": {
178 "title": "Module Defaults"
179 },
180 "name": {
181 "title": "Name",
182 "type": "string"
183 },
184 "no_log": {
185 "$ref": "#/$defs/templated-boolean"
186 },
187 "port": {
188 "$ref": "#/$defs/templated-integer"
189 },
190 "remote_user": {
191 "title": "Remote User",
192 "type": "string"
193 },
194 "rescue": {
195 "items": {
196 "anyOf": [
197 {
198 "$ref": "#/$defs/task"
199 },
200 {
201 "$ref": "#/$defs/block"
202 }
203 ]
204 },
205 "title": "Rescue",
206 "type": "array"
207 },
208 "run_once": {
209 "$ref": "#/$defs/templated-boolean",
210 "title": "Run Once"
211 },
212 "tags": {
213 "$ref": "#/$defs/tags",
214 "title": "Tags"
215 },
216 "throttle": {
217 "$ref": "#/$defs/templated-integer",
218 "title": "Throttle"
219 },
220 "timeout": {
221 "$ref": "#/$defs/templated-integer",
222 "title": "Timeout"
223 },
224 "vars": {
225 "title": "Vars",
226 "type": "object"
227 },
228 "when": {
229 "$ref": "#/$defs/complex_conditional",
230 "title": "When"
231 }
232 },
233 "required": [
234 "block"
235 ],
236 "type": "object"
237 },
238 "complex_conditional": {
239 "oneOf": [
240 {
241 "type": "boolean"
242 },
243 {
244 "type": "string"
245 },
246 {
247 "items": {
248 "anyOf": [
249 {
250 "type": "boolean"
251 },
252 {
253 "type": "string"
254 }
255 ]
256 },
257 "type": "array"
258 }
259 ]
260 },
261 "environment": {
262 "anyOf": [
263 {
264 "additionalProperties": {
265 "type": "string"
266 },
267 "type": "object"
268 },
269 {
270 "$ref": "#/$defs/full-jinja"
271 }
272 ],
273 "title": "Environment"
274 },
275 "full-jinja": {
276 "pattern": "^\\{[\\{%](.|[\r\n])*[\\}%]\\}$",
277 "type": "string"
278 },
279 "ignore_errors": {
280 "$ref": "#/$defs/templated-boolean",
281 "markdownDescription": "See [ignore_errors](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_error_handling.html#ignoring-failed-commands)",
282 "title": "Ignore Errors"
283 },
284 "no_log": {
285 "$ref": "#/$defs/templated-boolean",
286 "markdownDescription": "Use for protecting sensitive data. See [no_log](https://docs.ansible.com/projects/ansible/latest/reference_appendices/logging.html)",
287 "title": "no_log"
288 },
289 "play": {
290 "additionalProperties": false,
291 "allOf": [
292 {
293 "not": {
294 "required": [
295 "ansible.builtin.import_playbook"
296 ]
297 }
298 },
299 {
300 "not": {
301 "required": [
302 "import_playbook"
303 ]
304 }
305 }
306 ],
307 "properties": {
308 "any_errors_fatal": {
309 "$ref": "#/$defs/templated-boolean",
310 "title": "Any Errors Fatal"
311 },
312 "become": {
313 "$ref": "#/$defs/templated-boolean",
314 "title": "Become"
315 },
316 "become_exe": {
317 "title": "Become Exe",
318 "type": "string"
319 },
320 "become_flags": {
321 "title": "Become Flags",
322 "type": "string"
323 },
324 "become_method": {
325 "$ref": "#/$defs/become_method"
326 },
327 "become_user": {
328 "title": "Become User",
329 "type": "string"
330 },
331 "check_mode": {
332 "$ref": "#/$defs/complex_conditional",
333 "title": "Check Mode"
334 },
335 "collections": {
336 "items": {
337 "type": "string"
338 },
339 "title": "Collections",
340 "type": "array"
341 },
342 "connection": {
343 "title": "Connection",
344 "type": "string"
345 },
346 "debugger": {
347 "title": "Debugger",
348 "type": "string"
349 },
350 "diff": {
351 "$ref": "#/$defs/templated-boolean",
352 "title": "Diff"
353 },
354 "environment": {
355 "$ref": "#/$defs/environment"
356 },
357 "fact_path": {
358 "title": "Fact Path",
359 "type": "string"
360 },
361 "force_handlers": {
362 "title": "Force Handlers",
363 "type": "boolean"
364 },
365 "gather_facts": {
366 "$ref": "#/$defs/templated-boolean",
367 "title": "Gather Facts"
368 },
369 "gather_subset": {
370 "items": {
371 "anyOf": [
372 {
373 "enum": [
374 "all",
375 "min",
376 "all_ipv4_addresses",
377 "all_ipv6_addresses",
378 "apparmor",
379 "architecture",
380 "caps",
381 "chroot,cmdline",
382 "date_time",
383 "default_ipv4",
384 "default_ipv6",
385 "devices",
386 "distribution",
387 "distribution_major_version",
388 "distribution_release",
389 "distribution_version",
390 "dns",
391 "effective_group_ids",
392 "effective_user_id",
393 "env",
394 "facter",
395 "fips",
396 "hardware",
397 "interfaces",
398 "is_chroot",
399 "iscsi",
400 "kernel",
401 "local",
402 "lsb",
403 "machine",
404 "machine_id",
405 "mounts",
406 "network",
407 "ohai",
408 "os_family",
409 "pkg_mgr",
410 "platform",
411 "processor",
412 "processor_cores",
413 "processor_count",
414 "python",
415 "python_version",
416 "real_user_id",
417 "selinux",
418 "service_mgr",
419 "ssh_host_key_dsa_public",
420 "ssh_host_key_ecdsa_public",
421 "ssh_host_key_ed25519_public",
422 "ssh_host_key_rsa_public",
423 "ssh_host_pub_keys",
424 "ssh_pub_keys",
425 "system",
426 "system_capabilities",
427 "system_capabilities_enforced",
428 "systemd",
429 "user",
430 "user_dir",
431 "user_gecos",
432 "user_gid",
433 "user_id",
434 "user_shell",
435 "user_uid",
436 "virtual",
437 "virtualization_role",
438 "virtualization_type"
439 ],
440 "type": "string"
441 },
442 {
443 "enum": [
444 "!all",
445 "!min",
446 "!all_ipv4_addresses",
447 "!all_ipv6_addresses",
448 "!apparmor",
449 "!architecture",
450 "!caps",
451 "!chroot,cmdline",
452 "!date_time",
453 "!default_ipv4",
454 "!default_ipv6",
455 "!devices",
456 "!distribution",
457 "!distribution_major_version",
458 "!distribution_release",
459 "!distribution_version",
460 "!dns",
461 "!effective_group_ids",
462 "!effective_user_id",
463 "!env",
464 "!facter",
465 "!fips",
466 "!hardware",
467 "!interfaces",
468 "!is_chroot",
469 "!iscsi",
470 "!kernel",
471 "!local",
472 "!lsb",
473 "!machine",
474 "!machine_id",
475 "!mounts",
476 "!network",
477 "!ohai",
478 "!os_family",
479 "!pkg_mgr",
480 "!platform",
481 "!processor",
482 "!processor_cores",
483 "!processor_count",
484 "!python",
485 "!python_version",
486 "!real_user_id",
487 "!selinux",
488 "!service_mgr",
489 "!ssh_host_key_dsa_public",
490 "!ssh_host_key_ecdsa_public",
491 "!ssh_host_key_ed25519_public",
492 "!ssh_host_key_rsa_public",
493 "!ssh_host_pub_keys",
494 "!ssh_pub_keys",
495 "!system",
496 "!system_capabilities",
497 "!system_capabilities_enforced",
498 "!systemd",
499 "!user",
500 "!user_dir",
501 "!user_gecos",
502 "!user_gid",
503 "!user_id",
504 "!user_shell",
505 "!user_uid",
506 "!virtual",
507 "!virtualization_role",
508 "!virtualization_type"
509 ],
510 "type": "string"
511 }
512 ]
513 },
514 "title": "Gather Subset",
515 "type": "array"
516 },
517 "gather_timeout": {
518 "$ref": "#/$defs/templated-integer",
519 "title": "Gather Timeout"
520 },
521 "handlers": {
522 "$ref": "#/$defs/tasks"
523 },
524 "hosts": {
525 "anyOf": [
526 {
527 "type": "string"
528 },
529 {
530 "items": {
531 "type": "string"
532 },
533 "type": "array"
534 }
535 ],
536 "title": "Hosts"
537 },
538 "ignore_errors": {
539 "$ref": "#/$defs/ignore_errors"
540 },
541 "ignore_unreachable": {
542 "$ref": "#/$defs/templated-boolean",
543 "title": "Ignore Unreachable"
544 },
545 "max_fail_percentage": {
546 "$ref": "#/$defs/templated-integer",
547 "title": "Max Fail Percentage"
548 },
549 "module_defaults": {
550 "title": "Module Defaults"
551 },
552 "name": {
553 "title": "Name",
554 "type": "string"
555 },
556 "no_log": {
557 "$ref": "#/$defs/templated-boolean"
558 },
559 "order": {
560 "markdownDescription": "See https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_strategies.html#ordering-execution-based-on-inventory",
561 "oneOf": [
562 {
563 "enum": [
564 "inventory",
565 "reverse_inventory",
566 "reverse_sorted",
567 "shuffle",
568 "sorted"
569 ],
570 "type": "string"
571 },
572 {
573 "$ref": "#/$defs/full-jinja"
574 }
575 ],
576 "title": "Order"
577 },
578 "port": {
579 "$ref": "#/$defs/templated-integer",
580 "title": "Port"
581 },
582 "post_tasks": {
583 "$ref": "#/$defs/tasks"
584 },
585 "pre_tasks": {
586 "$ref": "#/$defs/tasks"
587 },
588 "remote_user": {
589 "title": "Remote User",
590 "type": "string"
591 },
592 "roles": {
593 "items": {
594 "anyOf": [
595 {
596 "$ref": "#/$defs/play-role"
597 },
598 {
599 "type": "string"
600 }
601 ]
602 },
603 "markdownDescription": "Roles let you automatically load related vars, files, tasks, handlers, and other Ansible artifacts based on a known file structure. After you group your content in roles, you can easily reuse them and share them with other users.\n See [roles](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_reuse_roles.html#roles)",
604 "title": "Roles",
605 "type": "array"
606 },
607 "run_once": {
608 "$ref": "#/$defs/templated-boolean",
609 "title": "Run Once"
610 },
611 "serial": {
612 "anyOf": [
613 {
614 "$ref": "#/$defs/templated-integer-or-percent"
615 },
616 {
617 "items": {
618 "$ref": "#/$defs/templated-integer-or-percent"
619 },
620 "type": "array"
621 }
622 ],
623 "markdownDescription": "Integer, percentage or list of those. See [Setting the batch size with serial](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_strategies.html#setting-the-batch-size-with-serial)",
624 "title": "Batch size"
625 },
626 "strategy": {
627 "title": "Strategy",
628 "type": "string"
629 },
630 "tags": {
631 "$ref": "#/$defs/tags",
632 "title": "Tags"
633 },
634 "tasks": {
635 "$ref": "#/$defs/tasks"
636 },
637 "throttle": {
638 "$ref": "#/$defs/templated-integer",
639 "title": "Throttle"
640 },
641 "timeout": {
642 "$ref": "#/$defs/templated-integer",
643 "title": "Timeout"
644 },
645 "user": {
646 "title": "Remote User",
647 "type": "string"
648 },
649 "vars": {
650 "title": "Vars",
651 "type": "object"
652 },
653 "vars_files": {
654 "items": {
655 "oneOf": [
656 {
657 "type": "string"
658 },
659 {
660 "items": {
661 "type": "string"
662 },
663 "type": "array"
664 }
665 ]
666 },
667 "title": "Vars Files",
668 "type": [
669 "array",
670 "string",
671 "null"
672 ]
673 },
674 "vars_prompt": {
675 "items": {
676 "$ref": "#/$defs/vars_prompt"
677 },
678 "markdownDescription": "See [vars_prompt](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_prompts.html)",
679 "title": "vars_prompt",
680 "type": "array"
681 },
682 "when": {
683 "$ref": "#/$defs/complex_conditional",
684 "title": "When"
685 }
686 },
687 "required": [
688 "hosts"
689 ],
690 "title": "play",
691 "type": "object"
692 },
693 "play-role": {
694 "markdownDescription": "See [roles](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_reuse_roles.html#roles)",
695 "properties": {
696 "any_errors_fatal": {
697 "$ref": "#/$defs/templated-boolean",
698 "title": "Any Errors Fatal"
699 },
700 "become": {
701 "$ref": "#/$defs/templated-boolean",
702 "title": "Become"
703 },
704 "become_exe": {
705 "title": "Become Exe",
706 "type": "string"
707 },
708 "become_flags": {
709 "title": "Become Flags",
710 "type": "string"
711 },
712 "become_method": {
713 "$ref": "#/$defs/become_method"
714 },
715 "become_user": {
716 "title": "Become User",
717 "type": "string"
718 },
719 "check_mode": {
720 "$ref": "#/$defs/complex_conditional",
721 "title": "Check Mode"
722 },
723 "collections": {
724 "items": {
725 "type": "string"
726 },
727 "title": "Collections",
728 "type": "array"
729 },
730 "connection": {
731 "title": "Connection",
732 "type": "string"
733 },
734 "debugger": {
735 "title": "Debugger",
736 "type": "string"
737 },
738 "delegate_to": {
739 "title": "Delegate To",
740 "type": "string"
741 },
742 "diff": {
743 "$ref": "#/$defs/templated-boolean",
744 "title": "Diff"
745 },
746 "environment": {
747 "$ref": "#/$defs/environment"
748 },
749 "ignore_errors": {
750 "$ref": "#/$defs/ignore_errors"
751 },
752 "ignore_unreachable": {
753 "$ref": "#/$defs/templated-boolean",
754 "title": "Ignore Unreachable"
755 },
756 "module_defaults": {
757 "title": "Module Defaults"
758 },
759 "name": {
760 "title": "Name",
761 "type": "string"
762 },
763 "no_log": {
764 "$ref": "#/$defs/templated-boolean"
765 },
766 "port": {
767 "$ref": "#/$defs/templated-integer",
768 "title": "Port"
769 },
770 "remote_user": {
771 "title": "Remote User",
772 "type": "string"
773 },
774 "role": {
775 "title": "Role",
776 "type": "string"
777 },
778 "run_once": {
779 "$ref": "#/$defs/templated-boolean",
780 "title": "Run Once"
781 },
782 "tags": {
783 "$ref": "#/$defs/tags",
784 "title": "Tags"
785 },
786 "throttle": {
787 "$ref": "#/$defs/templated-integer",
788 "title": "Throttle"
789 },
790 "timeout": {
791 "$ref": "#/$defs/templated-integer",
792 "title": "Timeout"
793 },
794 "vars": {
795 "title": "Vars",
796 "type": "object"
797 },
798 "when": {
799 "$ref": "#/$defs/complex_conditional",
800 "title": "When"
801 }
802 },
803 "required": [
804 "role"
805 ],
806 "title": "play-role",
807 "type": "object"
808 },
809 "removed-include-module": {
810 "markdownDescription": "See [include module](https://docs.ansible.com/projects/ansible/latest/collections/ansible/builtin/include_module.html)",
811 "not": {},
812 "title": "Replace 'include' with either 'ansible.builtin.include_tasks' or 'ansible.builtin.import_tasks'"
813 },
814 "tags": {
815 "anyOf": [
816 {
817 "type": "string"
818 },
819 {
820 "items": {
821 "type": "string"
822 },
823 "type": "array"
824 }
825 ],
826 "title": "Tags"
827 },
828 "task": {
829 "additionalProperties": true,
830 "allOf": [
831 {
832 "not": {
833 "required": [
834 "hosts"
835 ]
836 }
837 },
838 {
839 "not": {
840 "required": [
841 "tasks"
842 ]
843 }
844 },
845 {
846 "not": {
847 "required": [
848 "import_playbook"
849 ]
850 }
851 },
852 {
853 "not": {
854 "required": [
855 "block"
856 ]
857 }
858 }
859 ],
860 "properties": {
861 "action": {
862 "title": "Action",
863 "type": "string"
864 },
865 "ansible.builtin.include": {
866 "$ref": "#/$defs/removed-include-module"
867 },
868 "ansible.legacy.include": {
869 "$ref": "#/$defs/removed-include-module"
870 },
871 "any_errors_fatal": {
872 "$ref": "#/$defs/templated-boolean",
873 "title": "Any Errors Fatal"
874 },
875 "args": {
876 "$ref": "#/$defs/templated-object",
877 "title": "Args"
878 },
879 "async": {
880 "$ref": "#/$defs/templated-integer",
881 "title": "Async"
882 },
883 "become": {
884 "$ref": "#/$defs/templated-boolean",
885 "title": "Become"
886 },
887 "become_exe": {
888 "title": "Become Exe",
889 "type": "string"
890 },
891 "become_flags": {
892 "title": "Become Flags",
893 "type": "string"
894 },
895 "become_method": {
896 "$ref": "#/$defs/become_method"
897 },
898 "become_user": {
899 "title": "Become User",
900 "type": "string"
901 },
902 "changed_when": {
903 "$ref": "#/$defs/complex_conditional",
904 "markdownDescription": "See [changed_when](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_error_handling.html#defining-changed)",
905 "title": "Changed When"
906 },
907 "check_mode": {
908 "$ref": "#/$defs/complex_conditional",
909 "title": "Check Mode"
910 },
911 "collections": {
912 "items": {
913 "type": "string"
914 },
915 "title": "Collections",
916 "type": "array"
917 },
918 "connection": {
919 "title": "Connection",
920 "type": "string"
921 },
922 "debugger": {
923 "title": "Debugger",
924 "type": "string"
925 },
926 "delay": {
927 "$ref": "#/$defs/templated-integer",
928 "title": "Delay"
929 },
930 "delegate_facts": {
931 "title": "Delegate Facts",
932 "type": "boolean"
933 },
934 "delegate_to": {
935 "title": "Delegate To",
936 "type": "string"
937 },
938 "diff": {
939 "$ref": "#/$defs/templated-boolean",
940 "title": "Diff"
941 },
942 "environment": {
943 "$ref": "#/$defs/environment"
944 },
945 "failed_when": {
946 "$ref": "#/$defs/complex_conditional",
947 "title": "Failed When"
948 },
949 "ignore_errors": {
950 "$ref": "#/$defs/ignore_errors"
951 },
952 "ignore_unreachable": {
953 "$ref": "#/$defs/templated-boolean",
954 "title": "Ignore Unreachable"
955 },
956 "include": {
957 "$ref": "#/$defs/removed-include-module"
958 },
959 "listen": {
960 "anyOf": [
961 {
962 "type": "string"
963 },
964 {
965 "items": {
966 "type": "string"
967 },
968 "type": "array"
969 }
970 ],
971 "markdownDescription": "Applies only to handlers. See [listen](https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_handlers.html)",
972 "title": "Listen"
973 },
974 "local_action": {
975 "title": "Local Action",
976 "type": [
977 "string",
978 "object"
979 ]
980 },
981 "loop": {
982 "title": "Loop",
983 "type": [
984 "string",
985 "array"
986 ]
987 },
988 "loop_control": {
989 "title": "Loop Control"
990 },
991 "module_defaults": {
992 "title": "Module Defaults"
993 },
994 "name": {
995 "title": "Name",
996 "type": "string"
997 },
998 "no_log": {
999 "$ref": "#/$defs/no_log"
1000 },
1001 "notify": {
1002 "anyOf": [
1003 {
1004 "type": "string"
1005 },
1006 {
1007 "items": {
1008 "type": "string"
1009 },
1010 "type": "array"
1011 }
1012 ],
1013 "title": "Notify"
1014 },
1015 "poll": {
1016 "$ref": "#/$defs/templated-integer",
1017 "title": "Poll"
1018 },
1019 "port": {
1020 "$ref": "#/$defs/templated-integer",
1021 "title": "Port"
1022 },
1023 "register": {
1024 "title": "Register",
1025 "type": "string"
1026 },
1027 "remote_user": {
1028 "title": "Remote User",
1029 "type": "string"
1030 },
1031 "retries": {
1032 "$ref": "#/$defs/templated-integer",
1033 "title": "Retries"
1034 },
1035 "run_once": {
1036 "$ref": "#/$defs/templated-boolean",
1037 "title": "Run Once"
1038 },
1039 "tags": {
1040 "$ref": "#/$defs/tags",
1041 "title": "Tags"
1042 },
1043 "throttle": {
1044 "$ref": "#/$defs/templated-integer",
1045 "title": "Throttle"
1046 },
1047 "timeout": {
1048 "$ref": "#/$defs/templated-integer",
1049 "title": "Timeout"
1050 },
1051 "until": {
1052 "$ref": "#/$defs/complex_conditional",
1053 "title": "Until"
1054 },
1055 "vars": {
1056 "title": "Vars",
1057 "type": "object"
1058 },
1059 "when": {
1060 "$ref": "#/$defs/complex_conditional",
1061 "title": "When"
1062 },
1063 "with_dict": {
1064 "title": "With Dict"
1065 },
1066 "with_fileglob": {
1067 "title": "With Fileglob"
1068 },
1069 "with_filetree": {
1070 "title": "With Filetree"
1071 },
1072 "with_first_found": {
1073 "title": "With First Found"
1074 },
1075 "with_indexed_items": {
1076 "title": "With Indexed Items"
1077 },
1078 "with_ini": {
1079 "title": "With Ini"
1080 },
1081 "with_inventory_hostnames": {
1082 "title": "With Inventory Hostnames"
1083 },
1084 "with_items": {
1085 "anyOf": [
1086 {
1087 "$ref": "#/$defs/full-jinja"
1088 },
1089 {
1090 "type": "array"
1091 }
1092 ],
1093 "markdownDescription": "See [loops](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_loops.html#loops)",
1094 "title": "With Items"
1095 },
1096 "with_lines": {
1097 "title": "With Lines"
1098 },
1099 "with_random_choice": {
1100 "title": "With Random Choice"
1101 },
1102 "with_sequence": {
1103 "title": "With Sequence"
1104 },
1105 "with_subelements": {
1106 "title": "With Subelements"
1107 },
1108 "with_together": {
1109 "title": "With Together"
1110 }
1111 },
1112 "title": "task",
1113 "type": "object"
1114 },
1115 "tasks": {
1116 "$schema": "http://json-schema.org/draft-07/schema",
1117 "examples": [
1118 "tasks/*.yml",
1119 "handlers/*.yml"
1120 ],
1121 "items": {
1122 "anyOf": [
1123 {
1124 "$ref": "#/$defs/block"
1125 },
1126 {
1127 "$ref": "#/$defs/task"
1128 }
1129 ]
1130 },
1131 "title": "Ansible Tasks Schema",
1132 "type": [
1133 "array",
1134 "null"
1135 ]
1136 },
1137 "templated-boolean": {
1138 "oneOf": [
1139 {
1140 "type": "boolean"
1141 },
1142 {
1143 "$ref": "#/$defs/full-jinja",
1144 "type": "string"
1145 }
1146 ]
1147 },
1148 "templated-integer": {
1149 "oneOf": [
1150 {
1151 "type": "integer"
1152 },
1153 {
1154 "$ref": "#/$defs/full-jinja",
1155 "type": "string"
1156 }
1157 ]
1158 },
1159 "templated-integer-or-percent": {
1160 "oneOf": [
1161 {
1162 "type": "integer"
1163 },
1164 {
1165 "pattern": "^\\d+\\.?\\d*%?$",
1166 "type": "string"
1167 },
1168 {
1169 "$ref": "#/$defs/full-jinja",
1170 "type": "string"
1171 }
1172 ]
1173 },
1174 "templated-object": {
1175 "oneOf": [
1176 {
1177 "type": "object"
1178 },
1179 {
1180 "$ref": "#/$defs/full-jinja",
1181 "type": "string"
1182 }
1183 ]
1184 },
1185 "vars_prompt": {
1186 "additionalProperties": false,
1187 "properties": {
1188 "confirm": {
1189 "title": "Confirm",
1190 "type": "boolean"
1191 },
1192 "default": {
1193 "title": "Default",
1194 "type": "string"
1195 },
1196 "encrypt": {
1197 "enum": [
1198 "des_crypt",
1199 "bsdi_crypt",
1200 "bigcrypt",
1201 "crypt16",
1202 "md5_crypt",
1203 "bcrypt",
1204 "sha1_crypt",
1205 "sun_md5_crypt",
1206 "sha256_crypt",
1207 "sha512_crypt",
1208 "apr_md5_crypt",
1209 "phpass",
1210 "pbkdf2_digest",
1211 "cta_pbkdf2_sha1",
1212 "dlitz_pbkdf2_sha1",
1213 "scram",
1214 "bsd_nthash"
1215 ],
1216 "title": "Encrypt",
1217 "type": "string"
1218 },
1219 "name": {
1220 "title": "Name",
1221 "type": "string"
1222 },
1223 "private": {
1224 "default": true,
1225 "title": "Private",
1226 "type": "boolean"
1227 },
1228 "prompt": {
1229 "title": "Prompt",
1230 "type": "string"
1231 },
1232 "salt_size": {
1233 "default": 8,
1234 "title": "Salt Size",
1235 "type": "integer"
1236 },
1237 "unsafe": {
1238 "default": false,
1239 "markdownDescription": "See [unsafe](https://docs.ansible.com/projects/ansible/latest/user_guide/playbooks_prompts.html#allowing-special-characters-in-vars-prompt-values)",
1240 "title": "Unsafe",
1241 "type": "boolean"
1242 }
1243 },
1244 "required": [
1245 "name",
1246 "prompt"
1247 ],
1248 "type": "object"
1249 }
1250 },
1251 "$id": "https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/playbook.json",
1252 "$schema": "http://json-schema.org/draft-07/schema",
1253 "examples": [
1254 "playbooks/*.yml",
1255 "playbooks/*.yaml"
1256 ],
1257 "items": {
1258 "oneOf": [
1259 {
1260 "$ref": "#/$defs/ansible.builtin.import_playbook"
1261 },
1262 {
1263 "$ref": "#/$defs/play"
1264 }
1265 ]
1266 },
1267 "title": "Ansible Playbook",
1268 "type": "array"
1269 }