Keywords

Volant loads a playbook against the whole ansible-core 2.19 grammar, so it parses here as it parses under Ansible. What this release does not support yet is named before the run starts, never accepted and then ignored. Each keyword has a status for each place it can be written.

• runsVolant honors it, or names the one value it does not support yet.
• partialAccepted and honored, but not everything Ansible does with it. The gap is listed below the grid.
• not yetNot supported yet. The playbook loads, and the run stops before anything connects. In a file a dynamic include names, the statement fails when a host reaches it instead.
• not acceptedCannot be written there. Ansible rejects it too, when it reads the playbook.

A keyword inside a file that only a dynamic include_tasks or include_role names is checked when a host reaches that statement: if it is not supported yet, the statement fails for that host, a rescue around it can catch the failure, and nothing in the file runs. See Includes and imports.

This page is generated from the tables the loader and the pre-flight read, so it always describes the release it ships with.

All keywords

Keyword	Play	Block	Task
action	not accepted	not accepted	not yet
always	not accepted	runs	not accepted
any_errors_fatal	not yet	not yet	not yet
args	not accepted	not accepted	runs
async	not accepted	not accepted	not yet
become	runs	runs	runs
become_exe	not yet	not yet	not yet
become_flags	not yet	not yet	not yet
become_method	runs	runs	runs
become_user	runs	runs	runs
block	not accepted	runs	not accepted
changed_when	not accepted	not accepted	runs
check_mode	partial	partial	partial
collections	not yet	not yet	not yet
connection	not yet	not yet	not yet
debugger	not yet	not yet	not yet
delay	not accepted	not accepted	runs
delegate_facts	not accepted	runs	runs
delegate_to	not accepted	runs	runs
diff	not yet	not yet	not yet
environment	runs	runs	runs
fact_path	not yet	not accepted	not accepted
failed_when	not accepted	not accepted	runs
force_handlers	runs	not accepted	not accepted
gather_facts	runs	not accepted	not accepted
gather_subset	not yet	not accepted	not accepted
gather_timeout	not yet	not accepted	not accepted
handlers	runs	not accepted	not accepted
hosts	runs	not accepted	not accepted
ignore_errors	not yet	runs	runs
ignore_unreachable	not yet	not yet	not yet
local_action	not accepted	not accepted	not yet
loop	not accepted	not accepted	runs
loop_control	not accepted	not accepted	runs
max_fail_percentage	not yet	not accepted	not accepted
module_defaults	not yet	not yet	not yet
name	runs	runs	runs
no_log	runs	runs	runs
notify	not accepted	runs	runs
order	not yet	not accepted	not accepted
poll	not accepted	not accepted	not yet
port	not yet	not yet	not yet
post_tasks	runs	not accepted	not accepted
pre_tasks	runs	not accepted	not accepted
register	not accepted	not accepted	runs
remote_user	not yet	not yet	not yet
rescue	not accepted	runs	not accepted
retries	not accepted	not accepted	runs
roles	runs	not accepted	not accepted
run_once	runs	runs	runs
serial	runs	not accepted	not accepted
strategy	runs	not accepted	not accepted
tags	runs	runs	runs
tasks	runs	not accepted	not accepted
throttle	not yet	not yet	not yet
timeout	not yet	runs	runs
until	not accepted	not accepted	runs
vars	runs	runs	runs
vars_files	runs	not accepted	not accepted
vars_prompt	not yet	not accepted	not accepted
when	not accepted	runs	runs
with_config	not accepted	not accepted	not yet
with_csvfile	not accepted	not accepted	not yet
with_dict	not accepted	not accepted	not yet
with_env	not accepted	not accepted	not yet
with_file	not accepted	not accepted	not yet
with_fileglob	not accepted	not accepted	runs
with_first_found	not accepted	not accepted	runs
with_indexed_items	not accepted	not accepted	not yet
with_ini	not accepted	not accepted	not yet
with_inventory_hostnames	not accepted	not accepted	not yet
with_items	not accepted	not accepted	runs
with_lines	not accepted	not accepted	not yet
with_list	not accepted	not accepted	not yet
with_nested	not accepted	not accepted	not yet
with_password	not accepted	not accepted	not yet
with_pipe	not accepted	not accepted	not yet
with_random_choice	not accepted	not accepted	not yet
with_sequence	not accepted	not accepted	not yet
with_subelements	not accepted	not accepted	not yet
with_template	not accepted	not accepted	not yet
with_together	not accepted	not accepted	not yet
with_unvault	not accepted	not accepted	not yet
with_url	not accepted	not accepted	not yet
with_varnames	not accepted	not accepted	not yet
with_vars	not accepted	not accepted	not yet

What partial leaves out

Each keyword below behaves the same way in every place the grid marks it partial.

Keyword	What is missing
check_mode	only false is accepted, and the task runs for real. true is not supported yet because this release has no check mode: the run stops before the first connection when the playbook writes it, and at the include statement when a dynamic include brings it in

Handlers

A handler accepts every task keyword above, plus one of its own.

Keyword	Status
listen	runs

Under loop_control

A sub-key ansible-core does not know is rejected when the playbook loads.

Sub-key	Status
break_when	not yet
extended	not yet
extended_allitems	not yet
index_var	not yet
label	runs
loop_var	runs
pause	not yet