Add Runbook Tool

Users can add a runbook tool in an environment by performing the following steps:
  1. On the Manage Runbook Tool screen, click +.
    Figure 1. Manage Runbook Tool
  2. Fill in the following details to create a runbook tool. You must provide values for all the mandatory parameters.
    1. Organization: Select the organization name for which the runbook tool is to be created.
    2. Data Source: Select the data source for which the runbook tool will be mapped.
    3. Runbook Tool Name: Type the runbook tool name.
    4. Runbook Tool Type: Select the type of runbook tool from the drop-down.
    5. Template Type: Select the template type for ANSIBLE TOWER/AWX tool.
    6. Integration Method: Select the integration method to integrate the runbook tool with iAutomate.
    Figure 2. Add Details
Selecting the integration method populates the data based on the selected runbook tool type and displays the following fields:
Figure 3. Manage Runbook Tool (Cont.)

Secondary information is auto filled based on the selected integration methods.

Configure Runbook Tool

This section describes how to configure the runbook tool using the SOAP API in case of CA ITPAM integration method or REST API in case of vRO, Microfocus Operations Orchestrator, BigFix, BMCAO, ANSBILE TOWER/AWX, SNOW, StackStorm, ANSIBLE Inside, Jenkins, ADO, BigFix SA, and Microsoft System Orchestrator integration method.

To configure the runbook tool using the selected integration method,

  1. Select the Authentication Type to authenticate the Runbook Tool.
  2. Type the API URL as shown- http<s>://sourceinstanceName.com in the API URL field where sourceinstanceName is the URL of the corresponding RBA Tool.
  3. Select the integration method type from the Integration Method Type field.
  4. Type the username and password in the User ID and Password field to get access to API web services.
  5. For password, click on Add Password button. If the password is available in plaintext, then select Input type as Input Text and enter the password in Value field. Else if it is available in Azure Key Vault then select Input Type as Azure Key Vault and then select any of the configured details from the value field. Else if it is available in any Key Vault such as CyberArk or Secret Manager then select Input Type as CyberArk or Secret Manager respectively and then select any of the configured details from the value field.
    Figure 4. Password in Plain Text
    Figure 5. Password from Key Vault (CyberArk)
    Figure 6. Password from Key Vault (Secret manager)
    Figure 7. Password from Azure Key Vault
    A screenshot of a computer Description automatically generated
    Note:
    API URL, User ID, and Password are dependent on the selected integration method
  6. 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 later.
  7. Select Proxy Required if the environment needs access to content from servers outside a firewall. On selecting a proxy, the system uses the proxy connection, as specified in the Manage Proxy section.
  8. Type the return code key in the Return Code Key field to identify the success or failure of runbook execution.
  9. Type the return message key in the Return Message Key field to display the success or failure of runbook execution.
  10. Enter the Toil Value (For Manual Execution) which is the maximum manual execution time of runbook (in minutes). By default, it takes the value of the configured Toil value (For Manual Execution) on the iAutomate Configuration page.
  11. Enter the Toil Value (For Auto Execution) which is the maximum auto execution time of runbook (in minutes). By default, it takes the value of the configured Toil value (For Auto Execution) on the iAutomate Configuration page
  12. Enter the Connection Retry Count which is the number of retry counts in case the connection with RBA tool is failed when the ticket is triggered by iAutomate.
    Note:
    All fields marked with an asterisk (*) are mandatory.
  13. Click Submit to add the runbook tool
    Figure 8. Configure Runbook Tool
  14. A confirmation dialog box appears.
    Figure 9. Runbook Tool Created
  15. The new runbook tool is created and listed in a tabular view.
    Note:
    If a connection to the iAutomate configuration database cannot be established, an error message appears explaining what must be done to resolve the issue.

Edit Runbook Tool

User can open an existing runbook tool, review the available information, and edit the runbook tool details by performing the following steps:
  1. On the Manage Runbook Tool screen, click corresponding to the runbook tool that you want to edit.
    Figure 10. Edit Runbook Tool
  2. This displays the complete details of the runbook tool including the runbook tool name and type, integration method and type, API URL and its log on credentials, master runbook path, return code key, and the return message key.
    Figure 11. Edit Runbook Tool (Cont.)
  3. Edit the selected Runbook tool details and click Update to commit the changes. Click Cancel to discard changes.
  4. A confirmation dialog box appears.
    Figure 12. Runbook Tool Edited
    Note:
    All fields marked with an asterisk (*) are mandatory.

Delete Runbook Tool

If a user no longer wants a specific runbook tool, he/she can delete it from the environment by performing the following steps:
  1. On the Manage Runbook Tool screen, click on corresponding to the Runbook tool that you want to delete.
    Figure 13. Delete Runbook Tool
  2. Click OK to confirm.
    Figure 14. Delete Runbook Tool (Cont.)
    Note:
    You cannot delete a Runbook tool which is mapped to an active organization and data source.