Documentation
Table of Contents
> Объект действия
Следующие объекты напрямую связаны с action API.
Действие
Объект действия имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| actionid | строка | (только чтение) ID действия. |
| esc_period (требуется) |
целое число | Длительность шага операции. Должно быть больше 60 секунд. |
| eventsource (требуется) |
целое число | (константа) Тип событий, которые будет обрабатывать действие. Обратитесь к свойству "source" событий для получения списка поддерживаемых типов событий. |
| name (требуется) |
строка | Имя действия. |
| def_longdata | строка | Текст сообщения о проблеме. |
| def_shortdata | строка | Тема сообщения о проблеме. |
| r_longdata | строка | Текст сообщения о восстановлении. |
| r_shortdata | строка | Тема сообщения о восстановлении. |
| status | целое число | Активировано ли действие или нет. Возможные значения: 0 - (по умолчанию) активировано; 1 - деактивировано. |
| maintenance_mode | целое число | Приостанавливать эскалацию в течении периодов обслуживания или нет. Возможные значения: 0 - Не приостанавливать эскалацию; 1 - (по умолчанию) Приостановить эскалацию. |
Операция действия
Объект операции действия определяет операцию, которая будет выполнена при выполнении действия. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| operationid | строка | (только чтение) ID операции действия. |
| operationtype (требуется) |
целое число | Тип операции. Возможные значения: 0 - отправка сообщения; 1 - удаленная команда; 2 - добавление узла сети; 3 - удаление узла сети; 4 - добавление в группу узлов сети; 5 - удаление из группы узлов сети; 6 - присоединение шаблона; 7 - отсоединение от шаблона; 8 - активация узла сети; 9 - деактивация узла сети; 10 - установить режим инвентарных данных узла сети. |
| actionid | строка | ID действия, которому принадлежит операция. |
| esc_period | целое число | Длительность шага эскалации в секундах. Должно быть больше 60 секунд. Если задано равным 0, будет использоваться период эскалации по умолчанию в действии. По умолчанию: 0. |
| esc_step_from | целое число | Шаг начала эскалации. По умолчанию: 1. |
| esc_step_to | целое число | Шаг конца эскалации. По умолчанию: 1. |
| evaltype | целое число | Метод вычисления условия операции. Возможные значения: 0 - (по умолчанию) И / ИЛИ; 1 - И; 2 - ИЛИ. |
| opcommand | объект | Объект, который содержит данные о выполняемой команде в операции. Объект команды операции описан в деталях ниже. Требуется для операций с удаленной командой. |
| opcommand_grp | массив | Группы узлов сети на которых будут выполняться удаленные команды. Каждый объект имеет следующие свойства: opcommand_grpid - (строка, только чтение) ID объекта;operationid - (строка) ID операции;groupid - (строка) ID группы узлов сети.Требуется при операциях с удаленной командой, если не задано opcommand_hst. |
| opcommand_hst | массив | Узел сети на котором будут выполняться удаленные команды. Каждый объект имеет следующие свойства: opcommand_hstid - (строка, только чтение) ID объекта;operationid - (строка) ID операции;hostid - (строка) ID узла сети; если задано значение равное 0, команда будет выполняться на текущем узле сети.Требуется при операциях с удаленной командой, если не задано opcommand_grp. |
| opconditions | массив | Условия операции, которые используются для действий на триггеры. Объект условия операции детально описан ниже. |
| opgroup | массив | Группы узлов сети в которые будут добавлены узлы сети. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;groupid - (строка) ID группы узлов сети.Требуется для операций "добавление в группу узлов сети" и "удаление из группы узлов сети". |
| opmessage | объект | Объект, который содержит данные об отправляемом сообщении в операции. Объект сообщения операции детально описан ниже. Требуется для операций с сообщениями. |
| opmessage_grp | массив | Группы пользователей которым будут отправляться сообщения. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;usrgrpid - (строка) ID группы пользователей.Требуется при операциях с сообщениями, если не задано opmessage_usr. |
| opmessage_usr | массив | Пользователи которым будут отправляться сообщения. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;userid - (строка) ID пользователя.Требуется при операциях с сообщениями, если не задано opmessage_grp. |
| optemplate | массив | Шаблоны к которым будет присоединён узел сети. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;templateid - (строка) ID шаблона.Требуется для операций "присоединение шаблона" и "отсоединение от шаблона". |
| opinventory | объект | Режим инвентарных данных, который необходимо задать узлу сети. Объект имеет следующие свойства: operationid - (строка) ID операции;inventory_mode - (строка) Режим инвентарных данных.Требуется для операций "Установить режим инвентарных данных узлов сети". |
Команда операции действия
Объект команды операции содержит данные о команде, которая будет выполнена операцией.
| Свойство | Тип | Описание |
|---|---|---|
| operationid | строка | (только чтение) ID операции. |
| command (требуется) |
строка | Выполняемая команда. Требуется, когда type IN (0,1,2,3). |
| type (требуется) |
целое число | Тип команды операции. Возможные значения: 0 - пользовательский скрипт; 1 - IPMI; 2 - SSH; 3 - Telnet; 4 - глобальный скрипт. |
| authtype | целое число | Метод аутентификации, который используется при SSH командах. Возможные значения: 0 - пароль; 1 - публичный ключ. Требуется для SSH команд. |
| execute_on | целое число | Цель, на которой будет выполнен пользовательский скрипт команды операции. Возможные значения: 0 - Zabbix агент; 1 - Zabbix сервер. Требуется для команд с пользовательским скриптом. |
| password | строка | Пароль, используемый для SSH команд с аутентификацией по паролю и для Telnet команд. |
| port | строка | Порт, используемый для команд SSH и Telnet. |
| privatekey | строка | Имя файла приватного ключа, который используется для SSH команд с аутентификацией по публичному ключу. Требуется для SSH команд с аутентификацией по публичному ключу. |
| publickey | строка | Имя файла публичного ключа, который используется для SSH команд с аутентификацией по публичному ключу Требуется для SSH команд с аутентификацией по публичному ключу. |
| scriptid | строка | ID скрипта, который используется в командах с глобальными скриптами. Требуется для команд с глобальным скриптом. |
| username | строка | Имя пользователя, которое используется для аутентификации. Требуется для команд SSH и Telnet. |
Сообщение операции действия
Объект сообщения операции содержит данные о сообщении, которое будет отправлено операцией.
| Свойство | Тип | Описание |
|---|---|---|
| operationid | строка | (только чтение) ID операции действия. |
| default_msg | целое число | Следует ли использовать текст и тему сообщения действия по умолчанию. Возможные значения: 0 - (по умолчанию) использование данных из операции; 1 - использование данных из действия. |
| mediatypeid | строка | ID способа оповещения, которое будет использоваться для отправки сообщения. |
| message | строка | Текст сообщения операции. |
| subject | строка | Тема сообщения операции. |
Условие операции действия
Объект условия операции действия определяет условие, которое должно быть соблюдено для выполнения текущей операции. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| opconditionid | строка | (только чтение) ID условия операции действия |
| conditiontype (требуется) |
целое число | Тип условия. Возможные значения: 14 - событие подтверждено. |
| value (требуется) |
строка | Значение с которым происходит сравнение. |
| operationid | строка | (только чтение) ID операции. |
| operator | целое число | Оператор условия. Возможные значения: 0 - (по умолчанию) =. |
Каждым типом условия операции поддерживаются следующие операторы и значения.
| Условие | Имя условия | Поддерживаемые операторы | Ожидаемое значение |
|---|---|---|---|
| 14 | Событие подтверждено | = | Подтверждено ли событие. Возможные значения: 0 - не подтверждено; 1 - подтверждено. |
Операция действия о восстановлении
Объект операции действия о восстановлении определяет операцию, которая будет выполнена когда проблема решена. Операции восстановления можно использовать для действий по триггерам и внутренним действиям. Этот объект имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| operationid | строка | (только чтение) ID операции действия. |
| operationtype (требуется) |
целое число | Тип операции. Возможные значения для действий на триггеры: 0 - отправка сообщения; 1 - удаленная команда; 11 - отправка сообщения о восстановлении. Возможные значения для действий на внутренние события: 0 - отправка сообщения; 11 - отправка сообщения о восстановлении. |
| actionid | строка | ID действия, которому принадлежит операция о восстановлении. |
| opcommand | массив | Объект, который содержит данные о выполняемой команде в операции о восстановлении. Объект команды операции описан в деталях ниже. Требуется для операций с удаленной командой. |
| opcommand_grp | массив | Группы узлов сети на которых будут выполняться удаленные команды. Каждый объект имеет следующие свойства: opcommand_grpid - (строка, только чтение) ID объекта;operationid - (строка) ID операции;groupid - (строка) ID группы узлов сети.Требуется при операциях с удаленной командой, если не задано opcommand_hst. |
| opcommand_hst | массив | Узел сети на котором будут выполняться удаленные команды. Каждый объект имеет следующие свойства: opcommand_hstid - (строка, только чтение) ID объекта;operationid - (строка) ID операции;hostid - (строка) ID узла сети; если задано значение равное 0, команда будет выполняться на текущем узле сети.Требуется при операциях с удаленной командой, если не задано opcommand_grp. |
| opmessage | объект | Объект, который содержит данные об отправляемом сообщении в операции о восстановлении. Объект сообщения операции детально описан ниже. Требуется для операций с сообщениями. |
| opmessage_grp | массив | Группы пользователей которым будут отправляться сообщения. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;usrgrpid - (строка) ID группы пользователей.Требуется при операциях с сообщениями, если не задано opmessage_usr. |
| opmessage_usr | массив | Пользователи которым будут отправляться сообщения. Каждый объект имеет следующие свойства: operationid - (строка) ID операции;userid - (строка) ID пользователя.Требуется при операциях с сообщениями, если не задано opmessage_grp. |
Фильтр действия
Объект фильтра действия определяет набор условий, которые должны быть соблюдены для выполнения добавленных операций действия. Этот объект имеет следующие свойства.
| Свойства | Тип | Описание |
|---|---|---|
| conditions (требуется) |
массив | Набор условий фильтрации, которые используются для фильтрации результатов. |
| evaltype (требуется) |
целое число | Метод вычисления условий фильтрации. Возможные значения: 0 - и/или; 1 - и; 2 - или; 3 - пользовательское выражение. |
| eval_formula | строка | (только чтение) Сгенерированное выражение, которое будет использоваться для вычисления условий фильтрации. Выражение содержит ID, которые являются ссылкой на определенные условия фильтрации по их formulaid полю. Значение eval_formula равно значению formula для фильтров с пользовательским выражением. |
| formula | строка | Заданное пользователем выражение, которое используется для вычисления условий фильтров с пользовательским выражением. Выражение должно содержать ID, которые являются ссылкой на определенные условия фильтрации по их formulaid. Эти ID используемые в выражении должны в точности совпадать с выражениями, которые заданы в условиях фильтрации: ни одно условие не должно остаться неиспользуемым или пропущенным.Требуется для фильтров с пользовательским выражением. |
Условие фильтрации действия
Объект условия фильтрации действия задает определенное условие, которое необходимо проверить до выполнения операций действия.
| Свойство | Тип | Описание |
|---|---|---|
| conditionid | строка | (только чтение) ID условия действия. |
| conditiontype (требуется) |
целое число | Тип условия. Возможные значения для действий на триггеры: 0 - группа узлов сети; 1 - узел сети; 2 - триггер; 3 - имя триггера; 4 - важность триггера; 6 - период времени; 13 - шаблон узла сети; 15 - группа элементов данных; 16 - состояние обслуживания; 25 - тег события; 26 - значения тега события. Возможные значения для действий на обнаружения: 7 - IP хоста; 8 - тип обнаруженного сервиса; 9 - порт обнаруженного сервиса; 10 - состояние обнаружения; 11 - длительность доступности или недоступности; 12 - полученное значение; 18 - правило обнаружения; 19 - проверка обнаружения; 20 - прокси; 21 - объект обнаружения. Возможные значения для действий на авторегистрацию: 20 - прокси; 22 - имя хоста; 24 - метаданные хоста. Возможные значения для действий на внутренние события: 0 - группа узлов сети; 1 - узел сети; 13 - шаблон узла сети; 15 - группа элементов данных; 23 - тип события. |
| value (требуется) |
строка | Значение с которым будет идти сравнение. |
| value2 |
строка | Второе значение с которым будет идти сравнение. Требуется для действий на триггеры с типом условия 26. |
| actionid | строка | (только чтение) ID действия, которому принадлежит условие. |
| formulaid | строка | Произвольный уникальный ID, который используется в качестве ссылки на условие из пользовательского выражения. Может содержать только буквы в верхнем регистре. Этот ID должен быть задан пользователем при изменении условий фильтрации, однако ID будут сгенерированы заново при последующих их запросах. |
| operator | целое число | Оператор условия. Возможные значения: 0 - (по умолчанию) =; 1 - <>; 2 - содержит; 3 - не содержит; 4 - в; 5 - >=; 6 - <=; 7 - не в. |
Чтобы лучше понимать как использовать фильтры с различными типами выражений, смотрите примеры на страницах action.get и action.create методов.
У каждого типа условия поддерживаются следующие операторы и значения.
| Условие | Имя условия | Поддерживаемые операторы | Ожидаемое значение |
|---|---|---|---|
| 0 | Группа узлов сети | =, <> | ID группы узлов сети. |
| 1 | Узел сети | =, <> | ID узла сети. |
| 2 | Триггер | =, <> | ID триггера. |
| 3 | Имя триггера | содержит, не содержит | Имя триггера. |
| 4 | Важность триггера | =, <>, >=, <= | Важность триггера. Обратитесь к свойству триггера "severity" для получения списка поддерживаемых важностей в триггерах. |
| 5 | Значение триггера | = | Значение триггера. Обратитесь к свойству триггера "value" для получения списка поддерживаемых значений триггера. |
| 6 | Период времени | в, не в | Время, когда было вызвано событие в виде периода времени. |
| 7 | IP узла сети | =, <> | Проверяемый один или несколько диапазонов IP адресов, разделенных запятыми. Обратитесь к разделу настройки сетевого обнаружения для получения более подробной информации о поддерживаемых форматах диапазонов IP адресов. |
| 8 | Тип обнаруженного сервиса | =, <> | Тип обнаруженного сервиса. Тип сервиса соответствует проверке обнаружения, которая используется для обнаружения сервиса. Обратитесь к свойству "type" проверки обнаружения для получения списка поддерживаемых типов. |
| 9 | Порт обнаруженного сервиса | =, <> | Один или несколько диапазонов портов, разделенных запятыми. |
| 10 | Состояние обнаружения | = | Состояние обнаруженного объекта. Возможные значения: 0 - хост или сервис доступны; 1 - хост или сервис недоступны; 2 - хост или сервис обнаружены; 3 - хост или сервис потеряны. |
| 11 | Длительность времени доступности или недоступности | >=, <= | Время, которое указывает как долго обнаруженный объект находится в текущем состоянии, в секундах. |
| 12 | Полученное значение | =, <>, >=, <=, содержит, не содержит | Полученное значение при выполнении проверки обнаружения Zabbix агента, SNMPv1, SNMPv2 или SNMPv3. |
| 13 | Шаблон узла сети | =, <> | ID присоединенного шаблона. |
| 15 | Группа элементов данных | =, содержит, не содержит | Имя группы элементов данных. |
| 16 | Состояние обслуживания | в, не в | Значение не требуется: использование оператора "в" подразумевает что узел сети должен быть в обслуживании, "не в" - не в обслуживании. |
| 18 | Правило обнаружения | =, <> | ID правила обнаружения. |
| 19 | Проверка обнаружения | =, <> | ID проверки обнаружения. |
| 20 | Прокси | =, <> | ID прокси. |
| 21 | Объект обнаружения | = | Тип объекта, который вызвал событие обнаружения. Возможные значения: 1 - обнаружен узел сети; 2 - обнаружен сервис. |
| 22 | Имя узла сети | содержит, не содержит | Имя узла сети. |
| 23 | Тип события | = | Специфично для внутренних событий. Возможные значения: 0 - элемент данных в "неподдерживаемом" состоянии; 1 - элемент данных в "нормальном" состоянии; 2 - LLD правило в "неподдерживаемом" состоянии; 3 - LLD правило в "нормальном" состоянии; 4 - триггер в "неизвестном" состоянии; 5 - триггер в "нормальном" состоянии. |
| 24 | Метаданные хоста | содержит, не содержит | Метаданные автоматически зарегистрированного узла сети. |
| 25 | Тег | =, <>, содержит, не содержит | Тег события. |
| 26 | Значение тега | =, <>, содержит, не содержит | Значение тега события. |