SNMP Set Action

SNMP Set

Issues a SNMP message to a SNMP agent in order to alter the value of a variable. Can be used to set the value of a SNMP variable on a SNMP capable agent such as a router.

Use of the SNMP actions require a fundamental comprehension of SNMP, its required protocol data units (PDU) and other related terms, such as NMS or MIB.

Declaration

Example

General Tab

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)	a)NAME="1.3.6.1.2.1.1.1.0" b)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 a 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.

Attributes Tab

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 timeout error. The default is 30 seconds.
Timeout measure	Text (options)	Yes	seconds	TIMEOUTMEASURE="minutes"	The time measurement that corresponds to the timeout 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 Tab

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 Tab

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

Standard Error Handling Options

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

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.