SNMP - Get bulk
Declaration
<AMSNMPGETBULKREQUEST HOST="text" COMMUNITY="text" SNMPVERSION="text (options)" RESULTDATASET="text" NONREPEATERS="number" MAXREPETITIONS="number" VARBINDNAMES="text" />
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 Automate Desktop's 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 hostname 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="30" | 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 |
|
The
time measurement that corresponds to the value entered in the Timeout after parameter. The
available options are:
|
| 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 |
|
The
time measurement that corresponds to the broadcast delay value.
The available options are:
|
| SNMP version | Text (options) | No | SNMPv1 |
|
The
version of the SNMP protocol to use. The default is SNMP version
1 as it is the most prevalent. The available options are:
NOTE: SNMPv3 must be selected to enable the authentication protocol option. |
| Remote port | Number | No | 161 | REMOTEPORT="555" | The TCP/IP port that should be used for the SNMP request. The default port is 161. |
| Authentication Protocol | Text (options) | No | Do not use authentication |
|
SNMPv3 must be selected to make this potion available. The available options for Authentication algorithm are:
|
| Discovery time out | Number | Yes | 30 seconds | DISCOVERYTIMEOUT="30seconds" | The total elapsed time that this activity should wait for a discovery before a time out. |
| Authentication username | Text | Yes | empty | USERNAME="username" | User name to configure the remote user. |
| Privacy Algorithm | Text (options) | No | Do not encrypt messages |
|
The available options for Privacy are:
|
| Authentication password | Text | Yes | Empty |
PASSWORD="password" |
Password to configure the remote user. |
| Privacy password | Text | Yes | Empty |
PRIVACYPASSWORD="privacypassword' |
Privacy password for the algorithm. |
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 variables 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 selected, the value will be returned in human readable format. If disabled, the value will be returned in numeric format. This parameter is selected 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 selected, the step will return the value in string notation. If disabled, this step will return the value in 32-bit number format. This parameter is selected by default. |
Description
This sample task sends an and then creates and populates a dataset with the results.
Copy
<AMSNMP ACTIVITY="get_bulk" HOST="192.168.110.133" NONREPEATERS="3" MAXREPETITIONS="3" COMMUNITY="public" RESULTDATASET="theDataset" SNMPVERSION="snmpv2c" VARBINDNAMES="1.3.6.1.2.1.2.2.1.1.1" />