snmp3_set
(PHP 4, PHP 5, PHP 7, PHP 8)
snmp3_set — Set the value of an SNMP object
Beschreibung
string
$hostname
,string
$security_name
,string
$security_level
,string
$auth_protocol
,string
$auth_passphrase
,string
$privacy_protocol
,string
$privacy_passphrase
,array|string
$object_id
,array|string
$type
,array|string
$value
,int
$timeout
= -1,int
$retries
= -1): bool
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.
Parameter-Liste
-
hostname
-
The hostname of the SNMP agent (server).
-
security_name
-
the security name, usually some kind of username
-
security_level
-
the security level (noAuthNoPriv|authNoPriv|authPriv)
-
auth_protocol
-
the authentication protocol (MD5 or SHA)
-
auth_passphrase
-
the authentication pass phrase
-
privacy_protocol
-
the privacy protocol (DES or AES)
-
privacy_passphrase
-
the privacy pass phrase
-
object_id
-
The SNMP object id.
-
type
-
Die MIB definiert den Typ jeder Objekt-ID. Sie muss als ein einzelnes Zeichen aus der folgenden Liste angegeben werden.
types = Der Typ wird aus der MIB übernommen i INTEGER u INTEGER s STRING x HEX STRING d DECIMAL STRING n NULLOBJ o OBJID t TIMETICKS a IPADDRESS b BITS Wenn
OPAQUE_SPECIAL_TYPES
beim Kompilieren der SNMP-Bibliothek definiert wurde, sind auch die folgenden gültig:types U unsigned int64 I signed int64 F float D double In den meisten Fällen wird der entsprechende ASN.1-Typ verwendet. 's', 'x', 'd' und 'b' sind alles verschiedene Arten, einen OCTET STRING-Wert anzugeben, und der vorzeichenlose Typ 'u' wird auch für den Umgang mit Gauge32-Werten verwendet.
Wenn die MIB-Dateien mit "snmp_read_mib" in den MIB-Baum geladen oder in der libsnmp-Konfiguration angegeben werden, kann '=' als als Parameter
type
für alle Objekt-IDs verwendet werden, da der Typ dann automatisch aus der MIB gelesen werden kann.Zu beachten ist, dass es zwei Möglichkeiten gibt, eine Variable vom Typ BITS zu setzen, z. B. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
- Die Verwendung des Typs "b" und eine Liste von Bitnummern. Diese Methode wird nicht empfohlen, da eine GET-Anfrage für dieselbe OID z. B. 0xF8 zurückgeben würde.
- Die Verwendung des Typs "x" und eine Hex-Zahl, aber ohne(!) das übliche Präfix "0x".
Siehe den Abschnitt Beispiele für weitere Details.
-
value
-
The new value
-
timeout
-
The number of microseconds until the first timeout.
-
retries
-
The number of times to retry if timeouts occur.
Rückgabewerte
Gibt bei Erfolg true
zurück. Bei einem Fehler wird false
zurückgegeben.
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".
Beispiele
Beispiel #1 Using snmp3_set()
<?php
snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>
Beispiel #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');
?>