snmpset

(PHP 4, PHP 5, PHP 7)

snmpsetSet the value of an SNMP object

Opis

snmpset ( string $host , string $community , string $object_id , string $type , mixed $value [, int $timeout = 1000000 [, int $retries = 5 ]] ) : bool

snmpset() is used to set the value of an SNMP object specified by the object_id.

Parametry

host

The hostname of the SNMP agent (server).

community

The write community.

object_id

The SNMP object id.

type

MIB definiuje typ każdego id obiektu. Musi być podany jako pojedynczy znak z poniższej listy

types
=Typ pobrany z MIB
iINTEGER
uINTEGER
sSTRING
xHEX STRING
dDECIMAL STRING
nNULLOBJ
oOBJID
tTIMETICKS
aIPADDRESS
bBITS

Jeśli przy kompilacji biblioteki SNMP zdefiniowana została stała OPAQUE_SPECIAL_TYPES, dostępne są także poniższe wartości:

types
Uunsigned int64
Isigned int64
Ffloat
Ddouble

Większość z nich będzie w sposób oczywisty odpowiadać typowi ASN.1 's', 'x', 'd' i 'b' są różnymi sposobami na określenie wartości OCTET STRING, a typ 'u' - bez określania znaku - stosowany jest także dla obsługi wartości Gauge32.

Jeśli pliki MIB są ładowane do drzewa MIB poprzez "snmp_read_mib" lub przez podanie ich w konfiguracji libsnmp, '=' może być stosowane jako wartość parametru type dla wszystkich id obiektów, jako że typ może być automatycznie odczytany z MIB.

Istnieją dwa sposoby aby ustawić wartość zmiennej typu BITS, przykładowo "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

  • Stosując typ "b" i listę wartości bitowych. Ta metoda nie jest zalecana ponieważ zapytanie GET dla dla tego samego OID zwróciłoby np. 0xF8.
  • Stosując typ "x" i wartość szesnastkową bez zwyczajowego prefiksu "0x".

Zobacz też sekcję z przykładami.

value

The new value.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

Zwracane wartości

Zwraca TRUE w przypadku powodzenia, FALSE w przypadku błędu.

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".

Przykłady

Przykład #1 Using snmpset()

<?php
  snmpset
("localhost""public""IF-MIB::ifAlias.3""s""foo");
?>

Przykład #2 Using snmpset() for setting BITS SNMP object id

<?php
  snmpset
("localhost""public"'FOO-MIB::bar.42''b''0 1 2 3 4');
// or
  
snmpset("localhost""public"'FOO-MIB::bar.42''x''F0');
?>

Zobacz też:

add a note add a note

User Contributed Notes 4 notes

up
0
deivis dot jakstas at gmail dot com
13 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
21 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
10 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
13 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