Integration with Ansible CLI

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

  1. On the left 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 an organization for which you need to create a runbook tools in the Organization field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select ANSIBLE CLI from the Runbook Tool Type drop-down.
  6. Select REST API as the integration method for Ansible CLI for the Integration Method field.
  7. Select one of the authentication types from No Auth, Token Auth, and Certificate Based Auth as Authentication Type.
  8. Selection of Token Auth as Authentication Type requires you to enter an Authentication URL(URL of iAutomate API to generate a token) along with Authentication Parameters.
  9. Selection of No Auth and Certificate Based Auth as Authentication Type will not require any user id or password to enter.
    Figure 1. Creat and Map Runbook Tool
  10. Type the URL in the API URL*. field.

    Sample URL - https://<ip>:<port>:

  11. Select the Integration Method Type* as POST.
  12. 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.
  13. Select Proxy Required, if the environment needs access to content from servers outside a firewall.
  14. Type the return code key in the Return Code Key field to identify the success or failure of runbook execution.
  15. Type the return message key in the Return Message Key field to display the success or failure of runbook execution.
  16. Type the Toil Value (For Manual Execution) which implies the manual execution time of runbook under this tool (in minutes).
  17. Type the Toil Value (For Auto Execution) which implies the auto execution time of runbook under this tool (in minutes), if available else it’s a non-mandatory field.
  18. Enter the value in Connection Retry Count* field which shows the retry count in case the connection with RBA tool fails.
  19. Enter the value in Master Playbook Location fieldwhich is the location of the master yaml file.
  20. Enter the value in Request Log Path fieldwhere all the log files will be stored.
  21. Enter the value of Vault Key which is used for encryption & decryption.
  22. Enter the value of Vault File Path which is the location of the vault file where secrets are stored.
    Figure 2. Manage Runbook Tool (Cont.)
  23. Click Submit / Update for adding a new tool or making changes to an existing tool. An appropriate success message will be displayed.