SNMP Trap parameters

The trap definition follows the BEGIN_TRAP line. The trap definition is the set of values for specified notification attributes that are placed in the VoIP Notification Trap Adapter notification. You can define these values in any order. The syntax of a line from the trap definition is:

<notification_attribute>:  <value>

Trap definition parameters shows the complete list of parameters to use in a trap definition and in the BEGIN_TRAP line. Each trap definition ends with END_TRAP.

Note:

If no parameter values are set within a trap definition BEGIN_TRAP section, the values set in the BEGIN_DEFAULT section are used.

Table 1. Trap definition parameters

Configuration file parameter	Corresponding standard notification attribute or description	Valid values
ASL	For advanced SNMP Trap Integration, this defines the ASL rule set file used to perform additional processing, which may include additional variable substitution. The ASL rule set must be located in BASEDIR/smarts/local/rules/voip/icoi. (See my_trap-rules.asl for a sample rule set.) The ASL processing overwrites any values set in the trap definition section.	File name
Aggregate	For advanced SNMP Trap Integration, this defines the mapping of a trap definition to an aggregate notification. One or more component notifications comprise an aggregate notification. For details and examples, see “Using the Trap Adapter Aggregate parameter” on page 110. Note that the Aggregate field is not supported in the Default Section of the file.	Special EventName:<string> This is the name of the aggregate notification and is required. ElementName:<object-handle> An object-handle identifies the InstanceName and the CreationClassName of an element. This is the name of the topology element where the aggregate is defined. This field is optional. If this field is not defined, the ElementClassName and ElementName of the trap definition are used, if available. Otherwise, the ClassName and InstanceName of the trap definition are used. If you define this field and specify an object-handle that does not exist in the topology, then the aggregate is not created. EventText:<string> This is the description of the aggregate notification (event). This field is optional.
Category	Category	Any string
ClassName	ClassName and DisplayClassName	Any string
ClearOnAcknowledge	ClearOnAcknowledge	TRUE or FALSE
ElementClassName	ElementClassName	Valid Class Name in VMware Smart Assurance topology
ElementName	ElementName	Valid Instance Name in VMware Smart Assurance topology. If you set the UnknownAgent to CREATE, then the instance does not have to previously exist.
EventName	EventName (describing the notification) and the EventDisplayName	Any string
EventText	EventText	Any string
EventType	EventType	MOMENTARY or DURABLE
Expiration	Defines the expiration time in seconds for the notification. Zero indicates that the notification will not expire. 7200 is the default value. If you use zero, you should use some method to eventually clear the notification. For example, you can configure the SNMP Trap Adapter to send clear state notifications or set the ClearOnAcknowlege parameter to TRUE.	Integer
InMaintenance	InMaintenance	TRUE or FALSE
InstanceName	InstanceName (of the object associated with the notification) and InstanceDisplayName	Any string
LogFile	The name of the file used by the SNMP Trap Adapter to log information for this trap. If this parameter is ’NONE’ or not defined, no information is logged. If this parameter is not defined, the default value is used.	File name
Map	Map is a special field that enables you to map varbinds to one or more printable strings. See “Using the Map parameter” on page 108 and “Using the Map parameter with tags” on page 109 for more information and examples of how to map varbind values. Note that the Map field is not supported in the Default Section of the file.	Special
Severity	Severity	Any integer from 1 to 5
State	Describes the state of the notification.	NOTIFY or CLEAR
SysNameOrAddr	A valid value describes either the system name or address of the entity that sent the trap. Values for this parameter override values in ElementClassName and ElementName.	Any string
UnknownAgent	Describes whether Adapter Platform should ignore traps related to unknown topology elements or create elements for the traps.	CREATE or IGNORE
UserDefined1-10	UserDefined1-10	Any string

In the above table and the corresponding trap definition, certain values in the SNMP trap were used as attribute values in the notification. This is accomplished through the use of variable substitution. SNMP variable bindings (varbinds) are placeholders for information common to standard SNMP traps and can be assigned to Service Assurance notification attributes within the trap definitions in the <vendor>_trap_mgr.conf file. The following are two lines taken from the trap definition based on above table that use variable substitution:

InstanceName:$SYS$
EventText:Agent $SYS$ restarted, reason=$V1$

The attribute InstanceName is populated with the value of a variable $SYS$. The contents of this variable comes from the incoming trap. In this example, $SYS$ is the name of the system where the trap originated and $V1$ represents the value of the first varbind.

SNMP Trap Adapter variables describes the variables available for basic SNMP trap integration. When specifying a variable, it must be enclosed by dollar signs ($).

Table 2. SNMP Trap Adapter variables

Variable	Description
$E$	Enterprise OID of the SNMP Trap
$T$	Timestamp of the SNMP Trap
$A$	Address of the agent sending the trap
$C$	Community string of the SNMP Trap
$SYS$	System where the SNMP trap originated
$N$	Generic trap number of the SNMP trap
$S$	Specific trap number of the SNMP Trap
$V<n>[-<tag>]$ or $V<*>$	Value of the <n>th varbind. The varbind may contain one of the following data types: integer, bit-string, octet-string, IP address, counter, gauge, unsigned integer, time ticks, counter 64, obj id, opaque, or null. Optionally, you can use a text string to tag the value of the <n>th varbind for multiple mappings. Also can use an asterisk <*> to specify all varbinds.