Action object

The following objects are directly related to the action API.

Действие

Объект действия имеет следующие свойства.

Свойство Тип Описание
actionid ID ID действия.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
esc_period string Длительность шага операции по умолчанию. Должна составлять не менее 60 секунд. Допускаются секунды, единица времени с суффиксом или пользовательский макрос.

Поведение свойства:
- поддерживается, если eventsource установлено в значение "событие, созданное триггером", "внутреннее событие" или "событие, созданное при обновлении состояния сервиса"
eventsource integer Тип событий, которые будет обрабатывать действие.

Список поддерживаемых типов событий см. в свойстве source события.

Поведение свойства:
- константа
- обязательно для операций создания
name string Имя действия.

Поведение свойства:
- обязательно для операций создания
status integer Указывает, включено или отключено действие.

Возможные значения:
0 - (по умолчанию) включено;
1 - отключено.
pause_symptoms integer Следует ли приостанавливать эскалацию, если событие является симптомным событием.

Возможные значения:
0 - Не приостанавливать эскалацию для симптомных проблем;
1 - (по умолчанию) Приостанавливать эскалацию для симптомных проблем.

Поведение свойства:
- поддерживается, если eventsource установлено в значение "событие, созданное триггером"
pause_suppressed integer Следует ли приостанавливать эскалацию во время периодов обслуживания.

Возможные значения:
0 - Не приостанавливать эскалацию;
1 - (по умолчанию) Приостанавливать эскалацию.

Поведение свойства:
- поддерживается, если eventsource установлено в значение "событие, созданное триггером"
notify_if_canceled integer Следует ли отправлять уведомление при отмене эскалации.

Возможные значения:
0 - Не отправлять уведомление при отмене эскалации;
1 - (по умолчанию) Отправлять уведомление при отмене эскалации.

Поведение свойства:
- поддерживается, если eventsource установлено в значение "событие, созданное триггером"

Операция действия

Объект операции действия определяет операцию, которая будет выполнена при выполнении действия. Он имеет следующие свойства.

Свойство Тип Описание
operationtype integer Тип операции.

Возможные значения:
0 - отправить сообщение;
1 - глобальный скрипт;
2 - добавить узел сети;
3 - удалить узел сети;
4 - добавить в группу узлов сети;
5 - удалить из группы узлов сети;
6 - привязать шаблон;
7 - отвязать шаблон;
8 - включить узел сети;
9 - отключить узел сети;
10 - установить режим инвентаризации узла сети;
13 - добавить теги узла сети;
14 - удалить теги узла сети.

Возможные значения, если eventsource объекта Action object установлен в "event created by a trigger" или "event created on service status update":
0 - "send message";
1 - "global script".

Возможные значения, если eventsource объекта Action object установлен в "internal event":
0 - "send message".

Поведение свойства:
- обязательно
esc_period string Длительность шага эскалации в секундах. Должна быть больше 60 секунд. Допускаются секунды, единица времени с суффиксом или пользовательский макрос. Если установлено значение 0 или 0s, будет использован период эскалации действия по умолчанию.

По умолчанию: 0s.

Поведение свойства:
- поддерживается, если eventsource объекта Action object установлен в "event created by a trigger", "internal event" или "event created on service status update"
esc_step_from integer Шаг, с которого начинается эскалация.

По умолчанию: 1.

Поведение свойства:
- поддерживается, если eventsource объекта Action object установлен в "event created by a trigger", "internal event" или "event created on service status update"
esc_step_to integer Шаг, на котором заканчивается эскалация.

По умолчанию: 1.

Поведение свойства:
- поддерживается, если eventsource объекта Action object установлен в "event created by a trigger", "internal event" или "event created on service status update"
evaltype integer Метод вычисления условия операции.

Возможные значения:
0 - (по умолчанию) And/Or;
1 - And;
2 - Or.
opcommand object Глобальный скрипт для выполнения.

Для глобального скрипта должно быть определено свойство scriptid.

Поведение свойства:
- обязательно, если operationtype установлен в "global script"
opcommand_grp array Группы узлов сети, на которых будут выполняться глобальные скрипты.

Для групп узлов сети должно быть определено свойство groupid.

Поведение свойства:
- обязательно, если operationtype установлен в "global script" и opcommand_hst не задан
opcommand_hst array Узел сети, на котором будут выполняться глобальные скрипты.

Для узлов сети должно быть определено свойство hostid.

Поведение свойства:
- обязательно, если operationtype установлен в "global script" и opcommand_grp не задан
opconditions array Условия операции, используемые для действий триггеров.

Объект условия операции подробно описан ниже.
opgroup array Группы узлов сети, в которые добавляются узлы сети.

Для групп узлов сети должно быть определено свойство groupid.

Поведение свойства:
- обязательно, если operationtype установлен в "add to host group" или "remove from host group"
opmessage object Объект, содержащий данные о сообщении, отправляемом операцией.

Объект сообщения операции подробно описан ниже.

Поведение свойства:
- обязательно, если operationtype установлен в "send message"
opmessage_grp array Группы пользователей, которым отправляются сообщения.

Для групп пользователей должно быть определено свойство usrgrpid.

Поведение свойства:
- обязательно, если operationtype установлен в "send message" и opmessage_usr не задан
opmessage_usr array Пользователи, которым отправляются сообщения.

Для пользователей должно быть определено свойство userid.

Поведение свойства:
- обязательно, если operationtype установлен в "send message" и opmessage_grp не задан
optemplate array Шаблоны для привязки к узлам сети.

Для шаблонов должно быть определено свойство templateid.

Поведение свойства:
- обязательно, если operationtype установлен в "link template" или "unlink template"
opinventory object Режим инвентаризации, который устанавливается для узла сети.

Для инвентаризации должно быть определено свойство inventory_mode.

Поведение свойства:
- обязательно, если operationtype установлен в "set host inventory mode"
optag array Теги узла сети для добавления или удаления.

Для тегов должно быть определено свойство tag.
Свойство value является необязательным.

Поведение свойства:
- поддерживается, если operationtype установлен в "add host tags" или "remove host tags".

Сообщение операции действия

Объект сообщения операции содержит данные о сообщении, которое будет отправлено операцией. Он имеет следующие свойства.

Свойство Тип Описание
default_msg integer Использовать ли текст и тему сообщения действия по умолчанию.

Возможные значения:
0 - использовать данные из операции;
1 - (по умолчанию) использовать данные из типа средства оповещения.
mediatypeid ID ID типа средства оповещения, который будет использоваться для отправки сообщения.

Поведение свойства:
- поддерживается, если operationtype объекта Объект операции действия, Объект операции восстановления действия или Объект операции обновления действия установлен в "отправить сообщение", либо если operationtype объекта Объект операции обновления действия установлен в "уведомить всех вовлечённых"
message string Текст сообщения операции.

Поведение свойства:
- поддерживается, если default_msg установлен в "использовать данные из операции"
subject string Тема сообщения операции.

Поведение свойства:
- поддерживается, если default_msg установлен в "использовать данные из операции"

Условие операции действия

Объект условия операции действия определяет условие, которое должно быть выполнено для выполнения текущей операции. Он имеет следующие свойства.

Свойство Type Описание
conditiontype integer Тип условия.

Возможные значения:
14 - событие подтверждено.

Поведение свойства:
- обязательно
value string Значение для сравнения.

Поведение свойства:
- обязательно
operator integer Оператор условия.

Возможные значения:
0 - (по умолчанию) =

Для каждого типа условия операции поддерживаются следующие операторы и значения.

Условие Название условия Поддерживаемые операторы Ожидаемое значение
14 Событие подтверждено = Подтверждено ли событие.

Возможные значения:
0 - не подтверждено;
1 - подтверждено.

Операция восстановления действия

Объект операции восстановления действия определяет операцию, которая будет выполнена при устранении проблемы. Операции восстановления возможны только для действий по триггерам, внутренних действий и действий служб. Он имеет следующие свойства.

Свойство Type Описание
operationtype integer Тип операции.

Возможные значения, если eventsource объекта Action object установлен в "событие, созданное триггером" или "событие, созданное при обновлении состояния службы":
0 - отправить сообщение;
1 - глобальный скрипт;
11 - уведомить всех вовлечённых.

Возможные значения, если eventsource объекта Action object установлен в "внутреннее событие":
0 - отправить сообщение;
11 - уведомить всех вовлечённых.

Поведение свойства:
- обязательно
opcommand object Глобальный скрипт для выполнения.

Для глобального скрипта должно быть определено свойство scriptid.

Поведение свойства:
- обязательно, если operationtype установлен в "глобальный скрипт"
opcommand_grp array Группы узлов сети, на которых будут выполняться глобальные скрипты.

Для групп узлов сети должно быть определено свойство groupid.

Поведение свойства:
- обязательно, если eventsource объекта Action object установлен в "событие, созданное триггером", operationtype установлен в "глобальный скрипт", и opcommand_hst не задан
opcommand_hst array Узел сети, на котором будут выполняться глобальные скрипты.

Для узлов сети должно быть определено свойство hostid.

Поведение свойства:
- обязательно, если eventsource объекта Action object установлен в "событие, созданное триггером", operationtype установлен в "глобальный скрипт", и opcommand_grp не задан
opmessage object Объект, содержащий данные о сообщении, отправляемом операцией восстановления.

Объект сообщения операции подробно описан выше.

Поведение свойства:
- обязательно, если operationtype установлен в "отправить сообщение"
opmessage_grp array Группы пользователей, которым будут отправлены сообщения.

Для групп пользователей должно быть определено свойство usrgrpid.

Поведение свойства:
- обязательно, если operationtype установлен в "отправить сообщение" и opmessage_usr не задан
opmessage_usr array Пользователи, которым будут отправлены сообщения.

Для пользователей должно быть определено свойство userid.

Поведение свойства:
- обязательно, если operationtype установлен в "отправить сообщение" и opmessage_grp не задан

Операция обновления действия

Объект операции обновления действия определяет операцию, которая будет выполнена при обновлении проблемы (добавлении комментария, подтверждении, изменении важности или закрытии вручную). Операции обновления возможны только для действий триггеров и сервисов. Он имеет следующие свойства.

Свойство Type Описание
operationtype integer Тип операции.

Возможные значения:
0 - отправить сообщение;
1 - глобальный скрипт;
12 - уведомить всех вовлечённых.

Поведение свойства:
- required
opcommand object Глобальный скрипт для выполнения.

Для глобального скрипта должно быть определено свойство scriptid.

Поведение свойства:
- required если operationtype установлено в "global script"
opcommand_grp array Группы узлов сети, на которых будут выполняться глобальные скрипты.

Для групп узлов сети должно быть определено свойство groupid.

Поведение свойства:
- required если eventsource объекта Action object установлено в "event created by a trigger", operationtype установлено в "global script", и opcommand_hst не задано
opcommand_hst array Узел сети, на котором будут выполняться глобальные скрипты.

Для узлов сети должно быть определено свойство hostid.

Поведение свойства:
- required если eventsource объекта Action object установлено в "event created by a trigger", operationtype установлено в "global script", и opcommand_grp не задано
opmessage object Объект, содержащий данные о сообщении, отправляемом операцией обновления.

Объект сообщения операции подробно описан выше.
opmessage_grp array Группы пользователей, которым будут отправлены сообщения.

Для групп пользователей должно быть определено свойство usrgrpid.

Поведение свойства:
- required если operationtype установлено в "send message" и opmessage_usr не задано
opmessage_usr array Пользователи, которым будут отправлены сообщения.

Для пользователей должно быть определено свойство userid.

Поведение свойства:
- required если operationtype установлено в "send message" и opmessage_grp не задано

Фильтр действия

Объект фильтра действия определяет набор условий, которые должны быть выполнены для выполнения настроенных операций действия. Он имеет следующие свойства.

Свойство Type Описание
conditions array Набор условий фильтра, используемых для фильтрации результатов. Условия будут отсортированы в порядке их размещения в формуле.

Поведение свойства:
- обязательно
evaltype integer Метод вычисления условий фильтра.

Возможные значения:
0 - И/Или;
1 - И;
2 - Или;
3 - Пользовательское выражение.

Поведение свойства:
- обязательно
eval_formula string Сгенерированное выражение, которое будет использоваться для вычисления условий фильтра. Выражение содержит идентификаторы, которые ссылаются на определенные условия фильтра по их formulaid. Значение eval_formula равно значению formula для фильтров с пользовательским выражением.

Поведение свойства:
- только для чтения
formula string Определяемое пользователем выражение, используемое для вычисления условий фильтров с пользовательским выражением. Выражение должно содержать идентификаторы, которые ссылаются на определенные условия фильтра по их formulaid. Идентификаторы, используемые в выражении, должны в точности соответствовать идентификаторам, определенным в условиях фильтра: ни одно условие не должно остаться неиспользованным или пропущенным.

Поведение свойства:
- обязательно, если evaltype установлено в "custom expression"

Условие фильтра действия

Объект условия фильтра действия определяет конкретное условие, которое необходимо проверить перед выполнением операций действия.

Свойство Тип Описание
conditiontype integer Тип условия.

Возможные значения, если eventsource объекта Action object установлен в значение «событие, созданное триггером»:
0 - группа узлов сети;
1 - узел сети;
2 - триггер;
3 - имя события;
4 - важность триггера;
6 - период времени;
13 - шаблон узла сети;
16 - проблема подавлена;
25 - тег события;
26 - значение тега события.

Возможные значения, если eventsource объекта Action object установлен в значение «событие, созданное правилом обнаружения»:
7 - IP-адрес узла сети;
8 - тип обнаруженного сервиса;
9 - порт обнаруженного сервиса;
10 - статус обнаружения;
11 - длительность доступности или недоступности;
12 - полученное значение;
18 - правило обнаружения;
19 - проверка обнаружения;
20 - прокси;
21 - объект обнаружения.

Возможные значения, если eventsource объекта Action object установлен в значение «событие, созданное активной авторегистрацией агента»:
20 - прокси;
22 - имя узла сети;
24 - метаданные узла сети.

Возможные значения, если eventsource объекта Action object установлен в значение «внутреннее событие»:
0 - группа узлов сети;
1 - узел сети;
13 - шаблон узла сети;
23 - тип события;
25 - тег события;
26 - значение тега события.

Возможные значения, если eventsource объекта Action object установлен в значение «событие, созданное при обновлении состояния сервиса»:
25 - тег события;
26 - значение тега события;
27 - сервис;
28 - имя сервиса.

Поведение свойства:
- обязательно
value string Значение для сравнения.

Поведение свойства:
- обязательно
value2 string Вторичное значение для сравнения.

Поведение свойства:
- обязательно, если eventsource объекта Action object установлен в значение «событие, созданное триггером», conditiontype установлен в любое возможное значение для действий по триггерам, а тип условия (см. ниже) — «26»
- обязательно, если eventsource объекта Action object установлен в значение «внутреннее событие», conditiontype установлен в любое возможное значение для внутренних действий, а тип условия (см. ниже) — «26»
- обязательно, если eventsource объекта Action object установлен в значение «событие, созданное при обновлении состояния сервиса», conditiontype установлен в любое возможное значение для действий сервиса, а тип условия (см. ниже) — «26»
formulaid string Произвольный уникальный идентификатор, который используется для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть задан пользователем при изменении условий фильтра, но будет сгенерирован заново при их последующем запросе.
operator integer Оператор условия.

Возможные значения:
0 - (по умолчанию) равно;
1 - не равно;
2 - содержит;
3 - не содержит;
4 - в;
5 - больше или равно;
6 - меньше или равно;
7 - не в;
8 - соответствует;
9 - не соответствует;
10 - Да;
11 - Нет.

Чтобы лучше понять, как использовать фильтры с различными типами выражений, смотрите примеры на страницах методов 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 связанного шаблона.
16 Проблема подавлена Да, Нет Значение не требуется: использование оператора «Да» означает, что проблема должна быть подавлена, «Нет» — не подавлена.
18 Правило обнаружения равно,
не равно		 ID правила обнаружения.
19 Проверка обнаружения равно,
не равно		 ID проверки обнаружения.
20 Прокси равно,
не равно		 ID прокси.
21 Объект обнаружения равно Тип объекта, который вызвал событие обнаружения.

Возможные значения:
1 - обнаруженный узел сети;
2 - обнаруженный сервис.
22 Имя узла сети содержит,
не содержит,
соответствует,
не соответствует		 Имя узла сети.
Для операторов соответствует и не соответствует в условиях авторегистрации поддерживается использование регулярного выражения.
23 Тип события равно Конкретное внутреннее событие.

Возможные значения:
0 - элемент данных в состоянии «не поддерживается»;
1 - элемент данных в состоянии «нормальное»;
2 - правило LLD в состоянии «не поддерживается»;
3 - правило LLD в состоянии «нормальное»;
4 - триггер в состоянии «неизвестно»;
5 - триггер в состоянии «нормальное».
24 Метаданные узла сети содержит,
не содержит,
соответствует,
не соответствует		 Метаданные автоматически зарегистрированного узла сети.
Поддерживается использование регулярного выражения для операторов соответствует и не соответствует.
25 Тег равно,
не равно,
содержит,
не содержит		 Тег события.
26 Значение тега равно,
не равно,
содержит,
не содержит		 Значение тега события.
27 Сервис равно,
не равно		 ID сервиса.
28 Имя сервиса равно,
не равно		 Имя сервиса.