Integration with Ansible Tower / AWX

To manage / onboard Ansible Tower / AWX as the RBA tool, perform the following steps:

1. On the main menu bar, click Runbooks, and then click Manage Runbook Tool. The Manage Runbook Tool appears.
2. Click on Create & Map Runbook Tool to add a new tool or click to edit an existing runbook automation tool.
3. Select data sources for which you need to create runbook tools in the data sourcefield.
4. Type the runbook tool name in the Runbook Tool Name field.
5. Select Ansible Tower / AWXAfrom the Runbook Tool Type drop-down.
6. Select REST API as the integration method for Ansible Tower/AWX for the Integration Method field.
7. Select the Authentication Type as BasicAuth.
8. Selection of BasicAuth requires the user to enter:
   • User Id
   • Password
9. Select template type.
10. Integration Section:
    1. Type the URL in the API URL field.

       Sample URL - https://<URL/IP>:<PORT>

    2. In Integration Method Type select ‘POST’.
    3. Type the return code key in the Return Code Key field to identify the success or failure of the runbook execution. e.g. status codes.
    4. Type the return message key in the Return Message Key field to display the success or failure of runbook execution. E.g. iautomate_success.
11. Authentication Section:
    1. Type the username and password in the User ID and Password field to get access to API web services.
       Note:

       API URL, User ID, and Password are dependent on the selected integration method
12. Base Section:
    1. Specify the path to get the consolidated scripts for the execution of runbooks in the Master Runbook Path field. This will be provided by respective Runbook Tool teams if they have a master runbook.
       Note:

       This is not a mandatory field. Users can change and run these scripts any time.
    2. Select Proxy Required, if the environment needs access to content from servers outside a firewall.
    3. Type the value in the Toil Value (For Manual Execution) field which implies the manual execution time of runbook under this tool (in minutes).
    4. Type the value in the Toil Value (For Auto Execution) field which implies the auto execution time of runbook under this tool (in minutes), if available else it’s a non-mandatory field.
    5. Enter the value in Connection Retry Count* field which shows the retry count in case the connection with RBA tool fails.
13. Playbook Generation Section:
    1. Type the value in the Job Type field which refers to the specific kind of task or operation that a job template is configured to execute.
    2. Type the value in the ServerIP field which is the IP where a new role is created.
    3. Type the value in the Server User and Server User Password field.
    4. Type the value in Path where the playbook needs to be copied.
14. Repo Section (playbook Generation)
    1. SCM URL: SCM URL defines the Source code management URL where will push playbook code.
    2. Git Repository Location: Where we will create a role for playbook code.
    3. Repository Username: It defines the Repository User Name which is required to connect with Git Repository Location.
    4. Repository Password: It defines the Repository User Password which requires to connect with Git Repository Location
    5. User email: To identify who is pushing the changes.
    6. Username: To identify who is pushing the changes.
    7. Branch Name: Defines where we will push playbook code.
    8. Commit Message is required to push any changes to the repository.

       

15. Click Submit / Update for adding a new tool or making changes to an existing tool. An appropriate success message will be displayed.