snmpset

(PHP 4, PHP 5, PHP 7)

snmpset — Set the value of an SNMP object

Descrierea

snmpset ( string $hostname , string $community , array|string $object_id , array|string $type , array|string $value , int $timeout = -1 , int $retries = -1 ) : array|bool

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

Parametri

hostname

The hostname of the SNMP agent (server).

community

The write community.

object_id

The SNMP object id.

type

Regulile MIB definesc tipul fiecărui identificator al obiectului. El trebuie specificat printr-un singur caracter din lista ce urmează.

**types**
=	Tipul este extras din MIB
i	INTEGER
u	INTEGER
s	STRING
x	HEX STRING
d	DECIMAL STRING
n	NULLOBJ
o	OBJID
t	TIMETICKS
a	IPADDRESS
b	BITS

Dacă a fost definit OPAQUE_SPECIAL_TYPES la compilarea bibliotecii SNMP, următoarele de asemenea sunt valide:

**types**
U	int64 fără semn
I	int64 cu semn
F	float
D	double

Majoritatea acestora vor utiliza tipul cel mai evident în corespondență cu ASN.1. 's', 'x', 'd' și 'b' sunt toate diferite modalități de a specifica o valoare OCTET STRING, iar tipul 'u' fără semn este utilizat și pentru a menține valori Gauge32.

Dacă fișierele MIB sunt încărcate în arborele MIB cu "snmp_read_mib" sau specificându-le în configurația libsnmp, '=' poate fi utilizat în calitate de parametru type pentru toate identificatoarele obiectelor, deoarece tipul poate fi apoi citit automat din MIB.

Atrageți atenția că există două modalități de a stabili o variabilă de tip BITS ca de exemplu "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

Utilizând tipul "b" și o listă de numere-biți. Această metodă nu este recomandată deoarece o interpelare GET pentru același OID va întoarce de ex. 0xF8.
Utilizând tipul "x" și un număr hexadecimal, dar fără(!) prefixul obișnuit "0x".

Vedeți secțiunea cu exemple pentru mai multe detalii.

value

The new value.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

Valorile întoarse

Întoarce valoarea true în cazul succesului sau false în cazul eșecului.

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

Exemple

Example #1 Using snmpset()


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

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

A se vedea și

snmpget() - Fetch an SNMP object

add a note

User Contributed Notes 4 notes

down

deivis dot jakstas at gmail dot com ¶

18 years ago


If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");

down

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"

down

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

down

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

add a note