SNMP Walk

Issues a SNMP Walk message to a SNMP agent in order to inspect a group of variables. Commonly used to get the value of a group of SNMP variables on an SNMP capable agent such as a router.

Use of the SNMP actions require a fundamental comprehension of SNMP, its required protocol data units (PDU) and other related terms, such as NMS or MIB.

Declaration

<AMSNMPWALKREQUEST HOST="text" NAME="text" COMMUNITY="text" REMOTEPORT="text" TIMEOUT="text" BROADCASTDELAY="text" OIDSTRINGNOTATION="yes/no" TIMETICKSTRINGNOTATION="yes/no" SNMPVERSION="options" RESULTDATASET="text">

See Also: SNMP Get, SNMP Get Next, SNMP Set, SNMP Walk, SNMP Send Trap

General Tab

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.

Variable Name

Text

Yes

(Empty)

a)NAME="1.3.6.1.2.1.1.1.0"

b)NAME="system.sysDescr.0"

The SNMP variable to set. This value can be an OID (Object Identifier) in either numeric or human-readable format.

NOTE: This is not a variable.

Community

Text

Yes

Public

COMMUNITY="NetAuto"

The SNMP community name.

Create and populate dataset

Text

Yes

(Empty)

RESULTDATASET="myData"

The name of the dataset that should be created and populated with the results of the request.

Attributes Tab

Property

Type

Required

Default

Markup

Description

Timeout After

Text

Yes

30

TIMEOUT="500"

The amount of time that the action should wait for a response before generating a timeout error. The default is 30 seconds.

Timeout measure

Text (options)

Yes

seconds

TIMEOUTMEASURE="minutes"

The time measurement that corresponds to the timeout measure value. The available options are:

  • milliseconds

  • seconds (default)

  • minutes

  • hours

Broadcast delay

Number

No

3

BROADCASTDELAY="10"

The amount of time that the action should wait for a response when broadcasting. The default is 3 seconds.

Broadcast Measure

Text (options)

No

seconds

BROADCASTMEASURE="minutes"

The time measurement that corresponds to the broadcast delay value. The available options are:

  • milliseconds

  • seconds (default)

  • minutes

  • hours

SNMP version

Text (options)

No

SNMPv1

SNMPVERSION="snmpv2c"

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

  • SNMPv1 (default)

  • SNMPv2c

  • SNMPv3

Remote port

Number

No

161

REMOTEPORT="555"

The TCP/IP port that should be used for the SNMP request. The default port is 161.

Data Properties

Property

Type

Required

Default

Markup

Description

Use string notation for OIDs

Yes/No

No

Yes

OIDSTRINGNOTATION="no"

Specifies whether the variable should contain the returning OID in numeric or "human readable" format. If set to YES, the value will be returned in human readable format. If set to NO, the value will be returned in numeric format. This parameter is set to YES by default.

Use string notation for timetick values

Text (options)

Yes

seconds

TIMETICKSTRINGNOTATION="no"

Timetick variable types are normally a 32-bit number but they can be returned in string notation. If this parameter is set to YES, the step will return the value in string notation. If set to NO, this step will return the value in 32-bit number format. This parameter is set to YES by default.

Description Tab

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, % Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables

More on expressions

More on the expression builder