Description

Issues a SNMP Get message to a SNMP agent in order to inspect the value of a variable.

This action can be used to get the value of an SNMP Variable on an SNMP-capable agent, such as a router.

Declaration

<AMSNMPGETREQUEST HOST="text" NAME="text" COMMUNITY="text" REMOTEPORT="text" TIMEOUT="text" BROADCASTDELAY="text" OIDSTRINGNOTATION="yes/no" TIMETICKSTRINGNOTATION="yes/no" SNMPVERSION="options" RESULTDATASET="text">

Example

<AMSNMPGETREQUEST HOST="192.X.X.X" NAME="Variable_Name" COMMUNITY="public" RESULTDATASET="Dataset_Name" />

General Tab Parameters

Agent IP address: Specifies the IP address or host name of the agent with which to communicate.

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

Variable name: Specifies the SNMP variable to request. This value can be an OID either numeric or human-readable format. (This is not an Automated Workflow variable)

Text, Required
MARKUP: NAME="system.sysDescr.0"
or NAME="1.3.6.1.2.1.1.1.0"

Community: Specifies the SNMP community.

Text, Required
MARKUP: COMMUNITY="communityname"

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

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

Advanced Tab Parameters

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

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

Time out after: Specifies the amount of time in milliseconds, seconds, minutes, or hours that the action should wait for a response before generating an error. The default is 30.

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

Broadcast delay: Only valid when IP address is set to a broadcast address. Specifies the amount of time in milliseconds, seconds, minutes, or hours that the action should wait for a response when broadcasting. The default is 3 seconds.

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

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

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

Data Tab Parameters

Use string notation for OIDs: Specifies whether the variable will contain the returning OID in numeric or "human readable" format.

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

Use string notation for timetick values: Timetick A non-negative integer that specifies the elapsed time between two events in units of hundredth of a second. 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.

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

See Also

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