Zum Inhalt springen
Installieren

Keywords

Every play, block and task keyword ansible-core 2.19 knows, and what Volant does with each one.

Dieser Inhalt ist noch nicht in deiner Sprache verfügbar.

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.
  • 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.

A keyword that takes a boolean or a number may be written as a template: become, no_log, run_once, any_errors_fatal, ignore_unreachable, delegate_facts, timeout, async and poll. It is rendered for each host when its task runs, once the task’s when has held, and a value the keyword cannot take fails the task with the reference’s sentence. gather_facts, force_handlers, strategy and order of a play are rendered when the play starts, with the play’s variables and the extra vars. A literal that is not a boolean is refused when the playbook loads. A timeout that is negative or not a number fails its task when it runs, as in Ansible, even when written as a literal.

This page is generated from the tables the loader and the pre-flight read, so it always describes the release it ships with. A status says what Volant does with the keyword, not that every value works: the known gaps list the values that fail.

KeywordPlayBlockTask
actionnot acceptednot acceptedruns
alwaysnot acceptedrunsnot accepted
any_errors_fatalrunsrunsruns
argsnot acceptednot acceptedruns
asyncnot acceptednot acceptedruns
becomerunsrunsruns
become_exerunsrunsruns
become_flagsrunsrunsruns
become_methodrunsrunsruns
become_userrunsrunsruns
blocknot acceptedrunsnot accepted
changed_whennot acceptednot acceptedruns
check_moderunsrunsruns
collectionsrunsrunsruns
connectionrunsrunsruns
debuggerrunsrunsruns
delaynot acceptednot acceptedruns
delegate_factsnot acceptedrunsruns
delegate_tonot acceptedrunsruns
diffrunsrunsruns
environmentrunsrunsruns
fact_pathrunsnot acceptednot accepted
failed_whennot acceptednot acceptedruns
force_handlersrunsnot acceptednot accepted
gather_factsrunsnot acceptednot accepted
gather_subsetrunsnot acceptednot accepted
gather_timeoutrunsnot acceptednot accepted
handlersrunsnot acceptednot accepted
hostsrunsnot acceptednot accepted
ignore_errorsrunsrunsruns
ignore_unreachablerunsrunsruns
local_actionnot acceptednot acceptedruns
loopnot acceptednot acceptedruns
loop_controlnot acceptednot acceptedruns
max_fail_percentagerunsnot acceptednot accepted
module_defaultsrunsrunsruns
namerunsrunsruns
no_logrunsrunsruns
notifynot acceptedrunsruns
orderrunsnot acceptednot accepted
pollnot acceptednot acceptedruns
portrunsrunsruns
post_tasksrunsnot acceptednot accepted
pre_tasksrunsnot acceptednot accepted
registernot acceptednot acceptedruns
remote_userrunsrunsruns
rescuenot acceptedrunsnot accepted
retriesnot acceptednot acceptedruns
rolesrunsnot acceptednot accepted
run_oncerunsrunsruns
serialrunsnot acceptednot accepted
strategyrunsnot acceptednot accepted
tagsrunsrunsruns
tasksrunsnot acceptednot accepted
throttlerunsrunsruns
timeoutrunsrunsruns
untilnot acceptednot acceptedruns
varsrunsrunsruns
vars_filesrunsnot acceptednot accepted
vars_promptrunsnot acceptednot accepted
whennot acceptedrunsruns
with_confignot acceptednot acceptedruns
with_csvfilenot acceptednot acceptedruns
with_dictnot acceptednot acceptedruns
with_envnot acceptednot acceptedruns
with_filenot acceptednot acceptedruns
with_fileglobnot acceptednot acceptedruns
with_first_foundnot acceptednot acceptedruns
with_indexed_itemsnot acceptednot acceptedruns
with_ininot acceptednot acceptedruns
with_inventory_hostnamesnot acceptednot acceptedruns
with_itemsnot acceptednot acceptedruns
with_linesnot acceptednot acceptedruns
with_listnot acceptednot acceptedruns
with_nestednot acceptednot acceptedruns
with_passwordnot acceptednot acceptedruns
with_pipenot acceptednot acceptedruns
with_random_choicenot acceptednot acceptedruns
with_sequencenot acceptednot acceptedruns
with_subelementsnot acceptednot acceptedruns
with_templatenot acceptednot acceptedruns
with_togethernot acceptednot acceptedruns
with_unvaultnot acceptednot acceptedruns
with_urlnot acceptednot acceptedruns
with_varnamesnot acceptednot acceptedruns
with_varsnot acceptednot acceptedruns
Keyword Limit
any_errors_fatal A template counts as true whatever it renders to, as ansible-core 2.19 reads it, and the task then fails on a value that is not a boolean
debugger p and a line that is not a command evaluate a subset of Python: names, literals, indexing, attributes, assignments and the calls the prompt needs. task_vars edited at the prompt reach a redo through u only
gather_facts A template is rendered once, when the play starts, with the play’s variables. The play still counts as one that may gather facts, so it needs ansible-core to be there
no_log A template is rendered for each host when its task runs. In a loop, one item that hides hides every item, where ansible-core hides each item by its own value
run_once A template is read for each host of the batch, and the first host it is true for runs the task. A template that is true for some hosts and false for others ends the run, where ansible-core also runs the hosts in front of the first. Under free and host_pinned a template is ignored without the warning a literal gets

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

Keyword Status
listen runs

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

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