SNMP - Get bulk

SNMP - Get Bulk

Declaration

Description: Issues a GETBULK message to an SNMP agent in order to inspect a group of variables in a single transaction. This activity 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 that the SNMP GETBULK command is not supported on devices using SNMPv1.

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

Used to get data on a bulk amount of variables.

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.
Return variable for the first variable binding	Number	Yes	(Empty)	NONREPEATERS="3"	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	Number	Yes	(Empty)	MAXREPETITIONS="3"	The maximum amount of GETNEXT operations for the rest of the variables. This is similar to the Max-Repetitions value.
Community	Text	Yes	Public	COMMUNITY="netauto"	The SNMP community name.
Create and populate dataset	Text	Yes	(Empty)	RESULTDATASET="myData"	The name of the dataset to create and populate with the results of the request.

Advanced

Property	Type	Required	Default	Markup	Description
Timeout after	Text	Yes	30	TIMEOUT="500"	The total elapsed time that this activity should wait for a response before generating a timeout error. The default is 30 seconds.
Timeout measure	Text (options)	Yes	seconds	TIMEOUTMEASURE="milliseconds" TIMEOUTMEASURE="seconds" TIMEOUTMEASURE="minutes" TIMEOUTMEASURE="hours"	The time measurement that corresponds to the value entered in the Timeout after parameter. The available options are: milliseconds - Timeout value will be measured in milliseconds. seconds (default) - Timeout value will be measured in seconds. minutes - Timeout value will be measured in minutes. hours - Timeout value will be measured in hours.
Broadcast delay	Number	No	3	BROADCASTDELAY="10"	The maximum broadcast delay time that this activity will allow. The default is 3 seconds.
Broadcast measure	Text (options)	No	seconds	BROADCASTMEASURE="milliseconds" BROADCASTMEASURE="seconds" BROADCASTMEASURE="minutes" BROADCASTMEASURE="hours"	The time measurement that corresponds to the broadcast delay value. The available options are: milliseconds - Broadcast delay will be measured in milliseconds. seconds (default) - Broadcast delay will be measured in seconds. minutes - Broadcast delay will be measured in minutes. hours - Broadcast delay will be measured in hours.
SNMP version	Text (options)	No	SNMPv1	SNMPVERSION="SNMPv1" SNMPVERSION="snmpv2c" SNMPVERSION="SNMPv3"	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

Property	Type	Required	Default	Markup	Description
Variable name	Text	Yes	(Empty)	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	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	Yes/No	Yes	Yes	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

Error Causes

On Error

Expressions, Variables & Functions

A percent sign is used as a special character to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.