SnmpMonitor - OpenNMS

From OpenNMS

Description

This poller monitor's job is to monitor the value of an SNMP MIB object.

Prerequisites

This monitor uses SNMP to accomplish its work. Therefore systems against which it is to be used must have an SNMP agent installed and configured. If OpenNMS is able to discover and collect data from the SNMP service on a given node, then that first requirement has almost certainly been met.

SnmpMonitor Parameters

Monitor-specific required parameters

oid: The object identifier of the MIB object to monitor. If no other monitor-specific parameters are present, the monitor simply asserts that the agent's response for this object must include a valid value (as opposed to an error, no-such-name, or end-of-view condition) that is non-null.

Monitor-specific optional parameters

operand: A value to be compared (using the specified operand) against the observed value of the monitored object
operator: One of the following symbolic operators. Keep in mind that if you are editing the poller configuration by hand, you will need to escape all < and > characters as XML entities < and > respectively.

<

Less than. Both operand and observed object value must be numeric.
>: Greater than. Both operand and observed object value must be numeric.
<=: Less than or equal to. Both operand and observed object value must be numeric.
>=: Greater than or equal to. Both operand and observed object value must be numeric.
=: Equal to. Applied in numeric context if both operand and observed object value are numeric, otherwise in string context as a case-sensitive exact match.
!=: Not equal to. Applied in numeric context if both operand and observed object value are numeric, otherwise in string context as a case-sensitive exact match.
~: Regular expression match. Always applied in string context. Documentation on regular expression syntax is here.

walk: If set to true, the monitor will perform GET-NEXT or GET-BULK operations -- effecting a "walk" to the end of a MIB branch -- instead of the default GET operation. This parameter can be used to monitor all instances of a tabular object. When used alone, the monitor returns an "Up" status if the value of any object encountered in the walk matches the criteria specified by operand and operator. See also match-all, minimum, maximum.
match-all: Implies walk. If set to true, specifies that the value of every object encountered in the walk must match the criteria specified by operand and operator. If set to count, specifies that the value of at least minimum and at most maximum objects encountered in the walk must match the criteria specified by operand and operator.
minimum: Valid only when match-all is set to count. Implies walk. May be used in conjunction with maximum. Specifies that the value of at least minimum objects encountered in the walk must meet the criteria specified by operand and operator. See also match-all, maximum.
maximum: Valid only when match-all is set to count. Implies walk. May be used in conjunction with minimum. Not valid in conjunction with match-all. Specifies that the value of at most maximum objects encountered in the walk must meet the criteria specified by operand and operator. See also match-all, minimum.
reason-template: A user-provided template used for the monitor's reason code if the service is in a "Down" state. Defaults to a reasonable value if unset. The following service parameters is accessible using ${} syntax:

${oid}, ${operand}, ${operator}, ${walk}, ${matchAll}, ${minimum}, ${maximum}, ${timeout}, ${retry}, ${ipaddr}, ${port}

As specified in the service configuration and SNMP peer configuration.
${observedValue}: The actual value observed for the monitored object. Not set if walk is true.
${matchCount}: If match-all is set to count, contains the number of matching instances encountered.

Parameters common to all monitors

ds-name
rrd-repository
port
timeout
retry

Get OpenNMS

Get Help

Get Involved

Get to Know Us

Toolbox