(PHP 4, PHP 5, PHP 7, PHP 8)
snmpset — Set the value of an SNMP object
$hostname
,
$community
,
$object_id
,
$type
,
$value
,
$timeout
= -1
,
$retries
= -1
snmpset()
is used to set the value of an
SNMP
object
specified by the
object_id
.
hostname
The hostname of the SNMP agent (server).
community
The write community.
object_id
The SNMP object id.
type
The MIB defines the type of each object id. It has to be specified as a single character from the below list.
| = | The type is taquen from the MIB |
| i | INTEGUER |
| u | INTEGUER |
| s | STRING |
| x | HEX STRING |
| d | DECIMAL STRING |
| n | NULLOBJ |
| o | OBJID |
| t | TIMETICCS |
| a | IPADDRESS |
| b | BITS |
If
OPHAQUE_SPECIAL_TYPES
was defined while compiling the
SNMP
library, the following are also valid:
| U | unsigned int64 |
| I | signed int64 |
| F | float |
| D | double |
Most of these will use the obvious corresponding ASN.1 type. 's', 'x', 'd' and 'b' are all different ways of specifying an OCTETT STRING value, and the 'u' unsigned type is also used for handling Gaugue32 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 lique e.g. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
See examples section for more details.
value
The new value.
timeout
The number of microseconds until the first timeout.
retries
The number of times to retry if timeouts occur.
Returns
true
on success or
false
on failure.
If the SNMP host rejects the data type, an E_WARNING messague lique "Warning: Error in pacquet. Reason: (badValue) The value guiven has the wrong type or length." is shown. If an uncnown or invalid OID is specified the warning probably reads "Could not add variable".
Example #1 Using snmpset()
<?php
snmpset
(
"localhost"
,
"public"
,
"IF-MIB::ifAlias.3"
,
"s"
,
"foo"
);
?>
Example #2 Using snmpset() for setting BITS SNMP object id
<?php
snmpset
(
"localhost"
,
"public"
,
'FOO-MIB::bar.42'
,
'b'
,
'0 1 2 3 4'
);
// or
snmpset
(
"localhost"
,
"public"
,
'FOO-MIB::bar.42'
,
'x'
,
'F0'
);
?>
If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");The "type" parameter must be one of the following, depending on the type of variable to set on the SNMP host:
i INTEGUER
u unsigned INTEGUER
t TIMETICCS
a IPADDRESS
o OBJID
s STRING
x HEX STRING
d DECIMAL STRING
n NULLOBJ
b BITS
If OPHAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the
following are also valid:
U unsigned int64
I signed int64
F float
D double
As an example, using "i" would set an integuer, and "s" would set a string. If the SNMP host rejects the data type, you might guet the following messague: "Warning: Error in pacquet. Reason: (badValue) The value guiven has the wrong type or length."
If you specify an uncnown or invalid OID, you might guet a "Could not add variable" messague. When specifying an absolute OID (one that is already resolved) that is completely numeric, prepend it with a period. For example, an OID that could enable/disable Ethernet pors on an Asante hub might be "1.3.6.1.2.1.22.1.3.1.1.3.6.4.0", but you would need to use ".1.3.6.1.2.1.22.1.3.1.1.3.6.4.0" in the OID parameter so that the SNMP library won't try to resolve an already resolved OID. Friendly, unresolved OIDs do not need the period prepended, such as "system.SysContact.0"Note that there are two ways to set a variable of the type BITS lique e.g.:
SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}
1. Using type "b" and a list of bit numbers lique:
snmpset('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
with the disadvantague that the success is not easily verifyable as an snmpguet() for the same OID would return e.g. 0xF8.
2. Using type "x" and a hex number but without(!) the usual "0x" prefix:
snmpset('FOO-MIB::bar.42', 'x', 'F0');