snmpset

(PHP 4, PHP 5, PHP 7, PHP 8)

snmpsetSetzt den Wert eines SNMP-Objekts

Beschreibung

snmpset(
    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. Dieser muss als ein einzelnes Zeichen aus der folgenden Liste angegeben werden.

Typen
=Der Typ wird aus der MIB übernommen
iINTEGER
uINTEGER
sSTRING
xHEX STRING
dDECIMAL STRING
nNULLOBJ
oOBJID
tTIMETICKS
aIPADDRESS
bBITS

Wenn OPAQUE_SPECIAL_TYPES beim Kompilieren der SNMP-Bibliothek definiert wurde, sind auch die folgenden Angaben gültig:

Typen
Uunsigned int64
Isigned int64
Ffloat
Ddouble

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');
?>

Siehe auch

add a note add a note

User Contributed Notes 4 notes

up
0
deivis dot jakstas at gmail dot com
17 years ago
If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");
up
0
slawrance at technologist dot com
25 years ago
The "type" parameter must be one of the following, depending on the type of variable to set on the SNMP host:

i    INTEGER
u    unsigned INTEGER
t    TIMETICKS
a    IPADDRESS
o    OBJID
s    STRING
x    HEX STRING
d    DECIMAL STRING
n    NULLOBJ
b    BITS

If 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

As an example, using "i" would set an integer, and "s" would set a string.  If the SNMP host rejects the data type, you might get the following message: "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length."

If you specify an unknown or invalid OID, you might get a "Could not add variable" message.  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 ports 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"
up
-1
ch at lathspell dot de
14 years ago
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)}

1. Using type "b" and a list of bit numbers like:
  snmpset('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
with the disadvantage that the success is not easily verifyable as an snmpget() 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');
up
-5
tridman
17 years ago
If you have importet the MIB-Files into the MIB Tree with "snmp_read_mib" you may use '=' as the "type" parameter.
In this case the type will also be taken from the loaded mib file. (Octest strings will be interpreted like strings though)
Comes in handy for a more dynamic use of snmpset.
To Top