Configuring adapters in the Event Orchestration runbook

This topic provides the list of adapters and the instructions to configure and enable them for the runbook.

To view information about the modules required for the runbook, see Configuring-modules-in-the-Event-Orchestration-runbook. 

If you choose not to configure content during the installation, you must configure and then enable the adapters on the Grid Manager. The adapters, modules, and the workflows installed with the runbook constitute the runbook framework and logic. 

Configure and enable adapters

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with the applications or devices. After configuration, you enable the adapter on the grid so that workflows and processes can use the adapters.

For the out-of-the-box use cases and the basic runbook framework, you must configure and enable the following adapters: 

  • BMC Remedy AR System
  • Command Line
  • New in 20.19.02PowerShell
  • SSH
  • REST
  • New in 20.19.02.003TrueSight Server Automation
  • Web Services
  • Windows Command

To configure adapters

  1. On the Grid Manager, click the Manage tab and then click the Adapters tab.
  2. From the Adapters in the Repository list, select the following adapters and click Add to Grid.
    • ro-adapter-remedy-actor 
    • ro-adapter-command-line 
    • New in 20.19.02ro-adapter-powershell
    • ro-adapter-ssh
    • ro-adapter-rest
    • New in 20.19.02
    • ro-adapter-ws
    • ro-adapter-windows-command

  3. From the Adapter on the Grid list, click Configure against the ro-adapter-command-line adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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

    Name of the adapter

    Command Line

    Element

    Description

    <character-set>

    Specifies the supporting CharSet; specify UTF-8

    CharSet is also called Character set that includes identifiers describing a series of universal characters. 

    <verify-os>

    Determines whether the adapter must determine the target OS type soon after authentication is complete or a connection is established 

    Valid values: true (default), false

    <read-buffer-size>

    Specifies the buffer size, in bytes, which will be used to read from I/O Streams

    Sample Command Line adapter configuration XML

    <config>
      <verify-os>false</verify-os>
      <character-set>UTF-8</character-set>
      <read-buffer-size>1024</read-buffer-size>
    </config>

  4. Click Configure against the bmc-adapter-microsoft-windows-powershell-actor adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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


    Default name of the adapter

    MicrosoftPowerShell

    Element

    Description

    <target>

    Specifies the fully-qualified (absolute) host name or IP address of the remote or the local computer 

    Default value: localhost

    <user-name>

    Specifies the user name required to authenticate the remote host computer 

    You must have administrative roles and privileges on the remote host computer.

    <password>

    Specifies the password that corresponds to the user-name provided 

    The <password> element can contain any special characters. It can also contain an encryption-type attribute.

    Sample PowerShell adapter configuration

    <config>
         <target>host1</target>
         <user-name>user1</user-name>
         <password encryption-type="Plain">pass1</password>
         <powershell-version>2.0</powershell-version>
         <use-userprofile>true</use-userprofile>
         <script-file-path>local</script-file-path>
         <character-set>gb18030</character-set>
         <logon-with-user-credentials>true</logon-with-user-credentials>
    </config>

  5. Click Configure against the ro-adapter-remedy-actor adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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

    Default name of the adapter

    ARSAdapter

    Element

    Description

    <target>

    Specifies the hostname 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>

  6. Click Configure against the ro-adapter-rest adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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

    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>

  7. Click Configure against the ro-adapter-ssh adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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

    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.

    <character-set>

    Specifies the supporting Character set.

    Specify UTF-8.

    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>UTF-8</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>

  8. Click Configure against the ro-adapter-windows-command adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

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

    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>

  9. Click Configure against the ro-adapter-remedy-ws adapter and provide the configuration details and then save the adapter configuration:

    Click here to expand...

    The following table describes the minimum required configuration and a XML sample configuration

    Name of the adapter

    SOAPAdapter

    Element

    Description

    <config>

    While the adapter does not require a configuration node, an XML tag, <config/> is required for the Properties field in Grid Manager adapter configuration.

    Sample SOAPAdapter configuration XML

    <config/>

  10. (Optional) Click Configure against the bmc-adapter-bmc-server-automation adapter and provide the configuration details and then save the adapter configuration: 

    Note

    This adapter is required only if you want to restart services using TrueSight Server Automation. 

    For details, see Configuring-the-BMC-Server-Automation-adapter. 

To enable adapters

You must enable adapters on a peer on the grid, so that workflows and processes can use the adapters.

  1. On the Grid Manager, click the Manage tab and then click 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, click Enable.
  4. Select the adapters that you configured in the earlier section, and then click OK.
  5. To close the Current Operation: Edit a Peer Configuration window, click OK.
  6. To ensure that enabled adapters are running (not in fault state), check the Status page.

Where to go next

After successfully configuring and enabling adapters on the grid, you can now configure modules for the runbook. For instructions, see Configuring-modules-in-the-Event-Orchestration-runbook. 

 

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