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.

  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. 

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.

  Click here to expand...
<mappings>
   <adapter-name invocation-mechanism="rest">RESTAdapter</adapter-name>
   <adapter-name invocation-mechanism="itsm">ITSMActorAdapter</adapter-name>
   <adapter-name invocation-mechanism="windows-command">WindowsCommandAdapter</adapter-name>
   <adapter-name invocation-mechanism="ssh">SSHAdapter</adapter-name>
   <adapter-name invocation-mechanism="itsmwebservice">ITSMWebServiceAdapter</adapter-name>
   <adapter-name invocation-mechanism="command-line">CommandLineAdapter</adapter-name>
</mappings>
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
  ChangeTimings
<change-timings>
  <pre-approved>Emergency</pre-approved>
  <normal>Normal</normal>
</change-timings>
No
ImpactMappings
  ImpactMappings
<mappings />
No
StatusMappings
  StatusMappings
<status-mappings>
  <mapping name="New" type="string">0</mapping>
  <mapping name="Assigned" type="string">1</mapping>
  <mapping name="In Progress" type="string">2</mapping>
  <mapping name="Pending" type="string">3</mapping>
  <mapping name="Resolved" type="string">4</mapping>
  <mapping name="Closed" type="string">5</mapping>
  <mapping name="Cancelled" type="string">6</mapping>
</status-mappings>
No
StatusReasonMappings
  StatusReasonMappings
<status-reason-mappings>
  <mapping name="Infrastructure Change Created" type="string">1000</mapping>
  <mapping name="Local Site Action Required" type="string">2000</mapping>
  <mapping name="Purchase Order Approval" type="string">3000</mapping>
  <mapping name="Registration Approval" type="string">4000</mapping>
  <mapping name="Supplier Delivery" type="string">5000</mapping>
  <mapping name="Support Contact Hold" type="string">6000</mapping>
  <mapping name="Third Party Vendor Action Reqd" type="string">7000</mapping>
  <mapping name="Client Action Required" type="string">8000</mapping>
  <mapping name="Infrastructure Change" type="string">9000</mapping>
  <mapping name="Request" type="string">10000</mapping>
  <mapping name="Future Enhancement" type="string">11000</mapping>
  <mapping name="Pending Original Incident" type="string">12000</mapping>
  <mapping name="Client Hold" type="string">13000</mapping>
  <mapping name="Monitoring Incident" type="string">14000</mapping>
  <mapping name="Customer Follow-Up Required" type="string">15000</mapping>
  <mapping name="Temporary Corrective Action" type="string">16000</mapping>
  <mapping name="No Further Action Required" type="string">17000</mapping>
  <mapping name="Resolved by Original Incident" type="string">18000</mapping>
  <mapping name="Automated Resolution Reported" type="string">19000</mapping>
  <mapping name="No longer a Causal CI" type="string">20000</mapping>
  <mapping name="Pending Causal Incident Resolution" type="string">21000</mapping>
  <mapping name="Resolved by Causal Incident" type="string">22000</mapping>
</status-reason-mappings>
No
UrgencyMappings
  Urgency mappings
<mappings>
  <mapping key="Critical">1-Critical</mapping>
  <mapping key="High">2-High</mapping>
  <mapping key="Medium">3-Medium</mapping>
  <mapping key="Low">4-Low</mapping>
</mappings>
No
WorkInfoSecureLogMappings
  WorkInfoSecureLogMappings
<workinfo-securelog-mappings>
  <mapping name="Yes" type="string">0</mapping>
  <mapping name="No" type="string">1</mapping>
</workinfo-securelog-mappings>
No
WorkInfoTypeMappings
  WorkInfoTypeMappings
<workinfo-type-mappings>
  <mapping name="Customer Communication" type="string" version="default">2000</mapping>
  <mapping name="Customer Follow-up" type="string" version="default">3000</mapping>
  <mapping name="Customer Status Update" type="string" version="default">4000</mapping>
  <mapping name="Closure Follow Up" type="string" version="default">6000</mapping>
  <mapping name="Detail Clarification" type="string" version="default">7000</mapping>
  <mapping name="General Information" type="string" version="default">8000</mapping>
  <mapping name="Resolution Communications" type="string" version="default">9000</mapping>
  <mapping name="Satisfaction Survey" type="string" version="default">10000</mapping>
  <mapping name="Status Update" type="string" version="default">11000</mapping>
  <mapping name="Incident Task / Action" type="string" version="default">13000</mapping>
  <mapping name="Problem Script" type="string" version="default">14000</mapping>
  <mapping name="Working Log" type="string" version="default">15000</mapping>
  <mapping name="Email System" type="string" version="default">16000</mapping>
  <mapping name="Paging System" type="string" version="default">17000</mapping>
  <mapping name="BMC Impact Manager Update" type="string" version="default">18000</mapping>
  <mapping name="Chat" type="string" version="default">35000</mapping>
  <mapping name="Vendor Communication" type="string">37000</mapping>
</workinfo-type-mappings>
No
WorkInfoViewAccessMappings
  WorkInfoViewAccessMappings
<workinfo-viewaccess-mappings>
  <mapping name="Internal" type="string">0</mapping>
  <mapping name="Public" type="string">1</mapping>
</workinfo-viewaccess-mappings>
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:

  • <id>: Unique number for each configuration within a given event type. The ID value is concatenated with event source type (for example: BMC_TrueSight) and event type to form a unique action ID string. For example: BMC_TrueSight-HostDown-1
  • <action-name>: Specifies the action name. The action name is shown in the Launch Orchestration Actions menu in the TrueSight console.
    Default value: Check Host Connection
  • <incident-enabled>: Specifies whether to create an incident for the specified event type. By default, false.

    Note

    If true, the runbook verifies whether an incident is created for an event (by using BMC Service Resolution) and if not created, TrueSight Orchestration creates an incident for the event in BMC Remedy Incident Management system.

  • <change-enabled>: Specifies whether to create a change for the specified event type. By default, false.
  • <remediation-enabled>: Specifies whether to execute remediation action for this event type. By default, false.
  • <change-type/>: Change type determines if approval is required for task to be performed. Valid values: normal, emergency.
Custom; required if customizing for your requirements
  Host Down configurations
<configurations>
  <configuration>
    <id>1</id>
    <action-name>Check Host Connection</action-name>
    <incident-enabled>false</incident-enabled>
    <change-enabled>false</change-enabled>
    <change-template-name />
    <remediation-enabled>false</remediation-enabled>
    <change-type />
  </configuration>
</configurations>
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:

  • <id>: Unique number for each configuration within a given event type. The ID value is concatenated with event source type (for example: BMC_TrueSight) and event type to form a unique action ID string. For example: BMC_TrueSight-ServiceDown-1
  • <action-name>: Specifies the action name. The action name is shown in the Launch Orchestration Actions menu in the TrueSight console.
    Default value: Restart Service
  • <incident-enabled>: Specifies whether to create an incident for the specified event type. By default, false.

    Note

    If true, the runbook verifies whether an incident is created for an event (by using BMC Service Resolution) and if not created, TrueSight Orchestration creates an incident for the event in BMC Remedy Incident Management system.

  • <change-enabled>: Specifies whether to create a change for the specified event type. By default, false.
  • <remediation-enabled>: Specifies whether to execute remediation for this action. By default, false.

    Note

    If true, the BMC-SA-Event_Orchestration_Service_Down module must contain the Perform Triage, Perform Remediation, and Perform Validation workflows.

  • <change-type/>: Change type determines if approval is required for task to be performed. Valid values: normal, emergency.
Custom; required if customizing for your requirements
  ServiceDown configurations
<configuration>
    <id>1</id>
    <action-name>Restart Service</action-name>
    <incident-enabled>false</incident-enabled>
    <change-enabled>false</change-enabled>
    <change-template-name />
    <remediation-enabled>true</remediation-enabled>
    <change-type />
</configuration>
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.

  EventMappings
<mappings>
  <!-- metadata -->
  <mapping>
    <source>mc-event-model-version</source>
    <destination class="metaData">eventModelVersion</destination>
  </mapping>
  <mapping>
    <source>class-name</source>
    <destination class="metaData">eventClass</destination>
  </mapping>
  <mapping>
    <source>mc-ueid</source>
    <destination class="metaData">eventId</destination>
  </mapping>
  <mapping>
    <source>status</source>
    <destination class="metaData">status</destination>
  </mapping>
  <mapping>
    <source>mc-incident-report-time</source>
    <destination class="metaData">reportTime</destination>
  </mapping>
  <mapping>
    <source>mc-smc-impact</source>
    <destination class="metaData">eventToCIAssociationType</destination>
  </mapping>
  <mapping>
    <source>mc-timeout</source>
    <destination class="metaData">timeout</destination>
  </mapping>
  <mapping>
    <source>mc-notes</source>
    <destination class="metaData">notes</destination>
  </mapping>
  <mapping>
    <source>mc-history</source>
    <destination class="metaData">propagationHistory</destination>
  </mapping>
  <mapping>
    <source>mc-relation-source</source>
    <destination class="metaData">relationSource</destination>
  </mapping>
  <mapping>
    <source>mc-owner</source>
    <destination class="metaData">owner</destination>
  </mapping>
  <mapping>
    <source>mc-account</source>
    <destination class="metaData">account</destination>
  </mapping>
  <!-- source / reporter data -->
  <mapping>
    <source>mc-tool-id</source>
    <destination class="sourceData">resourceId</destination>
    <destination class="reporterData">resourceId</destination>
  </mapping>
  <mapping>
    <source>mc-smc-id</source>
    <destination class="sourceData">reconciliationId</destination>
  </mapping>
  <mapping>
    <source>mc-smc-alias</source>
    <destination class="sourceData">alias</destination>
  </mapping>
  <mapping>
    <source>mc-host</source>
    <destination class="sourceData">componentHost</destination>
  </mapping>
  <mapping>
    <source>mc-host-address</source>
    <destination class="sourceData">componentHostAddress</destination>
  </mapping>
  <mapping>
    <source>mc-location</source>
    <destination class="sourceData">location</destination>
  </mapping>
  <mapping>
    <source>mc-object-uri</source>
    <destination class="sourceData">componentURI</destination>
  </mapping>
  <mapping>
    <source>mc-object</source>
    <destination class="sourceData">componentCaption</destination>
  </mapping>
  <mapping>
    <source>mc-object-class</source>
    <destination class="sourceData">componentType</destination>
  </mapping>
  <mapping>
    <source>mc-object-owner</source>
    <destination class="sourceData">componentOwner</destination>
  </mapping>
  <!-- reporter data -->
  <mapping>
    <source>mc-tool-address</source>
    <destination class="reporterData">componentHostAddress</destination>
  </mapping>
  <mapping>
    <source>mc-tool-uri</source>
    <destination class="reporterData">componentURI</destination>
  </mapping>
  <mapping>
    <source>mc-tool</source>
    <destination class="reporterData">componentCaption</destination>
  </mapping>
  <mapping>
    <source>mc-tool-class</source>
    <destination class="reporterData">componentType</destination>
  </mapping>
  <mapping>
    <source>mc-tool-time</source>
    <destination class="reporterData">eventTime</destination>
  </mapping>
  <mapping>
    <source>mc-tool-rule</source>
    <destination class="reporterData">eventType</destination>
  </mapping>
  <mapping>
    <source>mc-tool-source</source>
    <destination class="reporterData">reporterEventId</destination>
  </mapping>
  <mapping>
    <source>mc-tool-sev</source>
    <destination class="reporterData">eventSeverity</destination>
  </mapping>
  <mapping>
    <source>mc-tool-suggestion</source>
    <destination class="reporterData">eventSuggestion</destination>
  </mapping>
  <!-- situation data -->
  <mapping>
    <source>mc-event-category</source>
    <destination class="situationData">situationCategory</destination>
  </mapping>
  <mapping>
    <source>mc-event-subcategory</source>
    <destination class="situationData">situationSubCategory</destination>
  </mapping>
  <mapping>
    <source>mc-incident-time</source>
    <destination class="situationData">situationTime</destination>
  </mapping>
  <mapping>
    <source>mc-priority</source>
    <destination class="situationData">priority</destination>
  </mapping>
  <mapping>
    <source>severity</source>
    <destination class="situationData">severity</destination>
  </mapping>
  <mapping>
    <source>msg</source>
    <destination class="situationData">messageSummary</destination>
  </mapping>
  <mapping>
    <source>mc-service</source>
    <destination class="situationData">service</destination>
  </mapping>
  <mapping>
    <source>mc-long-msg</source>
    <destination class="situationData">messageDetail</destination>
  </mapping>
  <mapping>
    <source>repeat-count</source>
    <destination class="situationData">repeatCount</destination>
  </mapping>
  <!-- metrics data -->
  <mapping>
    <source>mc-parameter</source>
    <destination class="metricsData">metricName</destination>
  </mapping>
  <mapping>
    <source>mc-parameter-value</source>
    <destination class="metricsData">metricValue</destination>
  </mapping>
  <mapping>
    <source>mc-parameter-unit</source>
    <destination class="metricsData">metricValueUnit</destination>
  </mapping>
  <mapping>
    <source>mc-parameter-threshold</source>
    <destination class="metricsData">metricThreshold</destination>
  </mapping>
  <!--  extended data is a generic place holder for all unidentified/custom fields -->
  <mapping>
    <source>extendedData</source>
    <destination class="extendedData">nameValueList</destination>
  </mapping>
</mappings>
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
<workflows>
  <workflow action="PerformRemediationOnTaskApproval">:BMC-SA-Event_Orchestration:Remediate:Perform Remediation on Task Approval</workflow>
</workflows>


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. 

Configuration item Description Update required?
Event Orchestration > Credentials

Stores the credentials for the operating systems.

  • WindowsCredentials: Specify the password for hosts using Windows operating system, in a secure manner.
  • UnixCredentials: Specify the password for hosts using Unix operating system, in a secure manner.


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.

<mappings>
  <!-- Related to Service Down Use Case -->
  <component-type name="NT_SERVICES">windows</component-type>
  <component-type name="NUK_Process">unix</component-type>
  <!-- Related to Host Down Use Case -->
  <component-type name="NT_REMOTE_HOST">windows</component-type>
  <component-type name="NUK_LINUX_REMOTE_HOSTS">unix</component-type>
</mappings>
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.

  Click here to view the default Infrastructure Mappings
<mappings>
  <datacenters>
    <datacenter name="default">
      <domains>
        <domain name="*">
          <component type="patrol" name="*">
            <username>patrol</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="patrol" name="hostname">
            <username>patrol</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="*">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="u1">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="windows" name="*">
            <username>Administrator</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="windows" name="hostname">
            <username>Administrator</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="hostname">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="hostname">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="database" name="oradb1">
            <url />
            <username>sys</username>
            <password-configuration-name>DatabaseCredentials</password-configuration-name>
            <invocation-mechanism>sql</invocation-mechanism>
          </component>
        </domain>
        <domain name="bmc.com">
          <component type="patrol" name="*">
            <username>patrol</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="patrol" name="hostname.bmc.com">
            <username>patrol</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="*">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="u1.bmc.com">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="windows" name="*">
            <username>Administrator</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="windows" name="hostname.bmc.com">
            <username>Administrator</username>
            <password-configuration-name>WindowsCredentials</password-configuration-name>
            <invocation-mechanism>windows-command</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="hostname.bmc.com">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="unix" name="hostname.bmc.com">
            <username>root</username>
            <password-configuration-name>UnixCredentials</password-configuration-name>
            <invocation-mechanism>ssh</invocation-mechanism>
            <ping-mechanism>command-line</ping-mechanism>
            <adapter-options />
            <command-options />
          </component>
          <component type="database" name="oradb1">
            <url />
            <username>sys</username>
            <password-configuration-name>DatabaseCredentials</password-configuration-name>
            <invocation-mechanism>sql</invocation-mechanism>
          </component>
        </domain>
      </domains>
    </datacenter>
  </datacenters>
</mappings>

You can update the Infrastructure Mappings based on your requirement. Infrastructure Mappings include information for the following elements:

  • <datacenters>: Specifies the root node that contains information about one or more data centers. Includes the <datacenter> element, which contains all the information related to a datacenter. If more than one exists, then, they are distinguished using name attribute.

    <datacenter name="default">
  • <domains>: Contains the <domain> child elements for specifying more than one domain. Out-of-the-box, a "*" domain is specified.
    • <domain name= "*">: Specifies the domain name where the event occurs. If no domain information is available in the event, a default domain named "*" is used.
    • <domain name= "acme.com">: Specifies a placeholder for a domain in your environment.

      Note

      If event data and target host information does not contain information related to a domain, then, an attempt will be made to extract component information from the default "*" domain.

    • <component>: Contains mapping information for a target. Component can have two attributes:
      type: Specifies the component type, whether it is a windows host or a Unix host.
      name: Specifies the name of the host. If host name is not known, specify "*".

      Example: <component type="windows" name="*">

      <component> contains the following child elements:

      • <username>: Specifies the username required to log on to the component.
      • <password>: Specifies the password that matches the username.
      • <invocation-mechanism>: Specifies the ways to invoke workflows. For example, if the component is a Windows computer, you can use windows-command as the invocation mechanism. The Command Line adapter is used. For Unix, the SSH adapter is used to invoke the workflows.
      • <ping-mechanism>: Specifies the mechanism to perform typical ping operations. Typically, a ping command can be performed from the local peer by using a command line adapter. 
      • <adapter-options>: Contains a comma-separated list of options to be passed to the adapter based on the adapter invocation mechanism. For example: use-ssl=true, use-unsigned-certificates=true.
      • <command-options>: Contains a comma-separated list of options to be passed to the command.
Yes


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. 

Configuration item Description Values
Service_Actions_Aliasing > Aliases

Contains the following elements:

  • <domain>: Contains the domain name for the servers, where the event is generated. Default domain is designated by a "*".  If an event does not contain any information about the domain, the default "*" domain information is used to search for the host specific information.
  • <host>: Each domain can have one or more configuration related to hosts. Default value is "*". If the event contains a host name that does not have a specific section in the configuration, default host, "*" is used. Hosts are categorized by the OS type – Windows or Unix.
  • <commands>: Contains the <command>element, which specifies the commands required for the triage and remediation actions. 
    For the service down event, <commands>contain the command to start or stop a service. While performing triage to determine if a service is running on Windows, sc status <service name> command is used. While performing remediation to start the service, a net start <service name> command is used.

The attribute use-name-string shall be set to false for default services so that service name from the event is used as opposed to '*' while invoking commands.

<domains>
  <domain name="*">
    <hosts>
      <host os-type="windows" name="*">
        <services>
          <service name="*" use-name-string="false">
            <start>
              <command>net start</command>
            </start>
            <stop>
              <command>net stop</command>
            </stop>
            <restart>
              <commands>
                <command>net stop</command>
                <command>net start</command>
              </commands>
            </restart>
          </service>
        </services>
      </host>
      <host os-type="unix" name="*">
        <services>
          <service name="repo">
            <search-string>/opt/bmc/BAO/REPO/jvm/bin/java</search-string>
            <start>
              <command>nohup /opt/bmc/BAO/REPO/bin/server.sh start</command>
            </start>
            <stop>
              <command>nohup /opt/bmc/BAO/REPO/bin/server.sh stop -force</command>
            </stop>
            <restart>
              <commands>
                <command>nohup /opt/bmc/BAO/REPO/bin/server.sh stop -force  </command>
                <command>nohup /opt/bmc/BAO/REPO/bin/server.sh start  </command>
              </commands>
            </restart>
          </service>
          <service name="cdp">
            <search-string>/opt/bmc/BAO/CDP/jvm/bin/java</search-string>
            <start>
              <command>nohup /opt/bmc/BAO/CDP/bin/server.sh start</command>
            </start>
            <stop>
              <command>nohup /opt/bmc/BAO/CDP/bin/server.sh stop -force</command>
            </stop>
            <restart>
              <commands>
                <command>nohup /opt/bmc/BAO/CDP/bin/server.sh stop -force</command>
                <command>nohup /opt/bmc/BAO/CDP/bin/server.sh start</command>
              </commands>
            </restart>
          </service>
        </services>
      </host>
    </hosts>
  </domain>
  <domain name="acme.com">
    <hosts>
      <host os-type="windows" name="*">
        <services>
          <service name="*" use-name-string="false">
            <start>
              <command>net start</command>
            </start>
            <stop>
              <command>net stop</command>
            </stop>
            <restart>
              <commands>
                <command>net stop</command>
                <command>net start</command>
              </commands>
            </restart>
          </service>
        </services>
      </host>
      <host os-type="windows" name="w1">
        <services>
          <service name="*" use-name-string="false">
            <start>
              <command>net start</command>
            </start>
            <stop>
              <command>net stop</command>
            </stop>
            <restart>
              <commands>
                <command>net stop</command>
                <command>net start</command>
              </commands>
            </restart>
          </service>
        </services>
      </host>
      <host os-type="unix" name="*">
        <services>
          <service name="repo">
            <search-string>/opt/bmc/BAO/REPO/jvm/bin/java</search-string>
            <start>
              <command>nohup /opt/bmc/BAO/REPO/bin/server.sh start  </command>
            </start>
            <stop>
              <command>nohup /opt/bmc/BAO/REPO/bin/server.sh stop -force  </command>
            </stop>
            <restart>
              <commands>
                <command>nohup /opt/bmc/BAO/REPO/bin/server.sh stop -force  </command>
                <command>nohup /opt/bmc/BAO/REPO/bin/server.sh start  </command>
              </commands>
            </restart>
          </service>
          <service name="cdp">
            <search-string>nohup /opt/bmc/BAO/CDP/jvm/bin/java</search-string>
            <start>
              <command>nohup /opt/bmc/BAO/CDP/bin/server.sh start</command>
            </start>
            <stop>
              <command>nohup /opt/bmc/BAO/CDP/bin/server.sh stop -force</command>
            </stop>
            <restart>
              <commands>
                <command>nohup /opt/bmc/BAO/CDP/bin/server.sh stop -force</command>
                <command>nohup /opt/bmc/BAO/CDP/bin/server.sh start</command>
              </commands>
            </restart>
          </service>
        </services>
      </host>
    </hosts>
  </domain>
</domains>


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
Was this page helpful? Yes No Submitting... Thank you

Comments