Through the Internet Protocol SNMP

Для управления используются следующие запросы:

addtrap - добавить уведомление по SNMP. Дополнительные параметры:

k - идентификатор сессии пользователя;
id - идентификатор уведомления по SNMP, если идентификатор отсутствует - создается новое уведомление, иначе - редактируется существующее;
name - имя уведомления по SNMP, длина не более 63 символов;
server - SNMP сервер, длина не более 127 символов;
port - порт службы SNMP на сервере;
version - версия SNMP, возможные значения - 1, 2c, 3;
comunity - сообщество SNMP (для версии 1, 2c), длина не более 31 символа;
user - имя пользователя (для версии 3), длина не более 63 символов;
level - уровень безопасности (для версии 3), возможные значения:
- noauth - без авторизации и шифрования;
- auth - только авторизация;
- priv - авторизация и шифрование;
auth_type - тип авторизации (для версии 3), возможные значения - MD5, SHA;
auth_pass - пароль авторизации (для версии 3), длина не более 63 символов;
priv_type - тип шифрования (для версии 3), возможные значения - DES, AES;
priv_pass - пароль шифрования (для версии 3), длина не более 63 символов;
message - шаблон текста сообщения, длина не более 1023 символов, может не вводиться, тогда используется текст по умолчанию.

При успешном создании нового элемента, ответ содержит идентификатор элемента, и имеет вид:

При создании нового уведомления (id не указывается), обязательными являются параметры - name, server, port, version, остальные параметры указываются в зависимости от конфигурации версии SNMP (version) и уровня безопасности (level). При изменении чувствительных параметров (version и level), необходимо явно указывать зависимые параметры, при этом неиспользуемые параметры будут стерты (например при version=3 и level=auth, будут стерты неиспользуемые параметры comunity, priv_type и priv_pass). Пустые параметры подразумевают стирание ранее присвоенного значения, кроме параметров name, server, port, version, для них пустые поля не допускаются.

deltrap - удалить уведомление по SNMP. Обязательные параметры:

k - идентификатор сессии пользователя;
id - идентификатор уведомления по SNMP.

testmessage - отправка тестового сообщения, при этом не создается новый элемент. Дополнительные параметры:

k - идентификатор сессии пользователя;
type - тип тестового уведомления (trap);
name - имя уведомления по SNMP, длина не более 63 символов;
server - SNMP сервер, длина не более 127 символов;
port - порт службы SNMP на сервере;
version - версия SNMP, возможные значения - 1, 2c, 3;
comunity - сообщество SNMP (для версии 1, 2c), длина не более 31 символа;
user - имя пользователя (для версии 3), длина не более 63 символов;
level - уровень безопасности (для версии 3), возможные значения:
- noauth - без авторизации и шифрования;
- auth - только авторизация;
- priv - авторизация и шифрование;
auth_type - тип авторизации (для версии 3), возможные значения - MD5, SHA;
auth_pass - пароль авторизации (для версии 3), длина не более 63 символов;
priv_type - тип шифрования (для версии 3), возможные значения - DES, AES;
priv_pass - пароль шифрования (для версии 3), длина не более 63 символов;
message - шаблон текста сообщения, длина не более 1023 символов, может не вводиться, тогда используется текст по умолчанию.

getelement - чтение элемента. Обязательные параметры:

k - идентификатор сессии пользователя;
id - идентификатор элемента.

Ответ содержит информацию об элементе:

<element id="602001" module="2004" num="1" clas="notifier" type="snmp trap" name="my_trap" state="off" server="192.168.0.55" port="162" 
version="3" comunity=""  user="admin" level="auth"  auth_type="SHA" auth_pass="somepass"  priv_type="" priv_pass=""  
message="Time: %3 Logic: %4, Element: %5, in state: %6, value: %7"  />

The following queries are used for management:

addtrap - add SNMP notification. Extra options:

k is the user session ID;
id is the SNMP notification ID, if there is no identifier, a new notification is created, otherwise the existing one is edited;
name - name of SNMP notification, length is not more than 63 characters;
server - SNMP server, no more than 127 characters;
port - the SNMP service port on the server;
version - version of SNMP, possible values - 1, 2c, 3;
comunity - SNMP community (for version 1, 2c), the length is not more than 31 characters;
user - user name (for version 3), length is not more than 63 characters;
level - security level (for version 3), possible values:
- noauth - without authorization and encryption;
- auth - only authorization;
- priv - authorization and encryption;
auth_type - type of authorization (for version 3), possible values are MD5, SHA;
auth_pass - authorization password (for version 3), length is not more than 63 characters;
priv_type - type of encryption (for version 3), possible values - DES, AES;
priv_pass - encryption password (for version 3), length is not more than 63 characters;
message - message text template, no more than 1023 characters in length, can not be entered, then the default text is used.

If a new element is successfully created, the response contains the element identifier, and looks like:

When creating a new notification (id is not specified), the parameters - name, server, port, version are mandatory, other parameters are specified depending on the configuration of the version of SNMP (version) and the level of security (level). If you change the sensitive parameters (version and level), you must explicitly specify the dependent parameters, while the unused parameters will be erased (for example, if version = 3 and level = auth, unused comunity, priv_type and priv_pass parameters will be erased). Empty parameters mean erasing a previously assigned value, except for the parameters name, server, port, version, for which empty fields are not allowed.

deltrap - delete the notification by SNMP. Required parameters:

k is the user session ID;
id is the SNMP notification identifier.

testmessage - send a test message, without creating a new element. Extra options:

k is the user session ID;
type - type of test notification (trap);
name - name of SNMP notification, length is not more than 63 characters;
server - SNMP server, no more than 127 characters;
port - the SNMP service port on the server;
version - version of SNMP, possible values - 1, 2c, 3;
comunity - SNMP community (for version 1, 2c), the length is not more than 31 characters;
user - user name (for version 3), length is not more than 63 characters;
level - security level (for version 3), possible values:
- noauth - without authorization and encryption;
- auth - only authorization;
- priv - authorization and encryption;
auth_type - type of authorization (for version 3), possible values are MD5, SHA;
auth_pass - authorization password (for version 3), length is not more than 63 characters;
priv_type - type of encryption (for version 3), possible values - DES, AES;
priv_pass - encryption password (for version 3), length is not more than 63 characters;
message - message text template, no more than 1023 characters in length, can not be entered, then the default text is used.

getelement - read the element. Required parameters:

k is the user session ID;
id is the ID of the item.

The answer contains information about the element:

<element id="602001" module="2004" num="1" clas="notifier" type="snmp trap" name="my_trap" state="off" server="192.168.0.55" port="162" 
version="3" comunity=""  user="admin" level="auth"  auth_type="SHA" auth_pass="somepass"  priv_type="" priv_pass=""  
message="Time: %3 Logic: %4, Element: %5, in state: %6, value: %7"  />