Integration with BMCAO

To manage / onboard BMCAO 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 Add New 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 tool in the data source field.
  4. Type the runbook tool name in the Runbook Tool Name field.
  5. Select BMCAO from the Runbook Tool Type drop-down
  6. Select REST as the integration method for BMCAO for the Integration Method field.
    Figure 1. Manage Runbook Tool (Cont.)
    A screenshot of a computer AI-generated content may be incorrect.
  7. Select one of the Authentication Type from BasicAuth, OAuth 2.0, API Key
    1. Selection of from BasicAuth requires you to enter:
      • User Id
      • Password
    2. Selection of API Key requires you to provide details in Authentication Parameters:
      Figure 2. Manage Runbook Tool (Cont.)
      A white rectangular object with a white border AI-generated content may be incorrect.
    3. Selection of API Key requires you to provide details in Authentication Parameters:
    4. Selection of from OAuth 2.0 requires you to enter:
      • User Id
      • Password
      • Authentication URL
      • Client Secret
  8. Integration Section:
    1. Type the URL in the API URL. field.

      Sample URL – http://MyHost:MyPort

    2. Select ‘POST’ in the Integration Method Type field.
    3. Type the return code key in the Return Code Key field to identify the success or failure of 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
  9. Authentication Section:
    1. Click on Add Authentication Parameters if authentication type is OAuth2 or API Key and provide below details:
      Figure 3. Manage Runbook Tool (Cont.) (API Key)
      A screenshot of a computer AI-generated content may be incorrect.
      Figure 4. Manage Runbook Tool (Cont.) (OAuth2.0)
      A screenshot of a survey Description automatically generated
    2. For OAuth2.0, provide Authentication URL.
    3. 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
  10. 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 Toil Value (For Manual Execution) which implies the manual execution time of runbook under this tool (in minutes).
    4. 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.
    5. Enter the value in Connection Retry Count* field which shows the retry count in case the connection with RBA tool fails. A screenshot of a computer AI-generated content may be incorrect.
      Figure 5. Manage Runbook Tool (Cont.)
  11. Click Submit / Update for adding a new tool or making changes to an existing tool. An appropriate success message will be displayed.