Ansible Playbook

Ansible playbook files

Type array | object
File match playbook.yml playbook.yaml site.yml site.yaml **/playbooks/*.yml **/playbooks/*.yaml
Schema URL https://catalog.lintel.tools/schemas/schemastore/ansible-playbook/latest.json
Source https://raw.githubusercontent.com/ansible/ansible-lint/main/src/ansiblelint/schemas/ansible.json#/$defs/playbook

Validate with Lintel

npx @lintel/lintel check
Type: array | object

https://docs.ansible.com/projects/ansible/latest/reference_appendices/playbooks_keywords.html

Definitions

removed-include-module

See include module

ansible.builtin.import_playbook object
become_method string | full-jinja | string

See become

block object
block task | block[] required

Blocks create logical groups of tasks. Blocks also offer ways to handle task errors, similar to exception handling in many programming languages. See blocks

always task | block[]
any_errors_fatal boolean | string
become boolean | string
become_exe string
become_flags string
become_method string | full-jinja | string

See become

become_user string
check_mode boolean | string | boolean | string[]
collections string[]
connection string
debugger string
delegate_facts boolean
delegate_to string
diff boolean | string
environment object | full-jinja
ignore_errors templated-boolean

See ignore_errors

ignore_unreachable boolean | string
module_defaults
name string
no_log boolean | string
port integer | string
remote_user string
rescue task | block[]
run_once boolean | string
tags string | string[]
throttle integer | string
timeout integer | string
vars object
when boolean | string | boolean | string[]
complex_conditional boolean | string | boolean | string[]
environment object | full-jinja
full-jinja string
ignore_errors boolean | string
no_log boolean | string
play object
hosts string | string[] required
any_errors_fatal boolean | string
become boolean | string
become_exe string
become_flags string
become_method string | full-jinja | string

See become

become_user string
check_mode boolean | string | boolean | string[]
collections string[]
connection string
debugger string
diff boolean | string
environment object | full-jinja
fact_path string
force_handlers boolean
gather_facts boolean | string
gather_subset string | string[]
gather_timeout integer | string
handlers array | null
Examples: "tasks/*.yml", "handlers/*.yml"
ignore_errors templated-boolean

See ignore_errors

ignore_unreachable boolean | string
max_fail_percentage integer | string
module_defaults
name string
no_log boolean | string
order string | full-jinja

See https://docs.ansible.com/projects/ansible/latest/playbook_guide/playbooks_strategies.html#ordering-execution-based-on-inventory

port integer | string
post_tasks array | null
Examples: "tasks/*.yml", "handlers/*.yml"
pre_tasks array | null
Examples: "tasks/*.yml", "handlers/*.yml"
remote_user string
roles play-role | string[]

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. See roles

run_once boolean | string
serial templated-integer-or-percent | templated-integer-or-percent[]

Integer, percentage or list of those. See Setting the batch size with serial

strategy string
tags string | string[]
tasks array | null
Examples: "tasks/*.yml", "handlers/*.yml"
throttle integer | string
timeout integer | string
user string
vars object
vars_files array | string | null
vars_prompt vars_prompt[]

See vars_prompt

when boolean | string | boolean | string[]
play-argspec object
Examples:
  • "**/*.meta.yml"
  • "**/*.meta.yaml"
short_description string required

Brief description of the playbook

description string required

Detailed description of the playbook

argument_specs object required

Argument specifications for the playbook

play-role object

See roles

role string required
any_errors_fatal boolean | string
become boolean | string
become_exe string
become_flags string
become_method string | full-jinja | string

See become

become_user string
check_mode boolean | string | boolean | string[]
collections string[]
connection string
debugger string
delegate_to string
diff boolean | string
environment object | full-jinja
ignore_errors templated-boolean

See ignore_errors

ignore_unreachable boolean | string
module_defaults
name string
no_log boolean | string
port integer | string
remote_user string
run_once boolean | string
tags string | string[]
throttle integer | string
timeout integer | string
vars object
when boolean | string | boolean | string[]
playbook ansible.builtin.import_playbook | play[]
Examples:
  • "playbooks/*.yml"
  • "playbooks/*.yaml"
tags string | string[]
task object
action string
ansible.builtin.include

See include module

include

See include module

ansible.legacy.include

See include module

any_errors_fatal boolean | string
args object | string
async integer | string
become boolean | string
become_exe string
become_flags string
become_method string | full-jinja | string

See become

become_user string
changed_when boolean | string | boolean | string[]
check_mode boolean | string | boolean | string[]
collections string[]
connection string
debugger string
delay integer | string
delegate_facts boolean
delegate_to string
diff boolean | string
environment object | full-jinja
failed_when boolean | string | boolean | string[]
ignore_errors templated-boolean

See ignore_errors

ignore_unreachable boolean | string
listen string | string[]

Applies only to handlers. See listen

local_action string | object
loop string | array
loop_control
module_defaults
name string
no_log templated-boolean

Use for protecting sensitive data. See no_log

notify string | string[]
poll integer | string
port integer | string
register string
remote_user string
retries integer | string
run_once boolean | string
tags string | string[]
throttle integer | string
timeout integer | string
until boolean | string | boolean | string[]
vars object
when boolean | string | boolean | string[]
with_dict
with_fileglob
with_filetree
with_first_found
with_indexed_items
with_ini
with_inventory_hostnames
with_items full-jinja | array

See loops

with_lines
with_random_choice
with_sequence
with_subelements
with_together
tasks array | null
Examples:
  • "tasks/*.yml"
  • "handlers/*.yml"
templated-boolean boolean | string
templated-integer integer | string
templated-integer-or-percent integer | string | string
templated-object object | string
vars_prompt object
name string required
prompt string required
confirm boolean
default string
encrypt string
Values: "des_crypt" "bsdi_crypt" "bigcrypt" "crypt16" "md5_crypt" "bcrypt" "sha1_crypt" "sun_md5_crypt" "sha256_crypt" "sha512_crypt" "apr_md5_crypt" "phpass" "pbkdf2_digest" "cta_pbkdf2_sha1" "dlitz_pbkdf2_sha1" "scram" "bsd_nthash"
private boolean
Default: true
salt_size integer
Default: 8
unsafe boolean

See unsafe

Default: false