snmpset

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

snmpset — Define el valor de un objeto SNMP

Descripción

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

snmpset() se utiliza para definir el valor del objeto SNMP especificado por object_id.

Parámetros

hostname

El nombre de host del agente SNMP (servidor).

community

La comunidad de lectura.

object_id

El identificador del objeto SNMP.

type

El MIB define el tipo de cada identificador de objeto. Debe ser especificado como un carácter simple de la lista siguiente.

**tipos**
=	El tipo es recuperado desde el MIB
i	INTEGER
u	INTEGER
s	STRING
x	HEX STRING
d	DECIMAL STRING
n	NULLOBJ
o	OBJID
t	TIMETICKS
a	IPADDRESS
b	BITS

Si la constante OPAQUE_SPECIAL_TYPES ha sido definida durante la compilación de la biblioteca SNMP, los caracteres siguientes también estarán disponibles:

**tipos**
U	int64 sin signo
I	int64 con signo
F	float
D	double

La mayoría de estos valores utilizan el tipo ASN.1 correspondiente. 's', 'x', 'd' y 'b' son todas formas diferentes de especificar el valor OCTET STRING y el tipo sin signo 'u' también es utilizado para manejar los valores Gauge32.

Si los archivos MIB son cargados en el árbol MIB con "snmp_read_mib" o especificándolos en la configuración de libsnmp, '=' podrá ser utilizado como parámetro de tipo para todos los identificadores de objetos, ya que el tipo puede ser leído automáticamente desde el MIB.

Nota que hay 2 formas de definir una variable de tipo BITS como i.e. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

Utilizando el tipo "b" y una lista de octetos. Este método no es recomendado ya que la petición GET para un mismo OID retornará i.e. 0xF8.
Utilizando el tipo "x" y un número hexadecimal pero sin(!) el prefijo usual "0x".

Consúltese la sección sobre ejemplos para más detalles.

value

El nuevo valor.

timeout

El número de microsegundos desde el primer timeout.

retries

El número de intentos antes de alcanzar el tiempo máximo de espera.

Valores devueltos

Esta función retorna true en caso de éxito o false si ocurre un error.

Si el host SNMP rechaza el tipo de datos, se mostrará una alerta de tipo E_WARNING como "Warning: Error in packet. Reason: (badValue) The value given has the wrong type or length." Si se especifica un OID desconocido o inválido, el contenido de la alerta será probablemente "Could not add variable".

Ejemplos

Ejemplo #1 Ejemplo con snmpset()

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

Ejemplo #2 Ejemplo con snmpset() para configurar el identificador del objeto SNMP BITS

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

Ver también

snmpget() - Recibe un objeto SNMP

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 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 ¶

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

＋add a note