Configuring the Ansible adapter
You configure an adapter in TrueSight Orchestration Grid Manager. The configuration provides information about how the adapter interacts with the Ansible application.
Although each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.
You configure an adapter using a form view or an XML view. You can switch to the XML view to configure elements and attributes that are not available as fields on the form view. After you switch to the XML view and save the adapter configuration, you cannot use the form view for editing it later.
To configure the actor adapter
- On Grid Manager, go to Manage > Adapters.
- From the Adapters in Repository list, select the ro-adapter-ansible adapter, and click Add to Grid to add it in the Adapters on Grid list.
- Click Configure.
- Enter a unique name and an optional description.
The default name of the adapter is AnsibleAdapter.
The following table describes the configuration elements for the actor adapter.
UI label | XML element | Description | Required |
|---|---|---|---|
Target | <target> | Specifies the host name for the Ansible control node. | No |
Port | <port> | Specifies the SSH port on which the Ansible control node host listens. Default port is 22. | No |
User Name | <user-name> | Specifies the username required to log on to the Ansible control node. | No |
Password | <password> | Specifies the password. | No |
Private Key File | <private-key-file> | Specifies the the path and file name of the local SSH key file. The key file must be on the peer which runs the adapter request. This element is used if the <password> element is not provided. If both are provided, the adapter ignores the <password> element and considers <private-key-file> during the adapter request. | Conditional; required if <password> is not specified. |
Pass Phrase | <pass-phrase> | Specifies the passphrase that is used to protect the private key file. | No |
Private Key Data | <private-key-data> | Specifies the private key data of the local SSH key file. This element is used if the <password> element is not provided. If both are provided, the adapter ignores the <password> element and considers the <private-key-data> element during the adapter request. | Conditional; required if <password> is not specified. |
Timeout Secs | <timeout-secs> | Specifies the time, in seconds, before the connection request expires. Default value: 60 | No |
Known Host Config | <known-host-config> | Identifies the path to the local known_hosts file. This file is used to perform the key verification. | No |
Allow Unknown Hosts | <allow-unknown-hosts> | Specifies whether a connection should continue if the key verification fails. Valid values: true, false. | No |
Character Set | <character-set> | Specifies the supporting CharSet. Default value: UTF-8 | No |
The following figures describe the XML sample for the actor adapter configuration:
XML sample for configuring the Ansible adapter with <password> as an authentication method
<target>hostname</target>
<user-name>root</user-name>
<password>password</password>
<allow-unknown-hosts>true</allow-unknown-hosts>
<timeout-secs>60</timeout-secs>
<character-set>UTF-8</character-set>
</config>
The following figures describe the XML sample for the actor adapter configuration:
XML sample for configuring the Ansible adapter with <private-key-file> as an authentication method
<target></target>
<port></port>
<user-name></user-name>
<private-key-file></private-key-file>
<pass-phrase encryption-type=""></pass-phrase>
<timeout-secs></timeout-secs>
<known-hosts-config></known-hosts-config>
<allow-unknown-hosts></allow-unknown-hosts>
</config>