SNMP Set Action

Declaration

<AMSNMPSETREQUEST HOST="text" NAME="text" COMMUNITY="text" REMOTEPORT="text" TIMEOUT="text" BROADCASTDELAY="text" SNMPVERSION="options" VALUE="text" SYNTAX="options" RESULTDATASET="text">

See Also

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

Description

Issues a SNMP Set message to a SNMP agent in order to alter the value of a variable..

Practical Usage

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

Parameters

General Tab

Agent IP Address

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

Specifies the IP Address or host name of the agent to communicate with.

Variable Name

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

Specifies the SNMP Variable to set. This value can be an OID either numeric or human-readable format.  (This is not an AutoMate variable)

Community

Text, Required
MARKUP: COMMUNITY="communityname"

Specifies the SNMP community.

Variable Syntax

Options, Optional Default integer
MARKUP: SYNTAX="ipaddress"

Specifies the type of data that will be set in the variable value parameter.

The available options are:

Variable Value

Text, Required
MARKUP: VALUE="the data"

Specifies the Value to set.

Advanced Tab

Remote Port

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

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

Time Out

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

Specifies the amount of time in seconds that the action should wait for a response before generating an error. The default is 30.

Broadcast Delay

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

Only valid when IP address is set to a broadcast address. Specifies the amount of time in seconds that the action should wait for a response when broadcasting. The default is 3 seconds.

SNMP Version

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

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

Data Tab

Create and populate dataset

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

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

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

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.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMSNMPSETREQUEST HOST="158.223.257.115" NAME="1.3.6.1.2.1.1.4.0" COMMUNITY="public" VALUE="text" />