runAnsiblePlaybookScript

Creates a playbook YAML file from the playbook script input and runs this playbook.

Environment/Instance Properties

Property Name
Property Code
Required
Description





Project Properties

Property Name
Property Code
Required
Description




Inputs

Input NameInput CodeRequiredDescription
Ansible HomeFDANS_INP_ANSIBLE_HOMENoAbsolute directory path where Ansible is installed.
Playbook ScriptFDANS_INP_PLAYBOOK_SCRIPTYesPlaybook YAML script code.
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=val2

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_LIMITNoLimiting of the selected hosts to an additional pattern. Outputs a list of matching hosts. (CLI arg: -l)
Skip TagsFDANS_INP_SKIPPED_TAGSNoOnly run plays and tasks whose tags do not match these values. (CLI arg: --skip-tags)
Start at TaskFDANS_INP_START_AT_TASKNoStart the playbook at the task matching this name. (CLI arg: --start-at-task)
Run TagsFDANS_INP_TAGSNoOnly run plays and tasks tagged with these values. (CLI arg: -t)

Outputs

Output NameDescription


Artifacts

This operation delegates consumes/produces artifacts decision to the workflow developer. Check Consumes Artifacts on the workflow step editor if this operation requires artifacts to be delivered prior to execution of the script. Check Produces Artifacts on the workflow step editor if this operation creates artifacts. The artifacts folder is available via the FD_ARTIFACTS_DIR variable.

Endpoint Selection

This operation delegates endpoint selection to the workflow developer. The workflow editor will default the selection to "All", which selects all available endpoints associated to the environment instance. Selecting a specific resource will result in selection of endpoints associated to the environment instance which have that resource defined. Ansible must be installed on any endpoint that executes this plugin. The user can use the LOCALHOST endpoint if Ansible is installed on the FlexDeploy server.

Endpoint Execution

This operation delegates endpoint execution to the workflow developer. The workflow editor will default to "Any", which will execute on any one of the selected endpoints, which will be randomly picked from selected endpoints or a specific endpoint where previous step may have executed. Changing this value to "All" to will result in execution on all selected endpoints.

Example

Below you can see an example of inputs used on the runAnsiblePlaybookScript plugin operation.

Below is the Ansible playbook that is saved in /home/ubuntu/ansibleTest. This plugin verifies that Apache is up to date, starts the server if it is not running, and stops the server if it is running.

/home/ubuntu/ansibleTest/testPlaybook.yml
---
- hosts: dkrlp01
#  become: yes
  tasks:
          - name: verify latest version Apache
            apt:
                name: apache2
                update_cache: yes
                state: latest

          - name: ensure httpd is running
            service:
                name: apache2
                state: started
          - name: stop apache
            service:
                    name: apache2
                    state: stopped

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

The following macros are not currently supported in the footer:
  • style