Класс SNMP

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

Введение

Представляет сессию протокола SNMP.

Обзор класса

class SNMP {

/* Константы */

public const int VERSION_1;

public const int VERSION_2c;

public const int VERSION_2C;

public const int VERSION_3;

public const int ERRNO_NOERROR;

public const int ERRNO_ANY;

public const int ERRNO_GENERIC;

public const int ERRNO_TIMEOUT;

public const int ERRNO_ERROR_IN_REPLY;

public const int ERRNO_OID_NOT_INCREASING;

public const int ERRNO_OID_PARSING_ERROR;

public const int ERRNO_MULTIPLE_SET_QUERIES;

/* Свойства */

public readonly array $info;

public ?int $max_oids;

public int $valueretrieval;

public bool $quick_print;

public bool $enum_print;

public int $oid_output_format;

public bool $oid_increasing_check;

public int $exceptions_enabled;

/* Методы */

public __construct(
    int $version,
    string $hostname,
    string $community,
    int $timeout = -1,
    int $retries = -1
)

public close(): bool

public get(array|string $objectId, bool $preserveKeys = false): mixed

public getErrno(): int

public getError(): string

public getnext(array|string $objectId): mixed

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

public setSecurity(
    string $securityLevel,
    string $authProtocol = "",
    string $authPassphrase = "",
    string $privacyProtocol = "",
    string $privacyPassphrase = "",
    string $contextName = "",
    string $contextEngineId = ""
): bool

public walk(
    array|string $objectId,
    bool $suffixAsKey = false,
    int $maxRepetitions = -1,
    int $nonRepeaters = -1
): array|false

}

Свойства

max_oids

Максимальный идентификатор OID для запросов GET, SET или GETBULK

valueretrieval

Управляет методом возврата SNMP-значений

`SNMP_VALUE_LIBRARY`	Возвращаемые значения будут такими, как будто их вернула библиотека Net-SNMP.
`SNMP_VALUE_PLAIN`	Возвращаемые значения будут простыми, без информации о типах SNMP.
`SNMP_VALUE_OBJECT`	Возвращаемые значения будут объектами со свойствами value и type, где type будет содержать одну из констант: SNMP_OCTET_STR, SNMP_COUNTER и т. д., а value будет зависеть от того, установили `SNMP_VALUE_LIBRARY` или `SNMP_VALUE_PLAIN`.

quick_print

Значение параметра quick_print в библиотеке NET-SNMP

Устанавливает значение quick_print в библиотеке NET-SNMP. если задали как (1), библиотека SNMP будет возвращать значения «quick printed». То есть будут напечатаны только значения. Если параметр quick_print не разрешён (по умолчанию), библиотека NET-SNMP будет печатать дополнительную информацию, включая тип значения (то есть IpAddress или OID). Дополнительно, если параметр quick_print не разрешён, библиотека будет печатать шестнадцатеричные значения для каждой строки короче четырёх символов.

enum_print

Контролирует способ, которым будут печататься значения перечислений

Параметр переключает поведение walk или get и т. д., чтобы они автоматически смотрели значения перечислений в MIB и возвращали их вместе с понятным человеку текстом.

oid_output_format

Контролирует формат вывода OID

**OID-представление .1.3.6.1.2.1.1.3.0 для различных значений `oid_output_format`**
`SNMP_OID_OUTPUT_FULL`	.iso.org.dod.internet.mgmt.mib-2.system.sysUpTime.sysUpTimeInstance
`SNMP_OID_OUTPUT_NUMERIC`	.1.3.6.1.2.1.1.3.0
`SNMP_OID_OUTPUT_MODULE`	DISMAN-EVENT-MIB::sysUpTimeInstance
`SNMP_OID_OUTPUT_SUFFIX`	sysUpTimeInstance
`SNMP_OID_OUTPUT_UCD`	system.sysUpTime.sysUpTimeInstance
`SNMP_OID_OUTPUT_NONE`	Undefined

oid_increasing_check

Контролирует запрет на проверку увеличения идентификатора OID при обходе дерева OID

Некоторые агенты SNMP известны тем, что возвращают OID-идентификатор объекта не по порядку, но всё равно завершают проход. Другие агенты, возвращают OID не по порядку и иногда вызывают бесконечное зацикливание метода SNMP::walk(), пока не закончится память. PHP-модуль SNMP по умолчанию предпринимает проверку увеличения OID и прекращает обход дерева, если определяет возможную закольцовку, выдавая соответствующее предупреждение. Для переменной oid_increasing_check устанавливают значение false, чтобы запретить эту проверку.

exceptions_enabled

Определяет, какие сбои будут выбрасывать исключение SNMPException вместо предупреждения. Принимает константы семейства SNMP::ERRNO_* через побитовое ИЛИ. По умолчанию SNMP не выбрасывает исключения.

info

Свойство только для чтения, которое содержит конфигурацию удалённого агента: имя хоста, порт, время ожидания по умолчанию, количество повторов по умолчанию.

Предопределённые константы

Типы ошибок SNMP

SNMP::ERRNO_NOERROR: Ошибки SNMP отсутствуют.
SNMP::ERRNO_GENERIC: Общая ошибка SNMP.
SNMP::ERRNO_TIMEOUT: Превышено время ожидания запроса к SNMP-агенту.
SNMP::ERRNO_ERROR_IN_REPLY: SNMP-агент вернул ошибку в ответ.
SNMP::ERRNO_OID_NOT_INCREASING: SNMP-агент обнаружил возможную закольцовку из-за неувеличения OID-идентификатора объекта при выполнении команд (BULK)WALK. Это говорит о том, что удалённый SNMP-агент фиктивный.
SNMP::ERRNO_OID_PARSING_ERROR: Библиотека не разобрала OID-идентификатор объекта (и (или) тип для команды SET). Запросов не было.
SNMP::ERRNO_MULTIPLE_SET_QUERIES: Библиотека использует множественные запросы для операции SET. Это означает, что операция будет выполняться без транзакции, и, если возникнет ошибка типа или значения, второй или последующие фрагменты иногда завершаются ошибкой.
SNMP::ERRNO_ANY: Все коды SNMP::ERRNO_* объединённые побитовым ИЛИ.

Версии протокола SNMP

SNMP::VERSION_1
SNMP::VERSION_2C, SNMP::VERSION_2c
SNMP::VERSION_3

Содержание

SNMP::close — Закрывает сессию SNMP
SNMP::__construct — Создаёт экземпляр класса SNMP, который представляет сеанс удалённому SNMP-агенту
SNMP::get — Получает объект SNMP
SNMP::getErrno — Получает код последней ошибки
SNMP::getError — Получает последнее сообщение об ошибке
SNMP::getnext — Получить объект SNMP, который следует за данным идентификатором объекта
SNMP::set — Устанавливает значение объекта SNMP
SNMP::setSecurity — Настраивает связанные с безопасностью параметры сессии SNMPv3
SNMP::walk — Получает поддерево объекта SNMP