What are the list of '$' variables that can be used in SNMP Trap processor's message?

Field

Description

$Agent SNMP v1 Traps

If the device corresponding to the agent address returned by the trap has been discovered by WebNMS, this token fetches the name of the parent managed object (MO) corresponding to the interface object matching the agent address of the trap received.

If the device corresponding to the agent address of the trap has not been discovered, this token returns the corresponding IP address of the agent address from which the trap has been received.

For example, a trap is received from an agent and the corresponding device has been discovered by WebNMS with the interface object of 'IF-webserver' and the name of the parent managed object is 'webserver'. In this scenario, %Agent returns webserver. If the device is not yet discovered, %Agent returns the IP address, such as 192.168.1.30.

SNMP v2C & v3 Traps

If the device corresponding to the source address contained by the received trap has already been discovered by WebNMS, this token fetches the name of the parent MO that corresponds to the interface object matching the source address of the received trap. If the device corresponding to the source address of the trap has not been discovered, this token returns the IP address of the source of the trap.

$Community This token is replaced by the community string of the received trap.
$Enterprise This token is replaced by the enterprise ID of the received trap. This token is applicable to SNMP traps only, for non-SNMP traps it is replaced with "".
$GenericType This token is replaced by the generic type of the received trap. This token is applicable to SNMP v1 traps only. For non-SNMP traps, it is replaced with "".
$Source If the device corresponding to the source address contained by the received trap has been discovered by WebNMS, this token fetches the name of the parent MO that corresponds to the interface object matching the source address of the received trap. If the device corresponding to the source address of the received trap has not been discovered, the corresponding IP address of the source address is returned.
$SpecificType This token is replaced by the specific type of the received trap and is applicable to SNMP v1 traps only. For non-SNMP traps, it is replaced with "".
$Uptime This token is replaced by the up-time value in the received trap.
$TrapOID This token is replaced by the trap OID of the received trap. This token is applicable to SNMP v2C traps only. For non-SNMP traps, it is replaced with "".
$* This token is replaced by all the variable bindings (both OID and variable values) of the received trap.

Example: For the following varbinds, 2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10The result is ifIndex: 30, sysDescr: abc, ifIndex: 10

$# This token is replaced by all the variable binding values (only variable values and not OIDs) of the received trap.

Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10

The result is 30, abc, 10

$N For this token, N is a non-negative integer. This token is replaced by the (N+1)th SNMP variable value in the variable bindings of the received trap. The Index N starts from 0.

Example: For the following varbinds, 2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10

For %1, the result is abc

@* This token is replaced by all the OID labels in the variable bindings of the received trap.

Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10

The result is ifIndex: sysDescr: ifIndex

@N This token is replaced by the (N+1)th OID value in the variable bindings of the received trap. The index count starts from 0.This token is replaced by the (N+1)th OID label in the variable bindings of the received trap. The index starts from 0.

Example: For the following varbinds,2.2.1.1.221 INTEGER 30 .1.3.6.1.2.1.1.1 STRING abc 2.2.1.1.1 INTEGER 10

For @1, the result is sysDescr

$IP-Source This token is replaced by the IP address corresponding to the source address of the received trap.
$IP-Agent This token is replaced by the IP address corresponding to the agent address of the received trap.
Special Purpose Tokens Note: The associated Managed object should have been discovered already by WebNMS for using the following special purpose tags (or tokens). This is applicable to all special purpose tags (or tokens) enumerated in this section.
$AgentMO This token enables access to managed object properties. The tag can be used to access any properties of the parent managed object for the interface object corresponding to the agent address of the received trap. (Fetching the MO is similar to the $Agent tag mechanism). For example, if you want to access the pollInterval property of the parent MO that corresponds to the agent address of the received trap and assign it to some property of the generated Event object, you must specify the tag as $AgentMO(pollInterval) against the specific property of the event.

Usage: $AgentMO(PropertyName)

$IF-AgentMO This token is similar to $AgentMO, except that the properties of the interface MO that corresponds to the agent address of the received trap can be accessed using this tag. In the case of SNMP v2C traps, it is exactly the same as $IF-SourceMO.

Usage: $IF-AgentMO(PropertyName)

$IF-Agent This token is similar to $Agent, except that it results in the interface MO name that corresponds to the agent address of the trap received. In the case of SNMP v2C traps, it is exactly the same as $IF-Source.

Usage: $IF-Agent

$SourceMO This token can be used to access any properties of the parent MO for the interface object that corresponds to the source address of the received trap. (Fetching the MO is similar to the $Source tag). For example, if you want to access the pollInterval property of the parent managed object corresponding to the source address of the received trap and assign it to some property of the event, you must specify the tag as $SourceMO(pollInterval) against the specific property of the event.

Usage: $SourceMO(PropertyName)

$IF-SourceMO This token is similar to $SourceMO, except that the properties of the interface MO that corresponds to the source address of the received trap can be accessed using this tag.

Usage: $IF-SourceMO(PropertyName)

$IF-Source This token is similar to $Source, except that it results in the interface object name that corresponds to the source address of the received trap.

Usage: $IF-Source

Video Zone
OpManager Customer Videos
Altaleb Alshenqiti - Ministry of National Guard - Health Affairs
  
  •  IT Admin from "Royal flying doctor service", Australia
     Jonathan ManageEngine Customer
  •  Michael - Network & Tech, ManageEngine Customer
     Altaleb Alshenqiti - Ministry of National Guard - Health Affairs
  •  David Tremont, Associate Directory of Infrastructure,USA
     Todd Haverstock Administrative Director
  •  Donald Stewart, IT Manager from Crest Industries
     John Rosser, MIS Manager - Yale Chase Equipment & Services
 Pricing  Get Quote