'ivrapi' capability для WebSocket Token API

Обзор

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

Запросы

Отправка snmp trap (snmptrap)

Отправляет SNMP trap на зарегистрированный сервер.

Для успешного выполнения должен быть настроен параметр snmp_options в настройках мастер-домена. Сервер должен быть указан, отправка трапов должна быть включена. В соответствии с настройками осуществляется фильтрация по уровням логирования (level) и по фильтрам типов событий (alertCode).

Параметры:

  • notificationType :: ("systemAlert") | "serverAlert" | "nodeAlert" | "roleAlert" | "rateInfo" | "healthInfo" | "auditAlert", или синонимы: ("system") | "server" | "node" | "role" | "rate" | "health" | "audit".

  • alertCode :: ("custom") | произвольное название кода соответствующего события. Платформа использует такие, например: node_up, role_restart, certificate_expired, mg_killed, mg_cold_boot, admin_logon, sip_cps_rate, users_registered, system_state, …​

  • level :: ("info") | "emergency" | "alert" | "critical" | "error" | "warning" | "notice" | "debug", или синонимы: (6) | 0 | 1 | 2 | 3 | 4 | 5 | 7.

  • alertKey :: ("") | произвольная строка, предполагается что название сообщаемого показателя.

  • alertValue :: ("") | произвольная строка, предполагается что само значение показателя.

  • alertMessage :: ("") | произвольная строка, предполагается какой-нибудь читаемый текст-описание события. Потенциально может быть строка с json, где кавычки escaped by backslash.

  • node :: (текущая ws нода) | произвольная строка, отражающая инициировавшую ноду.

  • role :: ("webserver") | произвольная строка, отражающая инициировавшую роль/микросервис.

Пример
[
  "snmptrap",
  {
    "qid":123,
    "notificationType": "systemAlert",
    "alertCode": "My code",
    "alertKey": "My key",
    "alertValue": "My value",
    "alertMessage": "Some message with \"quotation\"",
    "role": "My role",
    "level": "warning"
  }
]

[ "snmptrap_result", { "qid": 123, "result": "ok" } ] ---


[ "snmptrap_result", { "qid": 123, "result": "error", "errormsg": "", } ] ---