Integration with ANSIBLE Inside

To manage / onboard Ansible Inside 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 Add New to add a new tool or click to edit an existing runbook automation tool.
  3. Select Organization for which you need to create a runbook tool in the Organization Name field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select ANSIBLE Inside from the Runbook Tool Type drop-down.
  6. Select REST API as the integration method for ANSIBLE Inside for the Integration Method field.
    Figure 1. Manage Runbook Tool (Cont.)
  7. Select one of the Authentication Type from No Auth, Certificate Based Auth, or Token Auth.
    1. Selection of No Auth, Certificate Based Auth as Authentication Type will not require any user id or password.
    2. Selection of Token Auth as Authentication Type requires you to enter –
      • Authentication URL: URL of iAutomateAPI to generate token.
      Figure 2. Manage Runbook Tool (Cont.)
  8. Provide the API URL of the tool.
  9. Select ‘POST’ in the Integration Method Type field.
    Note:
    API URL is dependent on the selected integration method.
  10. 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.
  11. Select Proxy Required, if the environment needs access to content from servers outside a firewall.
  12. Type the return code key in the Return Code Key field to identify the success or failure of runbook execution. E.g. status_codes
  13. Type the return message key in the Return Message Key field to display the success or failure of runbook execution. E.g. iAutomate_success
  14. Type the Toil Value (For Manual Execution) which implies the manual execution time of runbook under this tool (in minutes).
  15. 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.
    Figure 3. Manage Runbook Tool (Cont.)
    A screenshot of a computer Description automatically generated
  16. Type the Python Execution Path which will remain constant as ‘python’.
  17. Type the SDK Python Script Location which is the Location of the core python script of Ansible-Inside that manages the execution of Ansible roles.
  18. Type the Master Playbook Location which is the Location that will host the master yaml within the Ansible-Inside setup.
  19. Type the Ansible Playbook Directory which is the Location that will host all the ansible roles to be executed within the Ansible -Inside setup.
  20. Type the Request Log Path which is the location where all log files will be created.
  21. Type the Vault Key which is used to securely access the tool.
    Figure 4. Manage Runbook Tool (Cont.)
    A screenshot of a computer Description automatically generated
  22. Click Submit / Update for adding a new tool or making changes to an existing tool. An appropriate success message will be displayed.
    Note:
    The fields SDK Python Script Location, Master Playbook Location, Ansible Playbook Directory and Vault Key are also given at runbook level for tool type ANSIBLE SDK. By default, for a runbook, these values will be populated from the corresponding tool, but if there’s any case that these values differ at runbook level then user can define them accordingly at runbook level.

To get the logs of the tickets executed for the tool Ansible Inside, log in with org admin and navigate to Reports Ansible Inside Logs page. Here all the tickets executed under Ansible Inside will be populated. Corresponding to each ticket, the user can download the component log and the console logs. For detailed information, refer to HCL iAutomate 6.4.5 Configuration Guide.