SNMP Get Bulk Action

Declaration

<AMSNMPGETBULKREQUEST HOST="192.168.110.133" COMMUNITY="public" SNMPVERSION="snmpv2c" RESULTDATASET="theDataset" NONREPEATERS="3" MAXREPETITIONS="3" VARBINDNAMES="1.3.6.1.2.1.2.2.1.1.1" />

See Also

SNMP Get, SNMP Get Next, SNMP Set, SNMP Walk, SNMP Send Trap

 

Description

Issues a SNMP Get Bulk message to a SNMP agent in order to inspect a group of variables in a single transaction. This action is particularly useful for retrieving large tables. The GETBULK operation performs a GETNEXT operation for the first number of variable bindings in the request and performs a GETNEXT operation (continuous) for each of the remaining variable bindings in the request list.

NOTE: The SNMP GetBulk command is not supported on devices using SNMPv1.

Practical Usage

See Description.

Parameters

General Tab

Agent IP Address

Text, Required
MARKUP: HOST="c:\file.xls"

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

Return variable for the first [ ] variable bindings

Text, Required
MARKUP: NONREPEATERS="3"

Specifies the number of variables in the variable list for which a simple GETNEXT operation will initially be performed. This is similar to the Non-repeaters value.

Max number of variables to be returned for the rest of the variable bindings

Text, Required
MARKUP: MAXREPETITIONS="3"

Specifies the maximum amount of GETNEXT operations for the rest of the variables. This is similar to the Max-Repetitions value.

Community

Text, Required
MARKUP: COMMUNITY="communityname"

Specifies the SNMP community.

Create and populate dataset

Yes/No, Optional - Default NO
MARKUP:
a) VISIBLE="no"

Specifies the name of the dataset that will be created and populated with the results of the request.

Advanced Tab

Remote Port

Text, Optional Default 161
MARKUP: REMOTEPORT="5555"

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

Time Out

Text, Optional Default 30
MARKUP: TIMEOUT="999"

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

Broadcast Delay

Text, Optional Default 3
MARKUP: BROADCASTDELAY="10"

Only valid when IP address is set to a broadcast address. Specifies the amount of time in seconds that the action should wait for a response when broadcasting. The default is 3 seconds.

SNMP Version

Options, Optional Default SNMPv1
MARKUP: SNMPVERSION="snmpv2c"

Specifies the version of the SNMP protocol to use. The default is SNMP version 1 as it is the most prevalent.

Data Bindings Tab

Variable Name

Text, Required
MARKUP: VARBINDNAMES="1.3.6.1.2.1.2.2.1.1.1"

Variable bindings are entered in the Data Bindings tab. To add a variable name, click the Add button. This will present a dialog titled Define variable binding in which the proper variable(s) can be entered. Added variable bindings are displayed in the Variable name parameter. To edit a variable, highlight it from the list and click Edit. To delete an existing variable, highlight the variable and click Delete.

Use string notation for OIDs

Yes/No, Optional Default Yes
MARKUP: OIDSTRINGNOTATION="no"

Specifies whether the variable will contain the returning OID in numeric or "human readable" format.

Use string notation for timetick values

Yes/No, Optional Default Yes
MARKUP: TIMETICKSTRINGNOTATION="no"

Timetick variable types are normally a 32-bit number but they can be returned in string notation.  When this option is enabled, the step will return the value in string notation.

Notes

Custom Description

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

Example

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

<AMSNMPGETBULKREQUEST HOST="192.168.110.133" COMMUNITY="public" SNMPVERSION="snmpv2c" RESULTDATASET="theDataset" NONREPEATERS="3" MAXREPETITIONS="3" VARBINDNAMES="1.3.6.1.2.1.2.2.1.1.1" />