Configuring BMC Event Adapters

This topic describes the function and contents of the mcxa.conf file, emphasizing the structure and contents of the configuration specifications for the various adapters.

Note

The BMC Event Log Adapter for Windows runs independently of the mcxa process and the mcxa.conf file.

Related topics

Configuring-BMC-Event-Adapters-to-start-collecting-eventsUsing the BMC Event AdaptersEvent integrations

  Configuration overview

You configure the BMC Event Adapters by modifying the parameters that control their behavior. All parameters are recorded in the mcxa.conf file.

  • Global parameters control certain behavioral aspects of all adapters running on the Engine Manager (mcxa process). Global parameters are listed in the Global Parameters section of the mcxa.conf file.
  • Common parameters behave like global parameters. Common parameters are listed in the Common Parameters section of the mcxa.conf file.
  • Specific parameters dictate selected aspects of the behavior on an individual adapter instance. These parameters are recorded in the mcxa.conf file in a definition that is specific to an adapter instance.

 Adapter definitions

The mcxa.conf file contains definitions for all the adapters running on the computer, as follows:

  • All types of BMC Event Adapters are listed in and are run from the mcxa.conf file. For example, IP Adapters do not use a separate mcxa.conf file from LogFile Adapters.
  • Multiple adapter instances can be defined in the file. For example, you can have three different TCP Client Adapters running, each with a unique configuration.

For more information about the structure of the mcxa.conf file, see About the mcxa.conf file.

 Adapter configuration tasks

To configure the global aspects of the adapters environment and the parameters specific to each adapter instance, perform the tasks in the order described in following table.

Note

You can add, remove, or modify global or common parameters, adapter instance definitions, or parser definitions in the mcxa.conf file at any time. If you make a change when the engine manager (the mcxa process) is stopped, your changes will be applied when you restart the engine manager. You can also make changes at run time. To ensure that these changes are recognized, see Applying-configuration-changes-at-run-time.

 Adapter configuration tasks

Phase

Action

Details

Where to go

Accessing the configuration file

Open the mcxa.conf file.

The file is located at installationDirectory\pw\server\etc\mcxa.conf.

Configuring the adapter environment

Specify values for global parameters.

Some parameters are required and some are optional.

Specify values for common parameters.

Some parameters are required and some are optional.

Configuring adapters

Decide which adapters you want to use.

Determine what you want to accomplish with the adapters and select the adapters appropriate to the task.

Gather the information required to define the adapter instances.

Review the specific parameters associated with each adapter that you want to use. Make a list of values that you want to add or modify for each adapter instance (such as port numbers). You must specify which parser each of your IP Adapter instances will use. Review the types of parsers available. BMC Software recommends that you create a brief planning sheet for each adapter, listing the information that you want to include in the adapter definition.

Modify or add adapter definitions.

The mcxa.conf file contains sample adapter definitions for all supported parameters.

Copy these definitions below the Write your configuration below heading at the end of the mcxa.conf file. Make a copy for each adapter instance that you require.

Add or modify adapter parameters as required for each adapter instance.

Not applicable

Define any required IP Adapter parsers.

The mcxa.conf file contains sample parser definitions for all supported parameters.

Copy these definitions below the Write your configuration below heading at the end of the mcxa.conf file. Make a copy for each parser instance that you require.

Add or modify parser parameters as required for each unique parser instance.

(Optional) Enable adapters.

You can enable adapters at any time after they have been configured. However, some adapters might require additional preparatory work before they are enabled:

  • If you intend to use a custom mapping, review Defining the BMC Event Adapters MAP files and do any required preparatory work before enabling any adapters using custom mappings.
  • Before enabling an SNMP Adapter, perform any required configuration involving the mib2map utility.

 

Note

When enabling an IP Adapter, you must also enable the parser that it uses (if that parser is not already enabled).

Save and close the mcxa.conf file.

Not applicable

Not applicable

Configuring the SNMP mib2map utility

Configure the mib2map utility (SNMP Adapter only).

The mib2map utility specifies how SNMP data is converted to cell events. You must perform some configuration of this utility to ensure that SNMP data is presented correctly in the events.

 

Note

Perform this task before you enable any SNMP Adapter instances.

 

Enabling adapters

Remove or comment out DISABLE in the adapter definitions.

Removing or commenting out DISABLE in an adapter definition enables it immediately. Do this only when you are ready to collect data.

 

Notes

  • If you did not enable the adapters when you first defined them, then you must reopen the mcxa.conf file, remove DISABLE from the required definition, and save and close the file.
  • When enabling an IP Adapter, you must also enable the parser that it uses (if that parser is not already enabled).

  

 

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