Configuring modules in the Event Orchestration runbook

If you choose not to configure the modules during installation, you must activate them on the Grid Manager after the installation is complete. The adapters, modules, and the workflows installed with the runbook constitute the runbook framework and logic. 

• • Activate modules
  • Configure BMC-SA-Event_Orchestration_Configuration module
  • Configure AutoPilot-OA-Credentials_Store module
  • Configure BMC-SA-Event_Orchestration_Service_Down module
  • Configure BMC-SA-Event_Orchestration_Host_Down module
  • Where to go from here

Activate modules

Activating a module deploys it to the grid and triggers the schedules established for the processes contained in that module. Peers begin executing workflows according to the schedules defined in the activated modules. When you activate modules, you specify the version and revision of the module to be activated. Only one version and revision of a module can be active at a time.

1. On the Grid Manager, click the Manage tab and then click the Modules tab.

2. From the Modules in Repository list, select the following modules required for the out-of-the-box use cases and click Activate. 

   • AMP-AD-BMC-Remedy-ARS
   • AutoPilot-AD-Utilities
   • AutoPilot-OA-Applications_Utilities
   • AutoPilot-OA-BAOGridManagement
   • AutoPilot-OA-Common_Utilities
   • AutoPilot-OA-Credentials_Store
   • AutoPilot-OA-Errors
   • AutoPilot-OA-Event_Orchestration
   • AutoPilot-OA-File_Utilities
   • AutoPilot-OA-ITSM_Automation
   • AutoPilot-OA-Network_Utilities
   • BMC-SA-Event_Orchestration
   • BMC-SA-Event_Orchestration_Configuration
   • BMC-SA-Event_Orchestration_Host_Down
   • BMC-SA-Event_Orchestration_Service_Down

   These modules are activated on the grid. 

Configure BMC-SA-Event_Orchestration_Configuration module

The BMC-SA-Event_Orchestration_Configuration module contains data for the event management tool and ITSM system. For the out-of-the-box event types, you must configure the connection details for the endpoint systems.

1. On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Configuration module.
2. Expand the configuration tree until you can navigate to the configuration item that you want to modify.
3. Click the configuration item that you want to modify, edit the value, and click OK to save changes.
4. After successfully configuring the module, click the Modules tab and from the Modules in Repository list, select the module and click Activate. Module with the updated changes is successfully activated on the grid. 

Use this section to understand the module configuration items and the configuration items that you must update to use the runbook. Refer to the Update required column to understand whether to update the values. 

General configuration items

Contains configuration items for specifying the event source and the ITSM system. 

Specifics > Adapters configuration items

Specifies the adapter names for the adapters configured and enabled on the TrueSight Orchestration grid. 

Specifics > BAO configuration items

Specifies the connection details to connect to the TrueSight Orchestration peer. 

Specifics > BMC_AR_System configuration items

Contains the connection details and default values that get updated in the incident in BMC Remedy ITSM. 

Specifics > BMC_TrueSight configuration items

Contains the connection details and mappings for TrueSight Presentation Server. 

Specifics > Defaults configuration items

Specifics > Workflow Definitions configuration items

_{Back to top}

Configure AutoPilot-OA-Credentials_Store module

The Credentials Store module contains encrypted passwords for all target servers. Credentials for TrueSight Orchestration, TrueSight Presentation Server, and BMC Remedy IT Service Management are stored in the BMC-SA-Event_Orchestration_Configuration module. Assuming that in an organization, each component type (OS type) can have its own set of credentials, definitions for storing UNIX and Windows Credentials are provided in the module out-of-the-box.

1. On the Grid Manager, click Manage > Modules and click the AutoPilot-OA-Credentials_Store module.
2. Expand the configuration tree until you can navigate to the configuration item that you want to modify.
3. Click the configuration item that you want to modify, edit the value, and click OK to save changes.
4. After successfully configuring the module, click the Modules tab and from the Modules in Repository list, select the module and click Activate. Module with the updated changes is successfully activated on the grid. 

Use this section to understand the module configuration items and the configuration items that you must update to use the runbook. 

Back to top

Configure BMC-SA-Event_Orchestration_Service_Down module

1. On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Service_Down module.
2. Expand the configuration tree until you can navigate to the configuration item that you want to modify.
3. Click the configuration item that you want to modify, edit the value, and click OK to save changes.
4. After successfully configuring the module, click the Modules tab and from the Modules in Repository list, select the module and click Activate. Module with the updated changes is successfully activated on the grid. 

Use this table to understand the module configuration items and the configuration items that you must update to use the runbook. 

_{Back to top}

Configure BMC-SA-Event_Orchestration_Host_Down module

To perform ping tasks on remote ping hosts, access is required to login into the ping host machine. This information is obtained from AutoPilot-OA-Credentials_Store module. Host Down use case specific configuration is stored in the module BMC-SA-Event_Orchestration_Host_Down. The configuration provides information to the use case specific logic from which ping host the accessibility to the target machine is determined. The granularity of control is extended to specific ping host.

1. On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Host_Down module.

2. Expand the configuration tree and go to Configuration > HostDownConfig > PingMappings and update the values as per your requirement and click OK. 

   <ping-mappings>
    <!-- this mapping is used if specific domain related ping mapping is not defined. -->
    <ping-mapping name="*">
      <!-- FQDN of the router host -->
      <router-host component-type="unix">[ROUTER-HOST]</router-host>
      <!-- command to execute including any command line options -->
      <ping-command>ping</ping-command>
      <ping-hosts>
        <!-- list of hosts used to perform ping operation -->
        <ping-host component-type="unix">unix-host-1.adomain.com</ping-host>
        <ping-host component-type="windows">windows-host-1.adomain.com</ping-host>
      </ping-hosts>
    </ping-mapping>
   </ping-mappings>
3. After successfully configuring the module, click the Modules tab and from the Modules in Repository list, select the module and click Activate. Module with the updated changes is successfully activated on the grid. 

_{Back to top}

Where to go from here

Choose one of the following options:

• Orchestration actions – Restart Service and Check Host Connection are now available in TrueSight Presentation Server for the out-of-the box use cases, Service Down and Host Down respectively. For more information about using the Orchestration actions for your remediation solutions, see Using Orchestration actions to enable triage and remediation of events.

• If you want to start adding new Orchestration actions for custom use cases, see Adding a custom use case to enable Orchestration actions.