SNMP - Send Trap

Declaration

<AMSNMPSENDTRAP HOST="text" COMMUNITY="text" REMOTEPORT="number" SNMPVERSION="text [options]" ENTERPRISE="text" GENERICTYPE="text [options]" SPECIFICTYPE="number" TIMESTAMP="number" TIMESTAMPMEASURE="text [options]" VARBINDNAMES="text" VARBINDVALUES="text" VARBINDSYNTAXES="text [options]" />

Description: Simulates an SNMP trap message being sent from an SNMP agent.

IMPORTANT: To get the most out of SNMP activities, users should have a fundamental understanding of SNMP architecture and its major elements, such as Managers, Agents, MIBs, and PDUs.  

Practical Usage

Notifies a Network Management System (NMS) of an event or condition that took place on a SNMP agent.

Parameters

General

Property

Type

Required

Default

Markup

Description

Agent IP Address

Text

Yes

(Empty)

HOST="xxx.xxx.xxx.xxx"

The IP Address or host name of the SNMP agent to communicate with.

Community

Text

Yes

Public

COMMUNITY="NetAuto"

The SNMP community name.

Enterprise OID

Text

Yes

(Empty)

  1. NAME="system.sysDescr.0"

  2. NAME="1.3.6.1.2.1.1.1.0"

The OID for the network management system. This can be entered in either numeric or string notation format.

Trap generic type

Text (options)

No

enterprisespecific

GENERICTYPE="coldstart"

The generic type of the trap message. The available options are:

  • Enterprise specific (default) - The type is specified by the trap specific code in the Trap Specific Number parameter.

  • Cold start - Agent is booting.

  • Warm start - Agent is rebooting

  • Link down - An interface has gone down.

  • Link up - An interface has come up.

  • Authentication failure - An invalid community was received in a message.

  • EGP neighbor loss - An EGP peer has gone down.

Trap specific number

Number

No

(Empty)

SPECIFICTYPE="60"

The specific trap code. Valid only when the Trap Generic Type parameter is set to the default, enterprise specific.

Advanced

Property

Type

Required

Default

Markup

Description

Custom time stamp

Number

No

(Empty)

TIMESTAMP="100"

If enabled, specifies a custom time stamp. This parameter is disabled by default.

Timestamp measure

Text (options)

No

seconds

  1. TIMESTAMPMEASURE="milliseconds"

  2. TIMESTAMPMEASURE="seconds"

  3. TIMESTAMPMEASURE="minutes"

  4. TIMESTAMPMEASURE="hours"

The increment to use for the custom time stamp. The available options are:

  • milliseconds - Timestamp increment measured in milliseconds.

  • seconds (default) - Timestamp increment measured in seconds.

  • minutes - Timestamp increment measured in minutes.

  • hours - Timestamp increment measured in hours.

Remote Port

Number

No

162

REMOTEPORT="170"

The TCP/IP port that should be used for the message. The default is 162.

SNMP version

Text (options)

No

SNMPv1

  1. SNMPVERSION="SNMPv1"

  2. SNMPVERSION="SNMPv2c"

  3. SNMPVERSION="SNMPv3"

The version of the SNMP protocol to use. The default is SNMP version 1. The available options are:

  • SNMPv1 (default)

  • SNMPv2c

  • SNMPv3

Data

Property

Type

Required

Default

Markup

Description

Variable name

Number

No

(Empty)

  1. VARBINDNAMES="system.sysDescr.0"

  2. VARBINDNAMES="1.3.6.1.2.1.1.1.0"

The name/OID for a variable to be associated with a value in order to further define the trap notification. This can be entered in either numeric or string notation format.

Variable Value

Text

No

(Empty)

VARBINDVALUES="the data"

The value to assign to the variable.

Variable Syntax

Text (options)

No

integer

VARBINDSYNTAXES="ipaddress"

The data type The available options are:

  • integer (default) - An integer

  • octet string - An octet string

  • object ID - An object identifier

  • null - a null value

  • ipaddress - An IP Address

  • counter 32 - A 32-bit counter

  • gauge 32 - A 32-bit gauge

  • timeticks - A time tick

  • Opaque - Opaque

  • counter64 - A 64-bit counter

  • unsignedinteger32 - A 32-bit unsigned integer

Trap Specific Number

Text (options)

No

SNMPv1

  1. SNMPVERSION="SNMPv1"

  2. SNMPVERSION="SNMPv2c"

  3. SNMPVERSION="SNMPv3"

The version of the SNMP protocol to use. The default is SNMP version 1. The available options are:

  • SNMPv1 (default)

  • SNMPv2c

  • SNMPv3

Description

Error Causes

On Error

Example

NOTE: The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Send SNMP trap to "127.0.0.1".  Enterprise generating the trap is "1.3.16.1.5.1.311.1.1.3".  Generic type is enterprisespecific (specific trap number 60).  Variable bindings are "1.3.16.1.5.1.311.1.1.3.1.1" (corresponding values: "450", corresponding syntaxes: "integer").  Send trap with time stamp 20 milliseconds.  Community is "CommunityName".  Use remote port 178.  Use SNMP version "snmpv2c" to send the message.  

<AMSNMPSENDTRAP HOST="127.0.0.1" COMMUNITY="CommunityName" REMOTEPORT="178" SNMPVERSION="snmpv2c" ENTERPRISE="1.3.16.1.5.1.311.1.1.3" SPECIFICTYPE="60" TIMESTAMP="20" TIMESTAMPMEASURE="milliseconds" VARBINDNAMES="1.3.16.1.5.1.311.1.1.3.1.1" VARBINDVALUES="450" VARBINDSYNTAXES="integer" />