Cloud.Ansible

Cloud.Ansible
Cloud.Ansible
JSON Example 
{
    "account": "string",
    "authentication": "string",
    "count": 0,
    "groups": [
        "string"
    ],
    "host": "string",
    "hostName": "string",
    "hostVariables": "string",
    "inventoryFile": "string",
    "maxConnectionRetries": 0,
    "osType": "string",
    "password": "string",
    "playbookRunUserPassword": "string",
    "playbookRunUsername": "string",
    "playbooks": {
        "de-provision": [
            "string"
        ],
        "provision": [
            "string"
        ]
    },
    "privateKey": "string",
    "privateKeyFile": "string",
    "username": "string"
}
string
account
Required

The name of the Ansible control machine as designated in the infrastructure integration.

string
authentication
Optional

Type of authentication used to connect to machine from Ansible.

Possible values are : usernamePassword, publicPrivateKey, generatedPublicPrivateKey,
integer
count
Optional

The number of resource instances to be created.

array of string
groups
Optional

The list of groups in the inventory file to which the compute resource should be added.

string As ^\$\{.+\.\*\}$
host
Required

The machine to be managed by Ansible. Enter the name using the format '${ .*}'.

string
hostName
Optional

Name of the host to be created in Ansible inventory. If this property is not specified, then host will be created using resource_name of machine.

string
hostVariables
Optional

Variables in YAML syntax that will be assigned to the host. They will be placed under inventory host_vars/*

string
inventoryFile
Optional

Absolute path to the Ansible inventory file

integer
maxConnectionRetries
Optional

Number of times to retry in case of connection failures

string
osType
Required

The node operating system. Valid options are Linux and Windows. The default is Linux.

Possible values are : linux, windows,
string
password
Optional

The password for the supplied user to connect to the node via SSH for Linux or WinRM for Windows nodes. This field is required when using username/password authentication.

string
playbookRunUserPassword
Optional

Password of the playbookRunUsername user. When specified, playbooks are run with this user's password. By default, user password configured in account is used.

string
playbookRunUsername
Optional

User with which to run playbooks. When specified, playbooks are run using this user. By default, the user configured in account is used.

object
playbooks
Optional

Specifies an Ansible playbook to use with the specified integration. An Ansible playbook is a collection of YAML scripts that define configuration management actions to execute on specified machines.

string
privateKey
Optional

The private key to use with the supplied user to connect to the node via SSH for linux nodes.

string
privateKeyFile
Optional

Absolute path to the private key on the ansible control machine to use with the supplied user to connect to the node via SSH for linux nodes.

string
username
Required

The name of the existing OS user who will connect to the node via SSH for Linux nodes and WinRM for Windows nodes.