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
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.
- On the Grid Manager, click the Manage tab and then click the Modules tab.
- 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
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.
- On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Configuration module.
- Expand the configuration tree until you can navigate to the configuration item that you want to modify.
Click the configuration item that you want to modify, edit the value, and click OK to save changes.
- 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.
Config item | Description | Update required? | Valid values |
---|---|---|---|
EventSourceType | Specifies the name of the event management tool from which the event is generated. | No | BMC_TrueSight |
ITSMType | Specifies the ITSM application to be used to create incidents, change, or tasks for an event. | No | BMC_AR_System |
Specifics > Adapters configuration items
Specifies the adapter names for the adapters configured and enabled on the TrueSight Orchestration grid.
Note
Ensure that the adapter name matches the name that you specify while configuring the adapter.
Config item | Description | Update required? |
---|---|---|
Adapter_Invocation_Mechanism_Mappings | Contains mappings to map adapter invocation mechanism (used by AD Utilities and Common Utilities workflows) to adapter names. This enables change in adapter names but no need to change workflow logic, in dependent modules like Credentials Store. | No |
CommandLineAdapter | Specifies the name of the command line adapter that is used to invoke shell commands on the local server. | Yes |
ITSMActorAdapter | Specifies the name of the BMC Remedy AR System actor adapter. The adapter is used to invoke actions in BMC Remedy AR System. | Yes |
ITSMWebServiceAdapter | Specifies the name of the web services adapter. The adapter is used to invoke SOAP based actions to Remedy AR System for creating and updating change requests. If any action is not supported by the Web Services adapter, the BMC Remedy AR System adapter is used. | Yes |
RESTAdapter | Specifies the name of the REST adapter used for invoking REST API requests to TrueSight Orchestration and TrueSight Presentation Server targets. | Yes |
SSHAdapter | Specifies the name of the SSH adapter used to invoke UNIX commands, such as accessing remote UNIX machines to perform remediation actions. | Yes |
WindowsCommandAdapter | Specifies the name of the Windows Command adapter used to invoke remote Windows commands from a Windows server. | Yes |
Specifics > BAO configuration items
Specifies the connection details to connect to the TrueSight Orchestration peer.
Config item | Description | Update required? | Default values |
---|---|---|---|
URL | Specifies the URL to the configuration distribution peer where the modules required for the use case are enabled. For example, specify the hostname and port of the CDP where you have activated the BMC-SA-Event_Orchestration_Service_Down module. Example: https://hostname:port/baocdp | Yes | - |
Username | Specifies the username required to log on to the CDP. | Yes | aoadmin |
Password | Specifies the password that matches the CDP. | Yes |
Specifics > BMC_AR_System configuration items
Contains the connection details and default values that get updated in the incident in BMC Remedy ITSM.
Config item | Description | Update required? | Default values |
---|---|---|---|
WebServiceConnectionData | Contains connection data used to invoke SOAP requests to AR Server via the mid-tier | ||
Change_CreateInterface | Specifies the ITSM form name used to create change and tasks in BMC Remedy ITSM. | No | CHG_ChangeServiceInterface |
Change_CreateSOAPAction | Specifies the SOAP action URI used to create in Change management management application | No | urn:CHG_ChangeServiceInterface/ Change_ProcessInterfaceData |
Change_GetSOAPAction | Specifies the ITSM form name used to retrieve change and task tickets information from Remedy ITSM | No | CHG_ChangeOutboundInterface |
Incident_CreateInterface | Specifies the ITSM form name used to create incident tickets in Remedy ITSM | No | HPD_IncidentServiceInterface |
Incident_UpdateInterface | Specifies the ITSM form name used to update incidents in Remedy ITSM | No | HPD_IncidentServiceInterface |
URL | Specifies the URL used to access AR Server's SOAP endpoint via the mid-tier application. Example: | Yes | |
Username | Specifies the username required to log on to the URL. | Yes | Orchestrator |
Password | Specifies the password that matches the username, in a secure format. | Yes | |
Change Management Defaults | Contains default values used while interacting with BMC Remedy ITSM's Change Management application | ||
ReportedSource | Specifies the value that appears in the Reported source field for a change request in BMC Remedy ITSM. | No | Other |
IncidentManagementDefaults | Contains default values used in the incidents created in BMC Remedy Incident Management | ||
AssignedGroup | Specifies the default value for the Assigned Group field when an incident is created. | Yes | Service Desk |
AssignedSupportCompany | Specifies the default value for the Contact Company field when an incident is created. | Yes | Calbro Services |
AssignedSupportOrganization | Specifies the default value for the Support Organization field when an incident is created. | Yes | IT Support |
Assignee | Specifies the default value for the Contact Company field when an incident is created. | Yes | Allen Allbrook |
DefaultImpact | Specifies the impact to be assigned when an incident is created. | No | 3-Moderate/Limited |
DefaultIncidentStatus | Specifies the status to be assigned when an incident is created. | No | Assigned |
DefaultServiceType | Specifies the service type to be assigned when an incident is created. | No | Infrastructure Event |
DefaultUrgency | Specifies the urgency to be assigned when an incident is created. | No | 3-Medium |
EventIncidentAssociationMaxPollCount | Specifies the default value for the Event Incident Association Max Poll Count field | No | 3 |
EventIncidentAssociationPollIntervalSecs | Specifies the default value for the Event Incident Association Poll Interval Secs field | No | 30 |
EventSourceIntegrationEnabled | Specifies the default value for the Event Source Integration Enabled field | No | true |
IncidentType | Specifies the type of incident to be created in BMC Remedy ITSM for an event. | No | Infrastructure Event |
ReportedSource | Specifies the reported source of the event when an incident is created. | No | Event Orchestration |
StatusReason | Specifies the status reason to be assigned when an incident is created. | No | Infrastructure Change |
WorkInfoLocked | Specifies the default value to be added to the workInfo source to be assigned when an incident is created. | No | No |
WorkInfoSource | Specifies the default value for the WorkInfoSource to be assigned when an incident is created. | No | BMC TrueSight Event |
WorkInfoType | Specifies the default value for the WorkInfoType to be assigned when an incident is created. | No | General Information |
WorkInfoViewAccess | Specifies the default value to be added to the WorkInfoViewAccess field of the incidents WorkInfo record when a WorkInfo is created. | No | Public |
Mappings | Contains enumerations defined in BMC Remedy ITSM server. If your environment requires customizations, you may update the values. | ||
ChangeTimings | No | ||
ImpactMappings | No | ||
StatusMappings | No | ||
StatusReasonMappings | No | ||
UrgencyMappings | No | ||
WorkInfoSecureLogMappings | No | ||
WorkInfoTypeMappings | No | ||
WorkInfoViewAccessMappings | No | ||
BMC_AR_System | |||
ITSMLocaleLanguage | Specifies the Locale Language of the Event Source Type | No | default |
ITSMLocaleCountry | Specifies the Locale Country of the Event Source Type. | No | default |
ITSMTimeZone | Specifies the timezone (standard Java timezones) where ITSM application is running. This field is used to determine the EPOCH time. EPOCH time is used queries to retrieve approved tasks by scheduled dates. For example, Asia/Kolkata or Europe/Paris. | No | Asia/Kolkata |
Specifics > BMC_TrueSight configuration items
Contains the connection details and mappings for TrueSight Presentation Server.
Config item | Description | Update required? | Default values |
---|---|---|---|
EventSourceDefaults> IncidentIntegrationEnabled | Specifies whether Business Service Resolution is implemented at the event source. Valid values: true (default), false If true, it is assumed that BMC Service Resolution integration is enabled at the event source, and TrueSight Infrastructure Management is creating incidents for events and TrueSight Orchestration does not create or update incidents. If false, BMC Service Resolution is not integrated. | Custom; specify false if not using BMC Service Resolution to create incidents | true |
EventTypes | Contains configuration information related to all supported event types (Only Host Down and Service Down supported out-of-the-box) | ||
HostDown > Configurations | Contains the configuration for the Host Down use case. An event type can support more than one configuration based on the type of actions. Each configuration has the following parameters:
| Custom; required if customizing for your requirements | |
HostDown > ModuleName | Specifies the module name that contains the workflow processes for the Host Down event. | No | :BMC-SA-Event_Orchestration_Host_Down |
ServiceDown > Configurations | Contains the configurations for the out-of-the-box service down use case. Each configuration has the following parameters:
| Custom; required if customizing for your requirements | |
ServiceDown > ModuleName | Specifies the module name that contains the workflow processes for the Service Down event. | Custom; required if customizing for your requirements | :BMC-SA-Event_Orchestration_Service_Down |
Mappings | Used to convert input event data into common event model | ||
EventMappings | Contains the mappings used to convert the event data into a common event model. | No | |
WebServiceConnectionData | Contains the connections details to connect to TrueSight Presentation Server | ||
BASE_URL | Specifies the URL to the TrueSight Presentation Server or a load balancer server, if used. | Yes | https://TSPS-HOST:TSPS-PORT/tsws/10.0/api |
EVENT_URI | This will be appended to BASE_URL to create a related event in the TrueSight Presentation Server. Do not update the values in this field. | No | /CI/-1/event |
LOGIN_URI | This will be appended to BASE_URL to invoke login request with the TrueSight Presentation Server. Do not update the values in this field. | No | /authenticate/login |
Tenant | Specifies the realm in Remedy SSO used by the TrueSight Presentation Server. | Yes | * |
Username | Specifies the username in the TrueSight Presentation Server with super admin privileges and application administration roles. | Yes | |
Password | Specifies the password, in an encrypted format, to log on to TSPS. | Yes | - |
Specifics > Defaults configuration items
Config item | Description | Update required? | Default values |
---|---|---|---|
BypassEventNotes | Used to bypass updating event source update. | No | false |
NotfoundWorkflowName | Specifies the default value returned by the logic when required workflow is not found | No | NOT_FOUND |
RunSchedules | Used to turn of polling for task tickets. Used for debug purposes only. | No | true |
SupportedActionsDelimiter | Used to form action ID string used by TrueSight Presentation Server | No | - |
RESTRequestTimeout | Default timeout, in seconds, for REST adapter connection timeout and socket connection timeout. | Custom; update if the request takes longer to complete | 900 |
Specifics > Workflow Definitions configuration items
Config item | Description | Update required? | Default values |
---|---|---|---|
CommonWorkflows | Contains the names of the workflows invoked when using the REST API requests | No |
|
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.
- On the Grid Manager, click Manage > Modules and click the AutoPilot-OA-Credentials_Store module.
- Expand the configuration tree until you can navigate to the configuration item that you want to modify.
Click the configuration item that you want to modify, edit the value, and click OK to save changes.
- 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.
Configuration item | Description | Update required? |
---|---|---|
Event Orchestration > Credentials | Stores the credentials for the operating systems.
| Yes |
ComponentType ToOSMappings | Contains the mappings for target host systems to operating systems for the out-of-box service down and host down use cases in an XML format.
| Conditional; required if adding a custom use case |
Event Orchestration > InfrastructureMappings | Contains the mappings between targets and credentials in an XML format. In addition, the mappings contain the settings for adapter invocation mechanism and the options to be passed to the adapter request and the command options. You can update the Infrastructure Mappings based on your requirement. Infrastructure Mappings include information for the following elements:
| Yes |
Configure BMC-SA-Event_Orchestration_Service_Down module
- On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Service_Down module.
- Expand the configuration tree until you can navigate to the configuration item that you want to modify.
Click the configuration item that you want to modify, edit the value, and click OK to save changes.
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.
Configuration item | Description | Values |
---|---|---|
Service_Actions_Aliasing > Aliases | Contains the following elements:
The attribute |
|
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.
- On the Grid Manager, click Manage > Modules and click the BMC-SA-Event_Orchestration_Host_Down module.
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>
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.
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.
Comments
Log in or register to comment.