Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Runs an Ansible playbook YAML file. This operation takes a name or path of the specific playbook file as well as any desired arguments and runs the playbook. 

...

Input NameInput CodeRequiredDescription
Ansible HomeFDANS_INP_ANSIBLE_HOMENoAbsolute directory path where Ansible is installed.
Ansible PlaybookFDANS_INP_PLAYBOOKYes

Absolute or relative path to Ansible playbook YAML file. Relative path will be looked in temp and artifact directory.

Absolute Path Example: /home/ubuntu/ansibleTest/testPlaybook.yml

Relative Path Example: ansibleTest/testPlaybook.yml

Inventory FileFDANS_INP_INVENTORYNoAbsolute path to the inventory file to use with the playbook invocation. (CLI arg: -i)
Become MethodFDANS_INP_BECOME_METHODNo

Privilege escalation method to use. (CLI arg: --become-method)

valid choices: [ sudo | su | pbrun | pfexec | doas | dzdo | ksu | runas | machinectl ]

If privilege escalation method is selected -b CLI argument will be passed.

Become UserFDANS_INP_BECOME_USERNo

Run operations as. (CLI arg: --become-user)

If value is provided -b CLI argument will be passed.

Extra VariablesFDANS_INP_EXTRA_VARSNo

Additional variables as key=value, JSON text, or a JSON/YAML file. Formatted as key=value. If passing a JSON/YAML file you must use an @ before the file name. One pair per line (CLI arg: -e)

Key/Value Example: var1=val1 var2=val1"

JSON Example: {"version":"1.23.45","other_variable":"foo"}

JSON/YAML File Example: @some_file.json

Parallel ProcessesFDANS_INP_FORKSNoNumber of parallel processes to use. (CLI arg: -f)
Host LimitFDANS_INP_LIMITNo

Limiting of the selected hosts to an additional pattern. Outputs a list of matching hosts. If more than one the different tags must be separated by a comma.(CLI arg: -l)

Multiple Hosts Example: host1,host2

Skip TagsFDANS_INP_SKIPPED_TAGSNo

Only run plays and tasks whose tags do not match these values. If more than one the different tags must be separated by a comma. (CLI arg: --skip-tags)

Multiple Tags Example: configuration,packages

Start at TaskFDANS_INP_START_AT_TASKNoStart the playbook at the task matching this name. (CLI arg: --start-at-task)
Run TagsFDANS_INP_TAGSNo

Only run plays and tasks tagged with these values. If more than one the different tags must be separated by a comma. (CLI arg: -t)

Multiple Tags Example: configuration,packages

Outputs

Output NameDescription


...

Below is the hosts inventory file that is saved in /home/ubuntu/ansibleTest

...

/home/ubuntu/ansibleTest

...