SNMP Set

Declaration

<AMSNMPSETREQUEST HOST="text" NAME="text" COMMUNITY="text" TIMEOUT="number" TIMEOUTMEASURE="text (options)" BROADCASTDELAY="number" VALUE="text" RESULTDATASET="text (dataset name)" />

See Also

SNMP Get | SNMP Get Next | SNMP Set | SNMP Walk | SNMP Send Trap | SNMP Walk | MSMQ (Microsoft Message Queuing) | Microsoft SharePoint | AS2 (Applicability Statement 2) | Amazon EC2 (Elastic Compute Cloud) | Amazon RDS (Relational Database Service) | Amazon S3 (Simple Storage Service) | Amazon SimpleDB | Amazon SQS (Simple Queue Service)

Description

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

Simple Network Management Protocol (SNMP) is a widely used protocol designed to facilitate the management of networked devices from a central location. Designed originally for the management of devices such as routers and switches, its usage has grown rapidly to encompass the monitoring of nearly any electronic device one can think of.

IMPORTANT: Use of AutoMate's SNMP actions require a fundamental understanding of the SNMP architecture and its major elements, such as Managers, Agents, MIBs, and PDUs.  

Practical Usage

Can be used to set the value of a SNMP variable on a SNMP capable agent such as a router.

Parameters

General Properties

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.

Variable Name

Text

Yes

(Empty)

  1. NAME="1.3.6.1.2.1.1.1.0"

  2. NAME="system.sysDescr.0"

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 variable.

Community

Text

Yes

Public

COMMUNITY="NetAuto"

The SNMP community.

Variable Syntax

Text (options)

No

integer

SYNTAX="ipaddress"

Specifies the type of data that will be set in the variable value parameter. The available options are:

  • integer (default): Specifies that value is an integer (number)

  • octetstring: Specifies that value is an octet string

  • objectid: Specifies that the value is an object identifier

  • null: Specifies that the value is a null value

  • ipaddress: Specifies that the value is an IP Address

  • counter32: Specifies that the value is a 32-bit counter

  • gauge32: Specifies that the value is a 32-bit gauge

  • timeticks: Specifies that the value is a time tick

  • opaque: Specifies that the value is opaque

  • counter64: Specifies that the value is a 64-but counter

  • unsignedinteger32: Specifies that the value is a 32-bit unsigned integer

Variable Value

Text

Yes

(Empty)

VALUE="the data"

The new value to set.

Advanced Properties

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 time out error. The default is 30 seconds.

Timeout measure

Text (options)

Yes

seconds

TIMEOUTMEASURE="minutes"

The time measurement that corresponds to the time out measure value. The available options are:

  • milliseconds

  • seconds (default)

  • minutes

  • hours

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:

  • milliseconds

  • seconds (default)

  • minutes

  • hours

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:

  • SNMPv1 (default)

  • SNMPv2c

  • SNMPv3

Remote port

Number

No

161

REMOTEPORT="555"

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

Data Properties

Property

Type

Required

Default

Markup

Description

Create and populate dataset (optional)

Text

No

(Empty)

RESULTDATASET="myData"

The name of the dataset that should be created and populated with the results of the request.

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties lets you instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables & Functions

A percent sign is used as a special character in AutoMate to indicate the beginning and end of an expression. This allows variables, functions and other expressions to be entered in any text parameter of a task's properties. For example: %1+1% inside a task will resolve to 2 at runtime. A more elaborate example is %FileDateTime(myFile)% which results to the date/time of myFile. To help construct expressions, you can open Expression Builder by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on functions

More on extended functions
More on the expression builder

Example

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

 

Description: Send SNMP Set message to "192.168.0.465" for variable "snmpSet" (new value:"192.168.0.851").  Syntax of variable is "ipaddress".  Community is "theCommunity2".  Use remote port 841.  Wait 20 seconds for responds after issuing a broadcast request.  

 

<AMSNMPSETREQUEST HOST="192.168.0.465" NAME="snmpSet" COMMUNITY="theCommunity2" REMOTEPORT="841" BROADCASTDELAY="20" VALUE="192.168.0.851" SYNTAX="ipaddress" />

 

↑ Top of Page