(PHP 4, PHP 5, PHP 7, PHP 8)
snmp3_set — Set the value of an SNMP object
$hostname,$security_name,$security_level,$auth_protocol,$auth_passphrase,$privacy_protocol,$privacy_passphrase,$object_id,$type,$value,$timeout = -1,$retries = -1
snmp3_set() is used to set the value of an SNMP object
specified by the object_id.
Even if the security level does not use an auth or priv protocol/password valid values have to be specified.
hostnamesecurity_namesecurity_levelauth_protocolauth_passphraseprivacy_protocolprivacy_passphraseobject_idtype| = | The type is taken from the MIB |
| i | INTEGER |
| u | INTEGER |
| s | STRING |
| x | HEX STRING |
| d | DECIMAL STRING |
| n | NULLOBJ |
| o | OBJID |
| t | TIMETICKS |
| a | IPADDRESS |
| b | BITS |
OPAQUE_SPECIAL_TYPES was defined while compiling the SNMP library, the following are also valid:
| U | unsigned int64 |
| I | signed int64 |
| F | float |
| D | double |
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)}":
valuetimeoutretries
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".
| Version | Description |
|---|---|
| 8.5.0 | Now throws a ValueError when the hostname length is equal to or greater than 128 bytes, when the port is negative or greater than 65535, or when the timeout or retries values are lower than -1 or too large. |
Example #1 Using snmp3_set()
<?php
snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>Example #2 Using snmp3_set() for setting BITS SNMP object id
<?php
snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'x', 'F0');
?>