(PHP 4, PHP 5, PHP 7, PHP 8)
snmp3_set — Set the value of an SNMP object
$hostname,$security_name,$security_level,$auth_protocol,$auth_passphrase,$privacy_protocol,$privacy_passphrase,$object_id,$type,$value,$timeout = -1,$retries = -1
snmp3_set() is used to set the value of an SNMP object
specified by the object_id.
The authentication and privacy arguments must always be passed, but their
values are ignored when security_level does not use
them.
hostnameThe hostname of the SNMP agent (server).
security_nameThe security name, usually some kind of username.
security_levelThe security level: "noAuthNoPriv",
"authNoPriv", or "authPriv".
auth_protocolThe authentication protocol: "MD5", "SHA",
"SHA256", or "SHA512".
auth_passphraseThe authentication passphrase.
privacy_protocolThe privacy protocol: "DES", or "AES",
also accepted as "AES128". "AES192", "AES192C",
"AES256", and "AES256C" are accepted when supported by the
Net-SNMP library.
privacy_passphraseThe privacy passphrase.
object_idThe SNMP object id.
typeMIB дає означення типу для ID об'єкта. Тип можна вказувати одним з символів:
| = | Тип, взятий з MIB |
| i | INTEGER |
| u | INTEGER |
| s | STRING |
| x | HEX STRING |
| d | DECIMAL STRING |
| n | NULLOBJ |
| o | OBJID |
| t | TIMETICKS |
| a | IPADDRESS |
| b | BITS |
Якщо під час компіляції бібліотеки SNMP задано
OPAQUE_SPECIAL_TYPES, будуть доступні наступні типи:
| U | беззнаковий int64 |
| I | знаковий int64 |
| F | десятковий дріб (float) |
| D | десятковий дріб подвійної точності (double) |
Більшість з них мають зрозумілий ASN.1-тип. "s", "x", "d" та "b" вказують на один тип — OCTET STRING, а беззнаковий тип "u" використовується для обробки значень Gauge32.
Якщо MIB-файли підключені до дерева MIB, бо вказані в налаштуваннях libsnmp або
за допомогою "snmp_read_mib", то потрібно задавати параметр
type зі значенням "=" для усіх ID об'єктів,
оскільки тип можна автоматично зчитувати з MIB.
Варто зазначити, що є два способи задати значення змінній, яка має тип BITS, як от "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
Використавши тип "b" та список бітових чисел. Цей спосіб не рекомендований, оскільки на GET-запит для однакових OID може бути відповідь, напр., 0xF8.
Використавши тип "x" та шістнадцяткове число, проте без(!) звичного префікса "0x".
Докладніше це описано у параграфі з прикладами.
valueThe new value
timeoutThe number of microseconds until the first timeout.
retriesThe number of times to retry if timeouts occur.
Повертає true у разі успіху або false в разі помилки.
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".
| Версія | Опис |
|---|---|
| 8.6.0 |
The privacy protocol now accepts "AES192",
"AES192C", "AES256", and
"AES256C" when supported by the Net-SNMP library.
|
| 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. |
| 8.1.0 |
The authentication protocol now accepts "SHA256"
and "SHA512" when supported by the Net-SNMP library.
|
Приклад #1 Using snmp3_set()
<?php
snmp3_set('localhost', 'james', 'authPriv', 'SHA', 'secret007', 'AES', 'secret007', 'IF-MIB::ifAlias.3', 's', "foo");
?>Приклад #2 Using snmp3_set() for setting BITS SNMP object id
<?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');
?>