diff --git a/reference/snmp/functions/snmpset.xml b/reference/snmp/functions/snmpset.xml index 674eff3b4c..7d728624bb 100644 --- a/reference/snmp/functions/snmpset.xml +++ b/reference/snmp/functions/snmpset.xml @@ -3,13 +3,14 @@ snmpset - Set an SNMP object + Set the value of an SNMP object + &reftitle.description; boolsnmpset - stringhostname + stringhost stringcommunity stringobject_id stringtype @@ -17,23 +18,23 @@ inttimeout intretries - + snmpset is used to set the value of an SNMP object - specified by the object_id. + specified by the object_id. - + - + &reftitle.parameters; - hostname + host - The SNMP agent. + The hostname of the SNMP agent (server). @@ -49,7 +50,7 @@ object_id - The SNMP object. + The SNMP object id. @@ -57,13 +58,70 @@ type + The MIB defines the type of each object id. It has to be specified as a single character from the below list. + + types + + + =The type is taken from the MIB + iINTEGER + uINTEGER + sSTRING + xHEX STRING + dDECIMAL STRING + nNULLOBJ + oOBJID + tTIMETICKS + aIPADDRESS + bBITS + + +
+ + If OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid: + + + types + + + Uunsigned int64 + Isigned int64 + Ffloat + Ddouble + + +
+ + Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTET STRING value, and + the 'u' unsigned type is also used for handling Gauge32 values. + + + If the MIB-Files are loaded by into the MIB Tree with "snmp_read_mib" or by specifying it in the libsnmp config, '=' may be used as the type parameter + for all object ids as the type can then be automatically read from the MIB. + + + Note that there are two ways to set a variable of the type BITS like e.g. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}" + + + + + Using type "b" and a list of bit numbers like: snmpset('FOO-MIB::bar.42', 'b', '0 1 2 3 4'); with the disadvantage that the success is not easily verifyable as an snmpget() for the same OID would return e.g. 0xF8. + + + + + Using type "x" and a hex number but without(!) the usual "0x" prefix: snmpset('FOO-MIB::bar.42', 'x', 'F0'); + + +
value + The new value. @@ -79,20 +137,41 @@ retries + The number of retries in case of timeouts.
- + &reftitle.returnvalues; &return.success; + + If the SNMP host rejects the data type, an E_WARNING message like "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." is shown. + If an unknown or invalid OID is specified the warning probably reads "Could not add variable". + - + + + &reftitle.examples; + + + Using <function>snmpgetnext</function> + + + ]]> + + + + + &reftitle.seealso; @@ -101,7 +180,7 @@ - +
+