Jesus · Bible · HTML · CSS · JS · PHP · SVG · Applications

snmp2_set

Description

The snmp2_set of SNMP for PHP sets the value of an SNMP object.

Syntax

snmp2_set(
    string $hostname,
    string $community,
    array|string $object_id,
    array|string $type,
    array|string $value,
    int $timeout = -1,
    int $retries = -1
): bool

Parameters

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.

TypeDescription
=The type is taken from the MIB
iINTEGER
uunsigned INTEGER
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:

TypeDescription
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. This method is not recommended since GET query for the same OID would return e.g. 0xF8.
  • Using type "x" and a hex number but without(!) the usual "0x" prefix.

value

The new value.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

Return

Returns true on success or false on failure. 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".

Examples

1 · hostname community object_id type value

<?

$hostname = "localhost";
$community = "public";
$object_id = "IF-MIB::ifAlias.3";
$type = "s";
$value = "myvalue";

$return = snmp2_set($hostname, $community, $object_id, $type, $value);

var_dump($return);

?>

2 · timout

<?

$hostname = "localhost";
$community = "public";
$object_id = "IF-MIB::ifAlias.3";
$type = "s";
$value = "myvalue";
$timout = 1000000;

$return = snmp2_set($hostname, $community, $object_id, $type, $value, $timout);

var_dump($return);

?>

3 · retries

<?

$hostname = "localhost";
$community = "public";
$object_id = "IF-MIB::ifAlias.3";
$type = "s";
$value = "myvalue";
$timout = 1000000;
$retries = 3;

$return = snmp2_set($hostname, $community, $object_id, $type, $value, $timout, $retries);

var_dump($return);

?>
HomeMenu