snmp3_set

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

snmp3_setDefine el valor de un objeto SNMP

Descripción

function snmp3_set(
    string $hostname,
    string $security_name,
    string $security_level,
    string $auth_protocol,
    string $auth_passphrase,
    string $privacy_protocol,
    string $privacy_passphrase,
    array|string $object_id,
    array|string $type,
    array|string $value,
    int $timeout = -1,
    int $retries = -1
): bool

snmp3_set() se utiliza para definir el valor de un objeto SNMP especificado por el parámetro object_id.

Los argumentos de autenticación y de privacidad deben pasarse siempre, pero sus valores se ignoran cuando security_level no los utiliza.

Parámetros

hostname

El nombre del host del agente SNMP (servidor).

security_name

El nombre de seguridad, habitualmente algún tipo de nombre de usuario.

security_level

El nivel de seguridad: "noAuthNoPriv", "authNoPriv" o "authPriv".

auth_protocol

El protocolo de autenticación: "MD5", "SHA", "SHA256" o "SHA512".

auth_passphrase

La frase de contraseña de autenticación.

privacy_protocol

El protocolo de privacidad: "DES" o "AES", aceptado también como "AES128". "AES192", "AES192C", "AES256" y "AES256C" se aceptan cuando la biblioteca Net-SNMP los soporta.

privacy_passphrase

La frase de contraseña de privacidad.

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 ficheros MIB se cargan en el árbol MIB con "snmp_read_mib" o especificándolos en la configuración de libsnmp, se puede usar '=' como el parámetro type para todos los identificadores de objeto, ya que entonces el tipo se puede leer 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 milisegundos antes del primer tiempo límite.

retries

El número de intentos en caso de que se alcance el tiempo límite.

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 muestra 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, la alerta será probablemente "Could not add variable".

Historial de cambios

Versión Descripción
8.6.0 El protocolo de privacidad ahora acepta "AES192", "AES192C", "AES256" y "AES256C" cuando la biblioteca Net-SNMP lo soporta.
8.5.0 Ahora lanza un ValueError cuando la longitud del nombre de host es igual o mayor a 128 bytes, cuando el puerto es negativo o mayor que 65535, o cuando los valores de timeout o reintentos son menores a -1 o demasiado grandes.
8.1.0 El protocolo de autenticación ahora acepta "SHA256" y "SHA512" cuando la biblioteca Net-SNMP lo soporta.

Ejemplos

Ejemplo #1 Ejemplo con snmp3_set()

<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>

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

<?php
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// or
  snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'FOO-MIB::bar.42', 'x', 'F0');
?>
add a note

User Contributed Notes

There are no user contributed notes for this page.