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.
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. The SNMP GetBulk command is not supported on devices using SNMPv1.
|
|
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
<AMSNMPGETBULKREQUEST HOST="text" COMMUNITY="text" SNMPVERSION="text (options)" RESULTDATASET="text" NONREPEATERS="number" MAXREPETITIONS="number" VARBINDNAMES="text" />
Example
<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
|
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 bindings |
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 that should be created and populated with the results of the request. |
|
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:
|
|
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:
|
|
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:
|
|
Remote port |
Number |
No |
161 |
REMOTEPORT="555" |
The TCP/IP port that should be used for the SNMP request. The default port is 161. |
|
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 Add. 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 |
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. |
This action includes the Description tab for entering a custom step description.
More on setting custom step description
This action also includes the standard Error Causes and On Error failure handling options/tabs.
More on Error Handling Options
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.