vCommander Build

Download link

7.0.2 and higher

This package contains a vCommander plug-in workflow step for integrating with Ansible

It was designed specifically for use in the vCommander workflow extension scenario Running Ansible Playbooks.


Version 1.1:

  • Added "Use Credentials for sudo Password" option. Users who require a password prompt can run the script when this option is enabled. 

Version 1.0: Initial version.

Plug-in steps in this package

  • Run ansible-playbook

Run ansible-playbook

Purpose: Executes the ansible-playbook command to install a playbook on a target VM


Workflows supporting this plug-in step:

  • Command workflows

  • Completion workflows for a VM

  • Completion workflows for a change request

  • Completion workflows for a custom component

  • Completion workflows for a cloud template


  • Step Name: Input field for the name of the step

  • Step Execution: Drop-down that sets the step execution behavior. By default, steps execute automatically. However, you can set the step to execute only for specific conditions.

  • Timeout: Input field for timeout (in seconds)

  • OS Credentials: Input field for OS credentials required to execute the command on the target VM

  • User Credentials for sudo Password: Enable this checkbox to use the given OS credentials for the sudo privileges that are required when the playbook uses "become". Checking this box enables the --ask-become argument and vCommander will supply the credentials. Unchecked by default. 
  • Playbook URL: Input field for Playbook URL - HTTP(s), file S3 path for playbook (one of URL or YAML must be specified)

  • Playbook YAML: Text Area for Playbook YAML - Inline YAML playbook (one of URL or YAML must be specified)

  • Extra Variables: Text Area for Extra Variables - Set of additional variables as key=value (one per line) or YAML/JSON. If filename, prepend with @.


Plug-in workflow steps are supported with vCommander release 7.0.2 and higher. 

See Adding plug-in workflow steps in the vCommander documentation to learn how to install this package. 

Return codes

Generic return codes

  • 0 - Step completed successfully

Ansible return codes

  • 1 - Unable to download playbook

  • 2 - SSL connection errors

  • 3 - Unable to create playbook file

  • 4 - Unable install Ansible playbook

  • 5 - Validation error


To change the logging level, add the following named loggers to the Log4j configuration file located at: 

  • Run ansible-playbook 

    • Loggers:

      • <Logger level="DEBUG" name="wfplugins.ansible.runplaybook"/>


  • To use the plug-in workflow step, you must install the ansible-playbook command on the target VM. See Installing Ansible Playbooks on the Embotics Support Knowledge Base.

  • You must install Ansible playbooks as the root user.