MIBMON Plug-in - Technical Reference

Introduction

GENEOS MIBMON Plug-in polls a list of MIBS from a specified remote device / node. The list of MIBS is defined in the plug-in setup. The frequency of the poll is defined by the SampleInterval setting of the Sampler Descriptor.

In line with all Geneos plug-ins, this plug-in caches the current MIB values so that if the new value is the same as the cached value, the plug-in does not send updates to the Gateway.

Prerequisites

The environment variable MIBDIRS must be set to the location of the directory containing the MIB files. This allows the MIBMON Plug-in to find the MIB files which contain the type and description of the MIB variables. Setting this environment variable to the correct value will ensure that the MIBMON Plug-in will display MIB values correctly, such as the following scenarios:

  • a STRING value will be displayed as a readable string instead of as a sequence of hexadecimal values.
  • an OID value will be displayed in human-readable form. For example, if the OID value of ifOperStatus is 1, the MIBMON Plug-in will display "up(1)" in the dataview.

Views

The UNIVERSAL MIBMON Plug-in produces a single view as follows. The view consists of name / value pairs. It is also possible to arrange the results in a user specified table where the column and row names are defined as part of the configuration.

View

mibmon1

Headline Legend

Name Description
acquisitionTIme The time it takes to request the mibs specified. If the request times out, this will be shown as 99999

Table Legend

Name Description
name Name of the MIB variable as defined in the plug-in setup
value Value of the variable

Plug-in Configuration

The following parameters can be configured for this plug-in:

targetNode

Name or IP address of the device / node where the MIBs are polled from.
If this is not specified, then the localhost is used.
Mandatory: No
Default: localhost

snmp

The SNMP settings for the plug-in.

Mandatory: No

snmp > port

The port to be used when connecting to the device / node where the mibs are polled from.

Mandatory: No
Default: 161

snmp > version

Deprecated, please use snmp > snmp_version for new configurations.

The version number of the SNMP protocol used - must correspond to the version supported by the device being interrogated.

Possible values are 1 or 2c or 3

Note: When interrogated Solaris 2.6 use version 1.

Mandatory: No
Default: 2c

snmp > community

The SNMP community name as defined by the SNMP device being monitored.

Mandatory: No
Default: public

snmp > snmp_version

The version number of the SNMP protocol used - must correspond to the version supported by the device being interrogated.

Possible values are 1 or 2c or 3

Note: When device being interrogated uses Solaris 2.6, use version 1.

Mandatory: No
Default: 2c

snmp > V3 > securityName

The SNMPV3 user to connect to the device as.

Mandatory: No
Default: None

snmp > V3 > authenticationOptions

SNMPV3 authentication options.

Mandatory: No
Default: None

snmp > V3 > authenticationOptions > authProtocol

The authentication protocol to use. Can be MD5 or SHA.

Mandatory: No
Default: None

snmp > V3 > authenticationOptions > authKey

The authentication key to use. Should be greater than or equal to 8 characters.

Mandatory: No
Default: None

snmp > V3 > encryptionOptions

SNMPV3 encryption options.

Mandatory: No
Default: None

snmp > V3 > encryptionOptions > privProtocol

The privacy protocol to use for encryption. Can be AES or DES.

Mandatory: No
Default: None

snmp > V3 > encryptionOptions > privKey

The private key to use for encryption. Should be greater than or equal to 8 characters.

Mandatory: No
Default: None

snmp > V3 > context

The context name of the user being used to connect to the device / node.

Mandatory: No
Default: None

snmp > queryTimeout

This is the timeout setting for the SNMP query (in seconds).

Mandatory: No
Default: 1

mibs

A list of MIB names and OIDs

Mandatory: Yes

mibs > mib > name

Name of a MIB. This will be shown in the name column of the view.

Mandatory: Yes

mibs > mib > OID

OID of a MIB

E.g 1.3.6.1.2.1.1.5.0

Mandatory: Yes

mibTable

An alternate table layout specification for the mibmon view

Mandatory:Yes

mibTable > columns

Column headings for the dataview.

Mandatory: Yes

mibTable > columns > column

A column heading for the dataview.

mibTable > rows

Row definitions for the dataview consisting of a rowname and a number of OIDS to populate the columns.

Mandatory: Yes

mibTable > rows > row

A row definition for the dataview consisting of a rowname and a number of OIDS to populate the columns.

Mandatory: Yes

mibTable > rows > row > rowName

A unique row name for the row being defined.

Mandatory: Yes

mibTable > rows > row > OIDS

A collection of OIDS, one for each column.

mibTable > rows > row > OIDS > OID

OID of a MIB

E.g 1.3.6.1.2.1.1.5.0

Mandatory: No

mibBase

The prefix for all the MIB OIDs. This makes it easier to define a large number of MIB names that share the same starting sequence:

mibs
mib
 name: system.sysName
 OID: 1.5.0
mib
 name: system.sysDecr
 OID: 1.1.0
mibBase: 1.3.6.1.2.1

is equivalent to
mibs
 mib
  name: system.sysName
  OID: 1.3.6.1.2.1.1.5.0
mib
 name: system.sysDecr
 OID: 1.3.6.1.2.1.1.1.0

Mandatory: No

private

The private configuration section holds settings used for debugging the plug-in.
Please contact ITRS support if you require assistance with this plug-in.