snmpset

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

    snmpset — Set the value of an SNMP object

    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() is used to set the value of an SNMP object specified by the object_id.

    Parámetros

    hostname

    The hostname of the SNMP agent (server).

    community

    The write community.

    object_id

    The SNMP object id.

    type

    MIB define el tipo de cada identificador de objeto. Debe indicarse con un único carácter de la siguiente lista.

    tipos
    =Tipo adquirido a partir de MIB
    iINTEGER
    uINTEGER
    sSTRING
    xHEX STRING
    dDECIMAL STRING
    nNULLOBJ
    oOBJID
    tTIMETICKS
    aIPADDRESS
    bBITS

    Si se definió OPAQUE_SPECIAL_TYPES al compilar la biblioteca SNMP, los siguientes valores serán también válidos:

    tipos
    Uint64 sin signo
    Iint64 con signo
    Ffloat
    Ddouble

    La mayoría, utilizarán su correspondiente tipo ASN.1. 's', 'x', 'd' y 'b' son diferentes formas de especificar un valor de OCTET STRING, y el tipo sin signo 'u' se usa también para manejar valores Gauge32.

    Si se cargan los ficheros MIB en el árbol MIB con "snmp_read_mib" o con la configuración de libsnmp, se puede usar '=' como parámetro type para todos los id de objetos, ya que se podrá leer automáticamente el tipo a partir del MIB.

    Tenga presente que hay dos formas de asigar a una variable los tipos BITS, como por ejemplo. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

    • Usando el tipo "b" y una lista numérica de bits. No se recomienda usar este método, ya que una consulta GET para un mismo OID devolvería, por ejemplo 0xF8.
    • Usando el tipo "x" y un número hexadecimal, pero si el prefijo "0x".

    Revise el apartado de ejemplos para más detalles.

    value

    The new value.

    timeout

    The number of microseconds until the first timeout.

    retries

    The number of times to retry if timeouts occur.

    Valores devueltos

    Devuelve true en caso de éxito o false en caso de error.

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

    Ejemplos

    Ejemplo #1 Using snmpset()

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

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

    Ver también

    Improve This Page

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

    User Contributed Notes 3 notes

    up
    0
    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');
    up
    0
    deivis dot jakstas at gmail dot com
    17 years ago
    If you setting hex values correct format is:
    snmpset($source_ip,$community,"$oid","x","10 10 10 10");
    up
    0
    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"
    ＋add a note
    To Top