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
iINTEGER
uINTEGER
sSTRING
xHEX STRING
dDECIMAL STRING
nNULLOBJ
oOBJID
tTIMETICKS
aIPADDRESS
bBITS

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
Uint64 sin signo
Iint64 con signo
Ffloat
Ddouble

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