ScotlandPHP 2016

snmpset

(PHP 4, PHP 5, PHP 7)

snmpsetSet the value of an SNMP object

Descrição

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

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

Parâmetros

host

The hostname of the SNMP agent (server).

community

The write community.

object_id

The SNMP object id.

type

O MIB define o tipo de cada id de objeto. Pode ser um caractere da lista abaixo.

types
=Lista de MIBs id
iINTEGER
uINTEGER
sSTRING
xHEX STRING
dDECIMAL STRING
nNULLOBJ
oOBJID
tTIMETICKS
aIPADDRESS
bBITS

Se OPAQUE_SPECIAL_TYPES foi definido durante a compilação da biblioteca SNMP, os seguintes também são válidos:

types
Uunsigned int64
Isigned int64
Ffloat
Ddouble

A maioria dos tipos tem correspondentes óbvios com tipos ASN.1. 's', 'x', 'd' e 'b' são modos diferentes de especificar um valor OCTET STRING e 'u' também é utilizado para manipular valores Gauge32.

Se MIB-Files foi carregado na árvore MIB com "snmp_read_mib" ou por especificá-lo na configuração do libsnmp, '=' pode ser utilizado como parâmetro type para todos os identificadores de objeto que podem ser lidos automaticamente do MIB.

Note que há duas maneiras de configurar o tipo BITS, assim: "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

  • Utilizando "b" e uma lista de bits. Esse método não é recomendado desde que requisições GET para o mesmo OID pode retornar algo com 0xF8.
  • Utilizando "x" e um número hex sem (!) o prefixo "0x".

Veja a seção de exemplo para mais detalhes.

value

The new value.

timeout

The number of microseconds until the first timeout.

retries

The number of times to retry if timeouts occur.

Valor Retornado

Retorna TRUE em caso de sucesso ou FALSE em caso de falha.

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

Exemplos

Exemplo #1 Using snmpset()

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

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

Veja Também

add a note add a note

User Contributed Notes 4 notes

up
1
slawrance at technologist dot com
17 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
deivis dot jakstas at gmail dot com
9 years ago
If you setting hex values correct format is:
snmpset($source_ip,$community,"$oid","x","10 10 10 10");
up
-2
ch at lathspell dot de
6 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
9 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