Debian Codegraph @

src/ansiblelint/schemas/ansible.json

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