Set the value of an SNMP object

# snmp2_set

(PHP >= 5.2.0, PHP 7, PHP 8)

snmp2_set — Set the value of an SNMP object

### Beschreibung

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

snmp2_set() is used to set the value of an SNMP object specified by the `object_id`.

### Parameter-Liste

`hostname`
  The hostname of the SNMP agent (server).
`community`
  The write community.
`object_id`
  The SNMP object id.
`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
  i | INTEGER
  u | INTEGER
  s | STRING
  x | HEX STRING
  d | DECIMAL STRING
  n | NULLOBJ
  o | OBJID
  t | TIMETICKS
  a | IPADDRESS
  b | BITS

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

  Typen
  U | unsigned int64
  I | signed int64
  F | float
  D | double

  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.
`timeout`
  The number of microseconds until the first timeout.
`retries`
  The number of times to retry if timeouts occur.

### Rückgabewerte

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

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

### Changelog

Version | Beschreibung
--- | ---
8.5.0 | Now throws a ValueError when the hostname length is equal to or greater than 128 bytes, when the port is negative or greater than 65535, or when the timeout or retries values are lower than -1 or too large.

### Beispiele

Beispiel #1 Using snmp2_set()

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

Beispiel #2 Using snmp2_set() for setting BITS SNMP object id

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

### Siehe auch

- snmp2_get() - Fetch an SNMP object

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open