snmpset
(PHP 4, PHP 5, PHP 7, PHP 8)
snmpset — Setzt den Wert eines SNMP-Objekts
Beschreibung
string
$hostname
,string
$community
,array|string
$object_id
,array|string
$type
,array|string
$value
,int
$timeout
= -1,int
$retries
= -1): bool
Die Funktion snmpset() wird benutzt, um den Wert eines
SNMP-Objekts zu setzen, das mit
object_id
angegeben wird.
Parameter-Liste
-
hostname
-
Der Hostname des SNMP-Agenten (Server).
-
community
-
Die "write community".
-
object_id
-
Die SNMP-Objektkennung.
-
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
-
Der neue Wert.
-
timeout
-
Die Anzahl der Mikrosekunden bis zum ersten Timeout.
-
retries
-
Die Anzahl der Wiederholungsversuche, wenn Timeouts auftreten.
Rückgabewerte
Gibt bei Erfolg true
zurück. Bei einem Fehler wird false
zurückgegeben.
Wenn der SNMP-Host den Datentyp zurückweist, wird eine E_WARNING-Meldung in der Art "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." ausgegeben. Wenn eine unbekannte oder ungültige OID angegeben wird, lautet die Warnung wahrscheinlich "Could not add variable".
Beispiele
Beispiel #1 Verwendung von snmpset()
<?php
snmpset("localhost", "public", "IF-MIB::ifAlias.3", "s", "foo");
?>
Beispiel #2 Verwendung von snmpset() zum Setzen von BITS-SNMP-Objektkennungen
<?php
snmpset("localhost", "public", 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
snmpset("localhost", "public", 'FOO-MIB::bar.42', 'x', 'F0');
?>