Configuring TrueSight Orchestration adapters

This topic describes how to configure and enable the TrueSight Orchestration adapters that are installed with the Event Orchestration run book. Adapters provide an interface between TrueSight Orchestration workflow processes and enable event management tool and BMC Remedy AR System products.

For a complete list of adapters that are installed out-of-the-box with the run book, see Adapter and modules installed with the run book. 

Important

This topic describes the configuration for the adapters that you must configure for the out-of-the-box service down event type. All other adapters need no customization.


To configure the adapters

  1. Log on to the TrueSight Orchestration Grid Manager.
  2. Access the adapters page by clicking the Manage tab; then click the Adapters tab.
  3. In the Adapters in Repository list, select the name of the adapter that you want to configure.
  4. Click Add to Grid to include the adapter in the Adapters on Grid list.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, enter a name for the adapter.
    The Name field does not support single-quote (') and ampersand (&) characters.

  7. Under Properties, enter or select values for the configuration elements. 
    (optional) You can configure the adapter in the XML view. 

    Note

    If the default value for an optional element is acceptable, omit the element. Do not include empty elements.

    You must configure the following adapters for the Event Orchestration run book:

    1. TrueSight Operations Manager actor adapter
    2. TrueSight Operations Manager monitor adapter
    3. BMC Remedy AR System actor adapter

    4. SSH adapter

      For more information about the configuration details for each of the adapters, see Adapter configuration elements. 

  8. Click OK to save the configuration changes. 
    After you configure the adapters, you must enable the adapters on the Grid. 

Back to top

To enable adapters on a peer

For an end to end event orchestration use case, you must enable the adapters required for the run book on any of the peers. 

Note

Adapters such as Web Services or REST do not require specific configuration however, you must enable all the required adapters on the grid.  

  1. In the Grid Manager application, select the Manage tab, and then select the Peers tab.
  2. Select the peer where you want to enable the adapter; then click the Edit selected Peer icon.
  3. In the New Adapters section of the Current Operation: Edit a Peer Configuration window, click Enable.
  4. Select the following adapters that you want to enable, and then click OK.
    • BMC Remedy AR System actor 
    • Command line
    • REST
    • Web Services
    • SSH 
    • TrueSight Operations Manager actor
    • TrueSight Operations Manager monitor
    • Windows Command

      To ensure that enabled (or activated) adapters are running (not in fault state), check the Status page. For more information, see Enabling-and-disabling-adapters in TrueSight Orchestration Platform documentation. 

Back to top

Adapter configuration elements

The following topic describes the adapters and the configuration elements required for configuring the adapters for the Event Orchestration run book. 

TrueSight Operations Manager actor adapter configuration

The following table describes the configuration elements and the sample XML configuration for the TrueSight actor adapter. For more information, see Configuring-the-BMC-TrueSight-Operations-Manager-adapter.

Default name of the adapter

TruesightActor

Element

Description/value

<mcell-dir-file-path>

Specifies the location of the mcell.dir file local to the TrueSight Orchestration peer on which the adapter is enabled 

The mcell.dir file contains information about the cell.

<cell-name>

Specifies the main cell name in TrueSight Infrastructure Management application where the events are reported


<user-name>

Specifies the user name to log on to the TrueSight Infrastructure Management application

Sample TrueSight Operations Manager actor adapter configuration XML

<config>
 <mcell-dir-file-path>C:\mcell.dir</mcell-dir-file-path>
 <cell-name>MainCEll</cell-name>
 <user-name>admin</user-name>
 <max-active-connections>8</max-active-connections>
 <min-active-connections>0</min-active-connections>
 <log-file-name>TrueSightActor</log-file-name>
 <log-file-size>4MB</log-file-size>
 <log-file-max-backup-index>10</log-file-max-backup-index>
 <log-file-append>true</log-file-append>
 <log-level>info</log-level>
</config> 

Back to top

TrueSight Operations Manager monitor adapter configuration

The following table describes the minimum required configuration elements and an XML sample configuration for the TrueSight monitor adapter. For more information, see Configuring-the-BMC-TrueSight-Operations-Manager-adapter.

Default name of the adapter

TruesightMonitor

Element

Description

<port>

Specifies the port on which the gateway listens

<gateway-name>

Specifies the name of the gateway

<use-common-event-model>

Specifies whether to convert the incoming event to a common event model format; specify true.

<encryption-key>

Specifies the encryption key used to encrypt events.

Default value: mc

Sample TrueSight Operations Manager monitor adapter configuration XML

<config>
 <port>1859</port>
 <gateway-name>TSCUSTOMAOBEMGW</gateway-name>
 <encryption-key>mc</encryption-key>
 <use-common-event-model>true</use-common-event-model>
 <enable-fine-debug>false</enable-fine-debug>
 <log-file-name>truesight-monitor-1.log</log-file-name>
 <log-file-size>4MB</log-file-size>
 <log-file-max-backup-index>10</log-file-max-backup-index>
 <log-file-append>true</log-file-append>
 <log-level>debug</log-level>
</config>

Back to top

BMC Remedy AR System adapter

The following table describes the minimum required configuration and a XML sample configuration for the BMC Remedy AR System actor adapter. 

For more information, see Configuring-the-BMC-Remedy-AR-System-actor-adapter. 

Default name of the adapter

ARSAdapter

Element

Description

<target>

Specifies the host name or IP address of the BMC Remedy AR System server

<user-name>

Specifies the user name to be used to connect to the BMC Remedy AR System server

<password>

Specifies the password that matches the user name

Sample BMC Remedy AR System actor adapter configuration XML

<config>
 <target>clm-aus-123456</target>
 <port>0</port>
 <user-name>Allen</user-name>
 <password>
   <EncryptedData xmlns="http://www.w3.org/2001/04/xmlenc#" Type="http://www.w3.org/2001/04/xmlenc#Content">
     <CipherData>
       <CipherValue>Nuc2XnnfSQRB4+NPuYJX8w==</CipherValue>
     </CipherData>
   </EncryptedData>
 </password>
 <rpc-number>0</rpc-number>
 <auto-reset-cache>true</auto-reset-cache>
 <delay>120</delay>
 <use-connection-pooling>false</use-connection-pooling>
 <max-connections>100</max-connections>
 <max-request-queue-size>2147483647</max-request-queue-size>
 <download-attachments>false</download-attachments>
 <retrieve-attachment-in-response>false</retrieve-attachment-in-response>
 <monitor-server-up-down>false</monitor-server-up-down>
 <monitor-server-frequency-secs>30</monitor-server-frequency-secs>
 <monitor-server-retry-count>3</monitor-server-retry-count>
 <server-timeout-normal>120</server-timeout-normal>
 <server-timeout-long>300</server-timeout-long>
 <server-timeout-extra-long>1800</server-timeout-extra-long>
</config>

Back to top

REST adapter

The following table describes the minimum required configuration elements and an XML sample configuration for the REST adapter. For more information, see Configuring-the-REST-adapter. 

Name

RESTAdapter

Element

Description

<host>

Specifies the TrueSight Orchestration host name

Sample REST adapter configuration XML

<config>
 <return-data-format>JSON</return-data-format>
 <request-timeout>60</request-timeout>
 <enable-redirects>true</enable-redirects>
 <download-attachment>false</download-attachment>
 <log-file-size>4MB</log-file-size>
 <log-file-max-backup-index>10</log-file-max-backup-index>
 <log-file-append>true</log-file-append>
 <log-level>info</log-level>
</config>


Windows Command adapter

The following table describes the minimum required configuration and a XML sample configuration for the Windows Command adapter. You use the Windows Command adapter if the target server where triage and remediation is to be performed is running on a Windows operating system. 

Note

You must configure and enable the Windows Command adapter on a peer running on Windows OS only. Ensure that the peer on which you enable the Windows Command adapter is running with administrative privileges.

For more information, see Configuring-the-Windows-Command-adapter.

Name of the adapter

WindowsCommandAdapter

Element

Description

<target>

Specifies the host name or IP address of the remote host

<user-name>

Specifies the user name to be used for remote host authentication.

You must have an administrator role and privileges on the remote host.

<password>

Specifies the password that corresponds to the <user-name>provided or that is used for remote host authentication.


<encryption-type>

Indicates whether the password specified is encrypted; is an attribute of the <password> element, not an element itself.

Valid values: Base64, Plain (default)

<executable>

Specifies the program to be used to execute the command.

This element is applicable in default mode only. 

Default value: xCmd.exe

Sample Windows Command adapter configuration XML

<config>
 <password encryption-type="Plain" />
 <impersonate-user>false</impersonate-user>
 <logon-with-user-credentials>false</logon-with-user-credentials>
 <executable>xCmd.exe</executable>
 <escape-double-quotes>true</escape-double-quotes>
 <debug-utility>false</debug-utility>
 <protocol>default</protocol>
 <script-file-path>local</script-file-path>
 <max-request-queue-size>65535</max-request-queue-size>
 <log-file-size>4MB</log-file-size>
 <log-file-max-backup-index>10</log-file-max-backup-index>
 <log-file-append>true</log-file-append>
 <log-level>info</log-level>
</config>

SSH adapter

The following table describes the minimum required configuration and a XML sample configuration for the SSH adapter.

For more information, see Configuring-the-SSH-adapter. 

Name of the adapter

SSHAdapter

Element

Description

<target>

Specifies the host name or the IP address of the remote host computer

<port>

Specifies the port on which the remote host listens 

Default value: 22

<user-name>

Specifies the user name required for remote host authentication

<password>

Specifies the password corresponding to the specified user name

The <password> element can contain an encryption-type attribute.

Sample SSH adapter configuration XML

<config>
 <target>HostName_FullyQualifiedDomainName</target>
 <port>22</port>
 <user-name>root</user-name>
 <password encryption-type="Plain">
   
   <EncryptedData xmlns="http://www.w3.org/2001/04/xmlenc#" Type="http://www.w3.org/2001/04/xmlenc#Content">
     <CipherData>
       <CipherValue>EypYPlQ/ST66jSgT8mqE5Q==</CipherValue>
     </CipherData>
   </EncryptedData>
 </password>
 <pass-phrase encryption-type="Plain" />
 <timeout-secs>60</timeout-secs>
 <allow-unknown-hosts>true</allow-unknown-hosts>
 <preferred-pk-algorithm>ssh-rsa</preferred-pk-algorithm>
 <establish-connection-timeout-secs>60</establish-connection-timeout-secs>
 <network-environment>false</network-environment>
 <read-buffer-size>1024</read-buffer-size>
 <character-set>ISO-8859-2</character-set>
 <use-shell-mode>false</use-shell-mode>
 <log-file-size>4MB</log-file-size>
 <log-file-max-backup-index>10</log-file-max-backup-index>
 <log-file-append>true</log-file-append>
 <log-level>info</log-level>
</config>

Back to top

Where to go from here

After configuring the adapters, you can now configure the modules required for the run book. For more information, see Configuring-TrueSight-Orchestration-modules. 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*