Edit Report a Bug

    SNMP::set

    (PHP 5 >= 5.4.0, PHP 7, PHP 8)

    SNMP::set — Set the value of an SNMP object

    Beschreibung

    public SNMP::set(array|string $objectId, array|string $type, array|string $value): bool

    Requests remote SNMP agent setting the value of one or more SNMP objects specified by the objectId.

    Parameter-Liste

    If objectId is string, both type and value must be string too. If objectId is array value must be equal-sized array containing corresponding values, type may be either string (it's value will be used for all objectId-value pairs) or equal-sized array with per-OID value. When any other parameters' combinations are used, a number of E_WARNING messages may be shown with detailed description.

    objectId

    The SNMP object id

    When count of OIDs in object_id array is greater than max_oids object property set method will have to use multiple queries to perform requested value updates. In this case type and value checks are made per-chunk so second or subsequent requests may fail due to wrong type or value for OID requested. To mark this a warning is raised when count of OIDs in object_id array is greater than max_oids.

    type

    Die MIB definiert den Typ jeder Objekt-ID. Dieser muss als ein einzelnes Zeichen aus der folgenden Liste angegeben werden.

    Typen
    =Der Typ wird aus der MIB übernommen
    iINTEGER
    uINTEGER
    sSTRING
    xHEX STRING
    dDECIMAL STRING
    nNULLOBJ
    oOBJID
    tTIMETICKS
    aIPADDRESS
    bBITS

    Wenn OPAQUE_SPECIAL_TYPES beim Kompilieren der SNMP-Bibliothek definiert wurde, sind auch die folgenden Angaben gültig:

    Typen
    Uunsigned int64
    Isigned int64
    Ffloat
    Ddouble

    In den meisten Fällen wird der entsprechende ASN.1-Typ verwendet. 's', 'x', 'd' und 'b' sind alles verschiedene Arten, einen OCTET STRING-Wert anzugeben, und der vorzeichenlose Typ 'u' wird auch für den Umgang mit Gauge32-Werten verwendet.

    Wenn die MIB-Dateien mit "snmp_read_mib" in den MIB-Baum geladen oder in der libsnmp-Konfiguration angegeben werden, kann '=' als als Parameter type für alle Objekt-IDs verwendet werden, da der Typ dann automatisch aus der MIB gelesen werden kann.

    Zu beachten ist, dass es zwei Möglichkeiten gibt, eine Variable vom Typ BITS zu setzen, z. B. "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":

    • Die Verwendung des Typs "b" und eine Liste von Bitnummern. Diese Methode wird nicht empfohlen, da eine GET-Anfrage für dieselbe OID z. B. 0xF8 zurückgeben würde.
    • Die Verwendung des Typs "x" und eine Hex-Zahl, aber ohne(!) das übliche Präfix "0x".

    Siehe den Abschnitt Beispiele für weitere Details.

    value

    The new value.

    Rückgabewerte

    Gibt bei Erfolg true zurück. Bei einem Fehler wird false zurückgegeben.

    Fehler/Exceptions

    Diese Methode löst standardmäßig keine Exceptions aus. Um das Auslösen einer SNMPException-Exception beim Auftreten bestimmter Bibliotheksfehler zu aktivieren, muss muss der SNMP-Klassenparameter exceptions_enabled auf einen entsprechenden Wert gesetzt werden. Siehe SNMP::$exceptions_enabled explanation für weitere Details.

    Beispiele

    Beispiel #1 Set single SNMP object id

    <?php
    $session     = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
    $session->set('SNMPv2-MIB::sysContact.0', 's', "Nobody");
    ?>

    Beispiel #2 Set multiple values using single SNMP::set() call

    <?php
    $session     = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
    $session->set(array('SNMPv2-MIB::sysContact.0', 'SNMPv2-MIB::sysLocation.0'), array('s', 's'), array("Nobody", "Nowhere"));
    // or
    $session->set(array('SNMPv2-MIB::sysContact.0', 'SNMPv2-MIB::sysLocation.0'), 's', array("Nobody", "Nowhere"));
    ?>

    Beispiel #3 Using SNMP::set() for setting BITS SNMP object id

    <?php
    $session     = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
    $session->set('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
    // or
    $session->set('FOO-MIB::bar.42', 'x', 'F0');
    ?>

    Siehe auch

    add a note add a note

    User Contributed Notes

    There are no user contributed notes for this page.
    To Top