SNMP::set
(PHP 5 >= 5.4.0, PHP 7)
SNMP::set — Устанавливает значение объекта SNMP
Описание
$objectId
, array|string $type
, array|string $value
) : array|bool
Запрашивает удаленный агент SNMP, устанавливающий значение
одного или нескольких объектов SNMP, указанных в objectId.
Список параметров
-
objectId -
Идентификатор объекта SNMP
Когда количество OID в массиве object_id больше, чем max_oids, метод набора свойств объекта должен будет использовать несколько запросов для выполнения запрошенных обновлений значений. В этом случае проверки типа и значения выполняются для каждого фрагмента, поэтому второй или последующие запросы могут завершиться ошибкой из-за неправильного типа или значения запрошенного OID. Чтобы сообщить об этом, появляется предупреждение, когда количество OID в массиве object_id превышает max_oids.
-
type -
MIB указывает тип идентификатора каждого объекта. Он должен быть указан в виде одного символа из следующего списка.
types = Тип, принимаемый 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, то также могут быть использованы следующие типы:types U unsigned int64 I signed int64 F float D double Большинство этих значений используют очевидный тип ASN.1. 's', 'x', 'd' и 'b' - это все разные способы указания значения OCTET STRING, а беззнаковый тип 'u' также используется для обработки значений Gauge32.
Если MIB-файлы были загружены в MIB-дерево с помощью "snmp_read_mib" или были указаны в конфигурационном файле libsnmp, то для указания параметра
typeможно использовать нотацию '=', т.к. тип всех идентификаторов объектов будет автоматически считан из MIB.Обратите внимание, что есть два способа установить переменную типа BITS, например, "SYNTAX BITS {telnet(0), ftp(1), http(2), icmp(3), snmp(4), ssh(5), https(6)}":
- С помощью типа "b" и списка битовых чисел. Не рекомендуется использовать этот метод, т.к. GET-запрос для того же OID вернет, к примеру, 0xF8.
- С помощью типа "x" и шестнадцатеричного числа, но без(!) обычного префикса "0x".
Подробнее смотрите в разделе с примерами.
-
value -
Новое значение.
Если objectId - это строка (string), оба
type и value также должны быть
строками (string). Если objectId - массив (array),
value должен быть массивом равного размера, содержащим
соответствующие значения, type может быть либо
строкой (string) (это значение будет использоваться для всех
пар objectId-value) или
массив равного размера с каждым значением OID. Когда используются комбинации любых других параметров,
может отображаться ряд сообщений E_WARNING с подробным описанием.
Возвращаемые значения
Возвращает true в случае успешного завершения или false в случае возникновения ошибки.
Ошибки
Данный метод по умолчанию не генерирует исключения.
Чтобы включить генерацию исключения SNMPException при возникновении
некоторых ошибок данной библиотеки, необходимо установить параметр
exceptions_enabled класса SNMP в
соответствующее значение. Подробнее смотрите в
объяснении параметра SNMP::$exceptions_enabled.
Примеры
Пример #1 Установить одиночный идентификатор объекта SNMP
<?php
$session = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
$session->set('SNMPv2-MIB::sysContact.0', 's', "Nobody");
?>
Пример #2 Установить несколько значений с помощью одного вызова SNMP::set()
<?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"));
// или
$session->set(array('SNMPv2-MIB::sysContact.0', 'SNMPv2-MIB::sysLocation.0'), 's', array("Nobody", "Nowhere"));
?>
Пример #3 Использование SNMP::set() для установки идентификатора объекта BITS SNMP
<?php
$session = new SNMP(SNMP::VERSION_2C, "127.0.0.1", "private");
$session->set('FOO-MIB::bar.42', 'b', '0 1 2 3 4');
// или
$session->set('FOO-MIB::bar.42', 'x', 'F0');
?>