How To Use the Built-In EM SNMP Adapter to Publish an SNMP MIB

Document ID : KB000020522
Last Modified Date : 14/02/2018
Show Technical Document Details

Description:

Beginning with Introscope 9 the SNMP Adapter is included with the Enterprise Manager by default. To use it, you just need to enable and configure it to publish your MIBs.

Solution:

How To Use the Built-In EM SNMP Adapter to Publish a MIB

Step 1:

Edit the Mom's IntroscopeEnterpriseManager.properties file. Here is the entire SNMP section:

#######################
# SNMP Adapter
#
# ================
# Set to true to enable the SNMP Adapter
# Default is false
introscope.enterprisemanager.snmp.enable=true

# The port used by the SNMP Agent.  Defaults to 161.
introscope.enterprisemanager.snmp.agent.port=16100

# This property supports hot config
# Set to true to enable Notifications (Traps).
# Default is true.
introscope.enterprisemanager.snmp.notification.enable=true

# The target port for Notifications.
# Default is 162.
introscope.agent.enterprisemanager.snmp.target.port=162

# The target host (hostname or IP address) for Notifications.
# Default is localhost.
introscope.agent.enterprisemanager.snmp.target.host=localhost

# The target SNMPv2 community for Notifications.
# Default is public.
introscope.agent.enterprisemanager.snmp.target.community=public

To publish a MIB, the Introscope user must have "publish_mib" permission granted in server.xml. This is not the case in APM 9.1.5.0, where "full" permissions seem to be sufficient, but in earlier versions the standard admin account is not enough and you'll need to give the Admin account the publish_mib permission explicitly. To create an SNMP collection, a user must also have write permissions to the domain.

On Linux, you must have root access on the Mom server to utilize the standard SNMP port of 161. Any port less than 1000 requires root access. To work around this, specify a port number greater than 1000 in IntroscopeEnterpriseManager.properties for the property introscope.enterprisemanager.snmp.agent.port (the default port is 161).

After editing IntroscopeEnterpriseManager.properties restart the Mom since some of the SNMP properties are not hot configurable.

Step 2:

Create a metric grouping containing the metrics you wish to report via SNMP.

From the Investigator, select a metric to report. Right-click on it and select "New SNMP Collection from Path XYZ"

Figure 1

You will be prompted to enter a name for the SNMP Collection and a Management Module to include it in.

Figure 2

Open the Management Module Editor and expand the Management Module you selected above and click on the SNMP Collection you created. Be sure to activate it.

Figure 3

Figure 4

Click the Manager menu item and select "Publish MIB". If this is grayed out it means you do not have permission to publish a MIB. In that case, revisit Step 1 and check your permissions.

Figure 5

CA APM can automatically generate MIBs for HP OpenView, BMC Patrol, and Mercury LoadRunner. If you need to publish a MIB to something else, select "Other" as the MIB type and click "Publish".

Figure 6

Be sure the metrics you are trying to publish are generating data. Publishing a MIB against inactive metrics may cause the MIB to contain invalid or non-existent data - even if the application begins to generate metrics after publication. If this happens, simply publish the MIB again while it is producing metrics.

New metrics will be published to the MIB at the interval you specify as the publishing period (15 seconds in this example). The MIB file will be generated in the $EM_HOME/snmp folder.

Figure 7

Here's an example of the beginning of a generated MIB file.

Figure 8