Configuring the BMC TrueSight Operations Manager adapter

You configure an adapter in Grid Manager. The configuration provides information about how the adapter interacts with BMC TrueSight Operations Manager application. 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 adapters. The form view prevents human errors that might occur as a result of copying the configuration XML from the XML sample into the UI when configuring an adapter. You can switch to the XML view to configure those elements and attributes that are not available as fields or to configure all the elements and attributes using XML only. However, after you switch to the XML view and save the configuration in the XML from that view, you cannot thereafter use the form view for modifying that configuration.

Note

The default name for the actor adapter is BPPMActorAdapter.

To configure the actor adapter, monitor adapter, or both

  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 bmc-adapter-bmc-proactivenet-performance-management-actor check box to configure the actor adapter.
    • Select the bmc-adapter-bmc-proactivenet-performance-management-monitor check box to configure the monitor adapter.
    • Select both check boxes to configure both adapters.
  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, perform the following substeps to configure the adapter using the form view or skip to step 7 to configure the adapter using the XML view:
    1. Enter a name for the adapter.

      Note

      The Name field does not support single-quote (') and ampersand (&) characters.

    2. Enter a description for the adapter.
    3. Under Properties, enter or select values for the configuration elements.

      Include all required elements, indicated with an asterisk (*).
  7. (optional) Configure the adapter in the XML view using the following substeps:
    1. Enter a name and a description for the adapter.
    2. Click Switch to XML View.
    3. On the Warning message that appears, click Switch View.
    4. Copy the configuration elements and attributes from the XML sample into the Properties text box, and then click OK.

      Note

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

    5. On the Warning message that appears, click Save.

      This action saves the adapter configuration with settings in the XML view permanently. The newly configured adapter is now listed in the Adapters on Grid list.

The following table describes the node elements required for configuring the actor adapter:

Node elements for configuring the actor adapter

UI label

Element

Description

Required

Mcell Dir File Path

<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.

To enable TLS mode for the actor or monitor adapter, ensure that you specify the following parameters in the mcell.dir file on the TrueSight Orchestration peer and in the mcell.dir file on the TrueSight Operations Management server.

TrueSight Orchestration Mcell.dir
cell       pncell_<TSIM_HOSTNAME> *TLS       <TSIM_HOSTNAME>:<PORT_NUMBER>
TrueSight Orchestration Mcell.dir
gateway.imcomm    BEMGW       *TLS      <AO_HOSTNAME>:< PORT_NUMBER>

Yes


Cell Name

<cell-name>

Specifies the cell name in BMC ProactiveNet Performance Management where the events are reported

Conditional; required if not specified in the request

User Name

<user-name>

Specifies the user name used for authentication

Conditional; required if not specified in the request

Request Field Mapping File Location

<request-field-mapping-file-location>

Specifies the location of the request field mapping file local to the TrueSight Orchestration peer

The request field mapping file contains information about the cell, such as custom slot name mapping,
where you can specify slot names to be used in requests.

If you use the same slot names in the requests as those used by the application or
if you do not change the slot names that are identified by the application,
you do not need to specify the request field mapping file.

However, if you use additional slots that are not incorporated earlier or slot names that are different from the slot names identified by the application, you need to specify the request field mapping file.

Example: If the application identifies newSlot as an existing slot, you can use newSlot in the request without specifying the request field mapping file.

However, if you change newSlot to newSlotForXYZ, you need the request field mapping file to map the external name, newSlotForXYZ, to a corresponding internal name used by BMC ProactiveNet Performance Management, newSlot, as follows:

<elements>
<element>
<external>newSlotForXYZ</external>
<internal>newSlot</internal>
</element>
</elements>



If the external slot names for ID, Origin Time, Component ID, Component Type, Status, Notes, Owner, or Priority are changed, you need to make corresponding changes in the adapter module configuration to ensure that the wrapper validations work properly.

Conditional; required if not specified in the request

Config File Location

<config-file-location>

Specifies the location of the mclient.conf file local to the TrueSight Orchestration peer

You can use the mclient.conf file in the BMC Service Impact Manager server installation location as a reference to create or copy the mclient.conf file required by TrueSight Orchestration. The mclient.conf file is then placed on the TrueSight Orchestration peer on which the adapter is enabled.

The mclient.conf file contains the information about the cell such as customized values for connection configuration parameters (for example, MessageBuffer parameters, Trace parameters, and so on).

For details about the .conf files, see the BMC TrueSight Operations Management 10.1 documentation.

Conditional; required if not specified in the request

Component Name

<component-name>

Specifies the component name used for maintenance mode operation

Conditional; required if not specified in the request

Max Active Connections

<max-active-connections>

Specifies the number of simultaneous active connections that can be made to a particular cell

If you specify a negative value, the number of simultaneous active connections that can be made is unlimited.

Default value: 8

No

Min Active Connections

<min-active-connections>

Specifies the minimum number of connections that are always present in the connections pool

You can use this element to optimize the number of active connections in the pool, which is required to make buffering effective.

Default value: 0

No

The following figure shows an XML sample for configuring the actor adapter.

XML sample for configuring the actor adapter

<config>
  <mcell-dir-file-path>/xyz/abc/lmn/mcell.dir</mcell-dir-file-path>
  <cell-name >somecell</cell-name>
  <user-name>someuser</user-name>
  <request-field-mapping-file-location>/xyz/abc/lmn/mymapping.xml
</request-field-mapping-file-location>
  <config-file-location>/xyz/abc/lmn/mcell.conf</config-file-location>
  <component-name>test</component-name>
</config>

The following table describes the node elements required for configuring the monitor adapter:

Node elements for configuring the monitor adapter

UI label

Element

Description

Required

Port

<port>

Specifies the port on which the gateway listens

Yes

Gateway Name

<gateway-name>

Specifies the name of the gateway

No

Encryption Key

<encryption-key>

Specifies the encryption key used to encrypt events

Default value: mc, NEW IN 20.18.01 *TLS

Conditional; specify *TLS if you want to use the adapter in a TLS mode.

Enable Fine Debug<enable-fine-debug>

Specifes whether to enable additional logging while event is converted to a commmon event model format.

Event processing can be performance intensive. Use this for debugging only.

Valid values: true, false (default)

No

NEW IN 20.18.01Use Common Event Model

<use-common-event-model>

Specifies whether to convert the incoming event to a common event model format

Default value: False

Warning

If you are using the adapter with TrueSight Orchestration Platform version earlier than 8.1 (8.0.x, 7.9.x, 7.8.x), the CEM may not work as expected.

To ensure that events are converted to the CEM format, you must replace the older webservices-rt-2.2.0.jar file with the updated webservices-rt-2.4.0.jar file.

For Platform version 8.1, the JAR file is already updated.

For more information, see Troubleshooting the BMC TrueSight Operations Management adapter.

No

Note

The configuration information that you specify for the monitor adapter must match that specified in the incomm.conf and mcell.dir files located on the BMC ProactiveNet Performance Management server.

The following figure shows an XML sample for configuring the monitor adapter.

XML sample for configuring the monitor adapter

<config>
<port>1859</port>
<gateway-name>BPPMGW</gateway-name>
<encryption-key>mc</encryption-key>
<use-common-event-model>false</use-common-event-model>
</config>

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 7.8 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

Was this page helpful? Yes No Submitting... Thank you

Comments