SNMP - Walk
Declaration
<AMSNMPWALKREQUEST HOST="text" NAME="text" COMMUNITY="text" REMOTEPORT="text" TIMEOUT="text" BROADCASTDELAY="text" OIDSTRINGNOTATION="yes/no" TIMETICKSTRINGNOTATION="yes/no" SNMPVERSION="options" RESULTDATASET="text">
Description
Issues a WALK message to an SNMP agent in order to inspect a group of variables.
Practical usage
Commonly used to get the value of a group of SNMP variables on an SNMP capable agent such as a router.
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. |
Variable name | Text | Yes | (Empty) |
|
The
SNMP variable to set. This value can be an OID (Object Identifier)
in either numeric or human-readable format. NOTE: This is not an Automate Desktop variable. |
Community | Text | Yes | (Empty) | COMMUNITY="NetAuto" | The SNMP community name. |
Create and populate dataset | Text | Yes | (Empty) | RESULTDATASET="myData" | The name of the dataset to be created and populated 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 |
---|---|---|---|---|---|
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. |
Example
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task issues a SNMP Walk message to a SNMP agent in order to inspect a group of variables. This action can be used to get the value of a group of SNMP variables on an SNMP capable agent such as a router.
<AMVARIABLE NAME="SNMPMessage" VALUE="" />
<AMSNMP ACTIVITY="walk" HOST="192.168.0.152" NAME="SNMPMessage" COMMUNITY="public" RESULTDATASET="theDataset" />
<AMLOOP ACTIVITY="dataset" DATASET="theDataset" />
<AMSHOWDIALOG>%SNMPMessage%</AMSHOWDIALOG>
<AMLOOP ACTIVITY="end" />