Configuring the BMC Server Automation adapter


You configure an adapter in TrueSight Orchestration Grid Manager. The configuration provides information about how the adapter interacts with BMC Server Automation. While each adapter must have a unique name, you can create multiple adapters with the same adapter type to allow for different configuration properties.

The form view provides an easy-to-use interface for configuring the actor adapter. You can also switch to the XML view to configure the adapter using XML only. However, after you switch to the XML view and save the configuration in the XML, you cannot thereafter use the form view for modifying the adapter configuration.

Note

A monitor adapter is not available for BMC Server Automation.

To add a new actor adapter configuration

  1. Log on to TrueSight Orchestration Grid Manager.
  2. To access the adapters page, click the Manage tab, and click the Adapters tab.
  3. On the Adapters in Repository page, select the check box corresponding to bmc-adapter-bmc-server-automation.
  4. Click Add to Grid.
    The adapter is now listed under Adapters on Grid.
  5. Click Configure corresponding to the newly added adapter.
  6. On the Add an Adapter Configuration page, configure the adapter by using the form view, or skip to step 7 to configure the adapter by using the XML view:
    1. Enter BladeLogic Adapter as the name for the adapter. This is the default adapter name used by the processes in the BMC_BladeLogic-AD-Operations_Manager module.
    2. Enter a description for the adapter.
    3. Under Properties, enter the values for the configuration elements, which are described in Adapter configuration samples and elements.

      Note

      Include all required elements, indicated with an asterisk (*) .

    4. Click Switch to XML View and specify the attribute for the <initial-command> and the <cli-tunnel-properties> element, which are not in the form view:
      1. On the warning message that appears, click Switch View.
      2. In the Properties text box, use XML format to enter the the attribute and elements not available as fields in the form view.
      3. Click OK.
        The newly configured adapter is now listed in the Adapters on Grid list.
  7. (optional) Configure the adapter in the XML view:
    1. Enter BladeLogic Adapter as the adapter name.
       This is the default adapter name used by the processes in the BMC_BladeLogic-AD-Operations_Manager module.
    2. Enter a description for the adapter.
    3. Click Switch to XML View.
    4. On the warning message that appears, click Switch View.
  8. In Properties, type the adapter configuration properties in an XML format, including the elements that are not available in the form view.
    The Properties text box must contain a valid XML configuration node for the adapter as shown in Adapter configuration samples and elements.  These samples show all possible elements.

    Note

    Do not include empty elements in the XML configuration.

  9. Click OK to save the changes.
     A confirmation message is displayed on the Adapters page and the newly configured adapter is now listed in the Adapters on Grid list.

Enabling custom logging

To enable custom logging for the adapter, you must specify a log file name. You can also provide additional parameters for logging.

Note

You must be using TrueSight Orchestration version 8.1 or later to use the custom logging feature. These parameters will be ignored in earlier versions of TrueSight Orchestration Platform.

These parameters are available with supported adapter versions. See TrueSight Orchestration Content documentation for details.

  • Log File Name: Provide a name for the log file.
    This file will be stored in the AO_HOME/tomcat/logs directory. If Log File Max Backup Index value is greater than 0, the log file name is suffixed with the backup index. For example, if the parameter value is a.log, backup log files will have names, such as a.log.1, a.log.2.
  • Log File Size: Specify a size limit for the log file. 
    If the value specified for Log File Max Backup Index is greater than 0, when the specified size is reached, the current file is renamed with the suffix .1. Otherwise, the log file will be reset and over-written. The default value is 10MB. The available units are KiloBytes (KB), MegaBytes (MB) or GigaBytes (GB).
  • Log File Max Backup Index: Enter the maximum number of backup files allowed. The default value is 10.
  • Log File Append: Select this option to append new log information to the existing information in the file. If unselected, the file will be overwritten with new log information.
  • Log Level: Enter the logging level using one of the following choices:

    Logging level

    Description

    DEBUG

    The most detailed logging level; logs low-level messages, normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    INFO

    (default)

    Logs normal execution, recoverable erroneous conditions, and unrecoverable erroneous conditions

    WARN

    Logs recoverable erroneous conditions and unrecoverable erroneous conditions

    ERROR

    The least detailed logging level; logs only error conditions that are not usually recoverable

Encrypting an element's contents

You can add the attribute secure="true" to an XML adapter element XML view to ensure that the element's contents is encrypted when displayed.

Note

You must be using TrueSight Orchestration Platform version 8.1 or later to use this encryption attribute.

 

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