Configuring the SNMP monitor adapter

BMC recommends that you do not include unused elements in the adapter configuration because they might cause errors.

Adapter type: ro-adapter-snmp-monitor_vv.rr.nn

To configure the SNMP monitor adapter, see Configuring base adapters.

The following table describes the adapter configuration elements for the SNMP monitor adapter that you can specify by using the form view, XML view, or both. You cannot use the form view to configure elements and attributes that do not have an entry in the "UI label" column.

Configuration node elements for the SNMP monitor adapter

UI label

Element

Description

Required

Port

<port>

Specifies the port of the source computer to listen for SNMP traps

Yes

Version

<version>

Specifies the SNMP version

Valid values: 1, 2c, 3

Yes

Mibs Directory

<mibs-directory>

Specifies the directory location for SNMP MIBs

Note: To ensure that processes using the SNMP monitor adapter run successfully, the <mibs-directory> element must exist on all the peers on which this adapter is enabled. If you define an invalid path, the adapter goes into an error state.

No

Character Set

<character-set>

Specifies the supporting CharSet

Also called character set, it includes identifiers describing a series of universal characters.

Default value: ISO-8859-1

No

None

<engines>

Contains the <engine> elements

Conditional; required when SNMPv3 is specified

None

<engine>

Contains the following elements:

  • <user-name>
  • <authentication-protocol>
  • <authentication-password>
  • <privacy-password>
  • <engine-id>

Conditional; required when SNMPv3 is specified

None

<user-name>

Specifies the user name to authenticate the SNMPv3 request

Conditional; required for every <engine> element that is specified

None

<authentication-protocol>

Specifies the protocol that is used to encrypt the authentication password

Valid values: MD5 (default), SHA

No

None

<authentication-password>

Specifies the password for the specified <authentication-protocol>

Valid value: Any string; must contain at least eight characters

Conditional; required if <authentication-protocol> is used

None

<privacy-password>

Specifies the password used to encrypt the SNMP packet

Valid value: Any string; must contain at least eight characters

No

None

<engine-id>

Specifies the engine ID of the agent or the engine ID used by the agent to send the SNMP notification; only the traps that have the specified engine ID are received for a specific engine group

Valid values: 0x (hexadecimal characters: 0 – 9
and a – f)

Valid length: 12 – 66 in steps of 2

Examples:
0x1234567890, 0X9987654021

If you do not specify <engine-id>, the monitor adapter discovers the engine ID dynamically by reading the SNMP trap message.

No

SNMPv3 uses User-based Security Model (USM) to authenticate and encrypt the SNMP packet.

The following figure shows the XML template for the SNMP monitor adapter configuration

XML template of the SNMP monitor adapter configuration

<config>
  <port></port>
  <version></version>
  <mibs-directory></mibs-directory>
  <character-set></character-set>
</config>

The following figure shows the XML sample for the SNMP monitor adapter configuration

XML sample of the SNMP monitor adapter configuration

<config>
   <target>localhost</target>
   <port>4000</port>
   <version>1</version>
   <character-set>shift_jis</character-set>
</config>

The following figure shows the XML sample for the SNMP monitor adapter configuration when the adapter supports SNMPv3

XML sample of the SNMP monitor adapter configuration when the adapter supports SNMPv3

<config>
    <port>162</port>
    <version>3</version>
    <engines>
        <engine>
            <user-name>traptest11</user-name>
            <authentication-password>mypassword</authentication-password>
            <engine-id>0x1234567890</engine-id>
            <privacy-password>mypassword</privacy-password>
        </engine>
        <engine>
            <user-name>traptest1</user-name>
            <authentication-password>mypassword</authentication-password>
            <authentication-protocol>sha</authentication-protocol>
            <engine-id>0x1234567892</engine-id>
            <privacy-password>mypassword</privacy-password>
        </engine>
        <engine>
            <user-name>traptest12</user-name>
            <authentication-password>mypassword</authentication-password>
            <privacy-password>mypassword</privacy-password>
        </engine>
    </engines>
</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 BMC Atrium Orchestrator Platform version 7.8 or later to use the custom logging feature. These parameters will be ignored in earlier versions of BMC Atrium Orchestrator Platform.

These parameters are available with supported adapter versions. See your adapter 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