Create Ansible plugin configurations

2 minute readExtensibilityDeveloper productivity

Plugin configurations are sets of parameters that can be applied across some, or all, plugin procedures. They can reduce the repetition of common values, create predefined parameter sets, and securely store credentials. Each configuration is given a unique name that is entered in the designated parameter for the plugin procedures that use them. The following steps illustrate how to create a plugin configuration that can be used by one or more plugin procedures.

To create a plugin configuration:

  1. Navigate to DevOps Essentials  Plugin Management  Plugin configurations.

  2. Select Add plugin configuration to create a new configuration.

  3. In the New Configuration window, specify a Name for the configuration.

  4. Select the Project that the configuration belongs to.

  5. Optionally, add a Description for the configuration.

  6. Select the appropriate Plugin for the configuration.

  7. Configure the plugin configuration parameters.

  8. Select OK.

Depending on your plugin configuration and how you run procedures, the Input parameters  Configuration name field may behave differently in the CloudBees CD/RO UI. For more information, refer to Differences in plugin UI behavior.

Ansible plugin configuration parameters

Table 1. EC-Ansible plugin configuration parameters
Parameter Description


Required. The unique name for the configuration.


The configuration description.

Ansible playbook path

Required. An absolute or relative path to an Ansible playbook executable.

Ansible path

Required. An absolute or relative path to an Ansible executable.

Disable host key check?

If selected, Ansible skips the host key check.

Vault credentials

Credentials for vault.

Remote connection type

Required. Type of authentication to use for the remote connection. Select Skip explicit auth if you do not require any explicit authorization. For example, for local connections or when authentication is already configured on the control machine.

Remote connection credentials

Credentials to connect.

Remote connection credentials

Credentials to connect.

Become credentials

Ansible become credentials.

Check connection resource

A resource that is used for the checking connection.

Debug level

This option sets the debug level for logs. If Info is selected, only a summary is displayed. If Debug is selected, debug information is displayed. If Trace is selected, all requests and responses are displayed.

Create a plugin configuration for Windows hosts

Windows Remote Management (WinRM) must be installed on your Windows host before configuration. For more information, refer to the Windows Remote Management documentation.

Windows configurations do not support become credentials.

Example Windows configuration: