Configuring AnsibleTower Instance

  1. Go to Menu > WORKFLOW > Integration.
  2. On the Integrations page, from the Select Category dropdown, select only DevOps and click Apply.
  3. Click the Add new vendor icon.
    The Select Vendor pop-up is displayed.
  4. Select AnsibleTower.
    The Vendor Configuration pop-up is displayed.
  5. In the Information section, enter the following values:
    Table 1. Field descriptions for Information section
    Field Description
    *Category polling Default value as DevOps
    *Vendor Default value as AnsibleTower
    *Name Enter a suitable name.
    Version Enter a appropriate version.
    Description Enter a description for the vendor.
    Upload image Provision to upload vendor image/logo.
    Tags Select/Enter the tag.
    Data center Select data center value.
  6. In the Credentials section, based on the Type as REST and SSH, enter the following values:
    If the Type = REST, the Auth Type has the following values in the dropdown - Basic Auth, Credentials, Bearer Token, OAuth 2.0. The table below has the corresponding field descriptions for each of the Auth Types.
    Table 2. If Type = REST, and Auth Type = Basic Auth or Credentials
    Fields Description
    *Credential Type Select credential type as Manual or Credential List - XXX.
    Note: The credentials must be added in the respective Device Inventory.
    *Username This field is displayed if Credential Type = ManualE

    Enter the username to authenticate and authorize communication with the vendor's system.
    *Password This field is displayed if Credential Type = Manual

    Enter the password to authenticate and authorize communication with the vendor's system.
    *Credential List This field is displayed if Credential Type = Credential List - XXX

    Select the configured device credentials.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 3. If Type = REST, and Auth Type = Bearer Token
    Fields Description
    *Token Enter the authentication token required for API requests.
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    Table 4. If Type = REST, and Auth Type = OAuth 2.0
    Fields Description
    *Username Used in Grant Type = Password , enter the username for authentication.

    This field is mandatory only if the Grant Type = Password.
    *Password Used in Grant Type = Password , enter the password for the username.

    This field is mandatory only if the Grant Type = Password.
    *Access Token URL Enter the provider's authentication server, to exchange an authorization code for an access token.
    *Client ID Enter the ID for the client application registered with the API provider.

    This field is mandatory only if the Grant Type = Client Credentials.
    Client Secret Enter the client secret given by the API provider.

    This field is mandatory only if the Grant Type = Client Credentials.
    Grant Type Select the OAuth 2.0 flow to be used:
    • Password (for user authentication with username and password).
    • Client Credentials (for machine-to-machine authentication).
    Scope Defines the level of access requested (e.g., read, write, admin).
    *URL Enter the valid URL/endpoint of the vendor’s API.

    To validate the URL Click Validate URL.
    *: Mandatory fields
    If the Type = SSH, the Auth Type has the following values in the dropdown - Credentials, SSH Key, No Auth. The table below has the corresponding field descriptions for each of the Auth Types.
    Table 5. If Type = SSH, and Auth Type = Credentials
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP or FQDN/Host name Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *Port Enter the SSH port on the vendor’s server.
    *Username Enter the login username used to authenticate the SSH session.
    *Password Enter the password for the corresponding username.
    *: Mandatory fields
    Table 6. If Type = SSH, and Auth Type = SSH Key
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *SSH Key Enter the private SSH key used for authentication instead of a password.
    *: Mandatory fields
    Table 7. If Type = SSH, and Auth Type = No Auth
    Fields Description
    Communication type Select the communication type as IP or FQDN/Host name
    *IP Enter the IP address or the FQDN/Host name of the vendor’s server that AppViewX will connect to over SSH.
    *Port Enter the SSH port on the vendor’s server.
    *Username The username used for the SSH session, though no authentication (password or key) is required.
    *: Mandatory fields
    From the Auth type field, if you select Basic Auth and Credentials you can select the Credential Type from the dropdown and enter the relevant details to support credential authentication.
    • In the Credential Type field, if Manual is selected, the enter the Username and Password.
    • In the Credential Type field, if Credentail List - XYZ is selected, then in the Credential List field, a list of credentials from credential store will be displayed.
      • If the Credential Type = Credentail List - CyberArk, Credentail List - BeyondTrust an additional field Credential Address is displayed. It uniquely identifies the credential list.
        Note: The credentials must be added in the respective Device Inventory.
  7. Under Configurations, turn on the Enable config toggle and define relevant API parameters in the JSON configurator that is displayed.
  8. Click Add.
  9. On the Workflow > Integration page, click Jenkins.
  10. On the Vendor configuration page, enter the required field information.
    Note: Under Authentication type Basic Auth and Credentials you can select the credential type from the drodown and enter the relevent details to support credential authentication.
    From the Auth type field, if you select Basic Auth and Credentials you can select the Credential Type from the dropdown and enter the relevant details to support credential authentication.
    • In the Credential Type field, if Manual is selected, the enter the Username and Password.
    • In the Credential Type field, if Credentail List - XYZ is selected, then in the Credential List field, a list of credentials from credential store will be displayed.
      • If the Credential Type = Credentail List - CyberArk, Credentail List - BeyondTrust an additional field Credential Address is displayed. It uniquely identifies the credential list.
        Note: The credentials must be added in the respective Device Inventory.
  11. Click Save.
    Note: For more information on Jenkins - Visual Workflow Northbound integration, click here.