Short maintenance outage Saturday

This site, docs.bmc.com, will undergo a brief outage for maintenance at 2 A.M. CDT Saturday, April 4. Total downtime will be less than five minutes.

Page tree

Short maintenance outage Saturday

This site, docs.bmc.com, will undergo a brief outage for maintenance at 2 A.M. CDT Saturday, April 4. Total downtime will be less than five minutes.

Skip to end of metadata
Go to start of metadata

The following sections provide an overview of the steps required to configure the BMC Atrium Orchestrator adapters and modules required for the Triage and Remediation Solution. For more information about modifying adapter and module configurations, see the  Administering section of the BMC Atrium Orchestrator documentation.

Configure the required adapters

Adapters provide the interface between workflow processes, external systems, and applications. BMC Atrium Orchestrator configures adapters to establish connections and facilitate communications. The following table lists the required adapters, their user guides, and where you can find more information about working with them:

Description of adapters required for Triage and Remediation Solution 

Adapter nameDescriptionUser guide
Windows command lineThe Windows command adapter is used to run commands on remote hosts running Windows operating systems.BMC Atrium Orchestrator Base Adapters User Guide
BMC Remedy Action Request System (ARS) application adapter and Remedy monitor adapterARS application adapter and Remedy monitor adapter performs actions on BMC Remedy ARS schemas.BMC Atrium Orchestrator Application Adapter User Guide for Remedy AR System
BMC Event Manager and ProactiveNetInterfaces with Infrastructure Management and the BMC Event Manager systemBMC Atrium Orchestrator Application Adapter User Guide for BMC Event Manager and ProactiveNet
SSHThe SSH adapter is used to run commands on a remote host through the SSH protocol.BMC Atrium Orchestrator Base Adapters User Guide
TelnetThe Telnet adapter is used to run commands on a remote host through the Telnet protocol.BMC Atrium Orchestrator Base Adapters User Guide
Tivoli Storage Manager actor adapterThe Tivoli Storage Manager (TSM) actor adapter resides on the TSM node and enables communication with the Backup and Recovery workflow.None
SQL actor adapterThe SQL actor adapter is used to run commands on the specified database.BMC Atrium Orchestrator Base Adapters User Guide

To configure an adapter on a grid

  1. Open the Grid Manager application.

    Note

    To open Grid Manager, use a web browser to navigate to the Grid Manager application: http://hostName or IPaddress:CDPWebServerPort/baocdp/gm
    This URL is an example where hostName or IPaddress indicates the IP address or host name of the server, where the CDP is installed (example localhost, server1, 192.168.1.123) and where CDPWebServerPort reflects the actual web server port defined during the CDP server installation. (The default port number is 8080.) 

    If security is installed in your environment, the Access Manager log on page is displayed. Log on using the user name and password provided by your administrator. The default username and password are admin and admin123.

  2. Select Manage > Adapters.
  3. Select the Adapter check box that is required.

    Note

    To review BMC Atrium Orchestrator adapter information, see the Adapter configurations parameters and nodes table.

  4. Configure the adapter type that you just added.
  5. Click OK.
    The adapter is added to the Adapters on Grid table.

    Warning

    For specific configuration node requirements, open the Current Operation: Edit an Adapter Configuration view. Switch to the XML view, and update the XML configuration document specified for the adapter. For more information, see Event Adapter User Guide. Some adapters do not require a specific configuration node. In such cases, enter the <config/> XML text in the Properties field.

  6. Repeat step 3 to step 6 for each required adapter.

Adapter configurations parameters and nodes

AdapterConfiguration parametersConfiguration node
BMC Remedy AR System application adapter
  • Name: ARSAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-remedy-actor

Enter the adapter configuration properties in XML format. Add the following required elements:

  • Target: AR System host name or IP address
  • Username: BMC Atrium Orchestrator (orchestrationuser ) user name
  • Password: Password of the BMC Atrium Orchestrator user account on BMC Remedy ITSM

Example:

<config>
<target>nnn.nn.nn.nnn</target>
<port>nnnn</port>
<userName>orchestrationuser</userName>
<password>password</password>
</config>
BMC Remedy Monitor adapter
  • Name: RemedyMonitorAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-remedy-monitor

Enter the adapter Configuration properties in XML format. Add the following required elements:

  • Target: AR System host name or IP address
  • Username: BMC Atrium Orchestrator (orchestrationuser) user name
  • Password: Password of the BMC Atrium Orchestrator user account on ITSM
  • Poll-interval: default to a value of 300

Example:

<config>
<target>172.23.23.225</target>
<user-name>orchestrationuser</user-name>
<password>password</password>
<poll-interval>300</poll-interval>
</config>
windows-command
  • Name: wincmd
  • Description: Type a description for the adapter.
  • Type: ro-adapter-windows-command

To enable the PATROL CLI command to work on Windows, add the following parameter to the Windows command line configuration:

 

<config> 
<escape-double-quotes>true</escape-double-quotes> 
</config>
Telnet
  • Name: TelnetAdapter
  • Description: Type a description for the adapter
  • Type: ro-adapter-telnet
  • No customized configuration required

Example:

 

<config> 
BMC Event Manager and ProactiveNet monitor adapter
  • Name: BEMMonitorAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-bmc-event-manager-monitor

Enter the adapter configuration properties in an XML format. Add the following required elements:

  • Port
  • Gateway
  • Encryption key

The values for these elements must match the values in themcell.dir file

Example:

<config>
<port>1859</port>
<gateway-name>BEMGW</gateway-name>
<encryption-key>mc</encryption-key>
</config>
BMC Event Manager and ProactiveNet actor adapter.
  • Name: BEMActorAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-bmc-event-manager-actor

Enter the adapter configuration properties in XML format. Add the following required elements:

  • Mcell path: the location of the mcell.dir file.
  • Cell name: the actual name of the cell in your environment
  • Mapping file location

Example:

<config>
<mcell-dir-file-path>C:\BEMConfig\mcell.dir</mcell-dir-file-path>
<cell-name>PNCell_cfs-010</cell-name>
<request-field-mapping-file-location>C:\BEMConfig\filter.xml<request-field-mapping-file-location>
</config>
SSH
  • Name: SSHAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-ssh
  • No customized configuration required

Example:

<config> 
SQL actor adapter
  • Name: SQLAdapter
  • Description: Type a description for the adapter.
  • Type: ro-adapter-sql-actor
  • No customized configuration required

Example:

<config> 
TSM actor adapter
  • Name: node where the TSM client resides
  • Description: Type a description for the adapter.
  • Type: ro-adapter-ibm-tsm-actor

Add the following credential definitions for the TSM client to the adapter's configuration file: 

<config> 
<user-name>admin</user-name> 
<password>admin</password> 
</config>

Enable the required adapters

The Triage and Remediation Solution solution requires that the adapters listed in the following table are installed by using the BMC Atrium Orchestrator content installer. After the content installation is completed, import the adapter wrappers into BMC Atrium Orchestrator Development Studio and enable them on the CDP.

To enable an adapter on a grid

  1. In Grid Manager, select Manage > Peers.
  2. From the peers list, select the peer where you want to enable the adapter, and then click the Edit icon.
  3. In the New Adapters section, click Enable.
  4. Select the adapters that you want to enable, and click OK.
  5. After selecting the adapters, click OK to enable the adapters on the grid.

Configure and deploy the required OA management modules

The Triage and Remediation Solution requires that the following modules are installed by using the BMC Atrium Orchestrator content installer. After the content installation is completed, import and unbundle the modules into BMC Atrium Orchestrator Development Studio.

OA management modules required for the Triage and Remediation Solution

Module nameDescription
AutoPilot OA Change ManagementEnables you to control the lifecycle of all changes with minimum disruption to IT services. Specific processes exist for interfacing with BMC Remedy ITSM change management.
AutoPilot OA Configuration ManagementEnables you to manage configuration items. Specific processes exist for interfacing with BMC Remedy ITSM change management and BMC Atrium CMDB.
AutoPilot OA Incident ManagementEnables you to manage incident requests. Specific processes exist for interfacing with service request management systems and BMC Remedy ITSM.
AutoPilot OA Task ManagementEnables you to perform tasks in response to service tickets. Specific processes exist for interfacing with service request management systems and BMC Remedy ITSM.
AutoPilot Common UtilitiesContain predeveloped processes representing platform processes used across all operations actions modules.
AutoPilot AD UtilitiesPredeveloped processes containing common application-related commands used in Red Hat Linux, Oracle Solaris, and Microsoft Windows environments.
AutoPilot Event ManagementContains configuration information that each workflow uses. The module provides complete configurations for BMC Event Management, HP Service Center, and IBM Netcool OMNIbus environments.
AutoPilot Credentials StoreContains the user names and passwords required to access the computers that you are managing with Triage and Remediation Solution and to communicate with PATROL.
AMD AD BMC Remedy ARS moduleWrapper that contains the AR adapters
RBA AD BMC Event Manager moduleWrapper that contains the Infrastructure Management and BMC Event and Impact Management adapters

For information about the OA management modules, see Operations Actions Management Modules and Utilities  in the BMC Atrium Orchestrator Content documentation.

To complete the module integration

  1. Import and unbundle the modules in the BMC Orchestrator Development Studio.
  2. Configure each module according to the instructions in Configure and deploy the required OA management modules.
  3. Export and enable the modules in Grid Manager.

To import and unbundle a module

  1. Open Development Studio and click Library Manager.
  2. Click Import Modules.
  3. Click From Grid, and then select the grid that contains the module that you want to import.


    If you are working offline in Development Studio, the login Window prompts you to log on to import a module from the grid library.

    Tip

    The Library Manager retrieves a list of available modules on the selected grid, and displays them in the Import modules pane. By default, only new modules are displayed. To display all modules on the selected grid, select Show All Versions.

  4. Check Unbundle for each module that you want to import and unbundle.
  5. Click Import.

Before you enable the module, modify its configuration to match the information you entered when you configured incident, change, and task templates in your BMC Remedy ITSM system.

Tip

You can configure the modules by using Grid Manager, or you can configure the modules by using Development Studio and then export the module configuration to the grid to keep the changes intact.

Modify the BMC Atrium Orchestrator modules in Development Studio

  1. From Development Studio, click Designer View.
  2. In the Project Explorer under Applications, double-click a module to expand it.
  3. Double-click Configuration to open the module Configuration Editor.
  4. Under Configuration, double-click the configuration group to display the configuration group items.
  5. Double-click a group item to view the configuration items within that group.
  6. Update the value of the configuration items in the group according to the information shown in Configuring the Credential Store and Configuring the Triage and Remediation module.
  7. Double-click a configuration item, make the required changes to the value, and click Save.
  8. Repeat the process of modifying the configuration groups until you finish customizing them for your environment.