SNMP Detector

Use this detector to find and assigns services based on SNMP. The detector binds a service with a given service name when a particular SNMP OID as scalar or table matches a given criteria.

Detector facts

Implementation

org.opennms.netmgt.provision.detector.snmp.SnmpDetector

Configuration and Use

Table 1. Parameters for the SNMP detector
Parameter	Description	Required	Default value
`oid`	SNMP OID for scalar or table to detect the service.	required	`.1.3.6.1.2.1.1.2.0`
`retry`	Number of retries to detect the service.	optional	agent config
`timeout`	Timeout in milliseconds to wait for a response from the SNMP agent.	optional	agent config
`vbvalue`	Expected return value to detect the service; if not specified, the service is detected if the SNMP OID returned any kind of valid value. The `vbvalue` is evaluated as Java Regular Expression.	optional	`-`
`hex`	Set `true` if the data is from type HEX-String.	optional	`false`
`isTable`	Set `true` if detector should evaluate SNMP tables.	optional	`false`
`matchType`	Set match type to evaluate the expected value in the SNMP table. EXIST: the expected `vbalue` is ignored, service detected if the given table under OID exist ALL: all values in the table must match against expected `vbalue` to detect service ANY: at least one value in the table must match against expected `vbalue` to detect service NONE: None of the values should match against expected value to detect service.	optional	`EXIST`
`useSnmpProfiles`	Set `true` if detector should use SNMP profiles to detect `SNMP` service.	optional	`false`
`ttl`	Time to live in milliseconds to wait for a response from the Minion.	optional	`20000`

Example for SNMP scalar value

We have a Dell server farm and want to monitor the global server status provided by the OpenManage Server Administrator. Global status is provided by a scalar OID .1.3.6.1.4.1.674.10892.1.200.10.1.2.1. The service should be detected automatically if the server supports this OID.

For provisioning we have a requisition named Server, which contains all servers in our data center. We create a detector with the name Dell-OMSA-Global-State for this requisition with the following parameters:

Table 2. Parameters for the SNMP detector
Parameter	Value
`Name`	`Dell-OMSA-Global-State`
`oid`	`.1.3.6.1.4.1.674.10892.1.200.10.1.2.1`

When the requisition Server synchronizes with the service, Dell-OMSA-Global-State will be detected if it supports the given SNMP OID.

Example using SNMP tables

We have a HP server farm and want to monitor the status of logical drives over SNMP provided from HP Insight Manager. The status for logical drives is provided in a SNMP Table under .1.3.6.1.4.1.232.3.2.3.1.1.4. The service should be automatically assigned to all servers exposing the given SNMP OID.

For provisioning we have a requisition named Server which contains all server of our data center. A Detector with the name HP-Insight-Drive-Logical for this requisition is created with the following parameter:

Table 3. Parameters for the SNMP detector
Parameter	Value
`Name`	`HP-Insight-Drive-Logical`
`oid`	`.1.3.6.1.4.1.232.3.2.3.1.1.4`
`isTable`	`true`

When the requisition Server is synchronized the service HP-Insight-Drive-Logical will be detected in case they support the given SNMP OID table.