Объект действия

Следующие объекты напрямую связаны с методом API action.

Действие

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

Property Type Description
actionid ID Идентификатор действия.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
esc_period string Продолжительность шага операции по умолчанию. Должна составлять не менее 60 секунд. Допускается указать количество секунд (например, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h) или пользовательский макрос.

Поведение свойства:
- поддерживается, если eventsource имеет значение "event created by a trigger", "internal event" или "event created on service status update"
eventsource integer Тип событий, которые будет обрабатывать действие.

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

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

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

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

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

Поведение свойства:
- поддерживается, если eventsource имеет значение "event created by a trigger"
pause_suppressed integer Определяет, приостанавливать ли эскалацию во время периодов обслуживания.

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

Поведение свойства:
- поддерживается, если eventsource имеет значение "event created by a trigger"
notify_if_canceled integer Определяет, отправлять ли уведомление при отмене эскалации.

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

Поведение свойства:
- поддерживается, если eventsource имеет значение "event created by a trigger"

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

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

Property Type Description
operationtype integer Тип операции.

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

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

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

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

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

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

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

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

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

Поведение свойства:
- поддерживается, если eventsource объекта Action имеет значение "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".

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

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

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

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

Поведение свойства:
- поддерживается, если operationtype объекта Action operation object, Action recovery operation object, или Action update operation object установлено в "send message", или если operationtype объекта Action update operation object установлено в "notify all involved"
message string Текст сообщения операции.

Поведение свойства:
- поддерживается, если default_msg установлено в "use the data from the operation"
subject string Тема сообщения операции.

Поведение свойства:
- поддерживается, если default_msg установлено в "use the data from the operation"

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

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

Property Type Description
conditiontype integer Тип условия.

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

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

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

Возможные значения:
0 - (default) =

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

Condition Condition name Supported operators Expected value
14 Событие подтверждено = Подтверждено ли событие.

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

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

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

Property Type Description
operationtype integer Тип операции.

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

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

Поведение свойства:
- 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 Объект, содержащий данные о сообщении, отправляемом операцией восстановления.

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

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

Группы пользователей должны иметь определенное свойство usrgrpid.

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

Пользователи должны иметь определенное свойство userid.

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

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

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

Property Type Description
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 не задано

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

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

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

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

Возможные значения:
0 - And/Or;
1 - And;
2 - Or;
3 - Custom expression.

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

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

Поведение свойства:
- required если evaltype установлено в "custom expression"

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

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

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

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

Возможные значения, если eventsource объекта Action установлен в "event created by a discovery rule":
7 - IP-адрес узла сети;
8 - тип обнаруженной службы;
9 - порт обнаруженной службы;
10 - статус обнаружения;
11 - длительность работы или простоя;
12 - полученное значение;
18 - правило обнаружения;
19 - проверка обнаружения;
20 - прокси;
21 - объект обнаружения;
29 - группа прокси.

Возможные значения, если eventsource объекта Action установлен в "event created by active agent autoregistration":
20 - прокси;
22 - имя узла сети;
24 - метаданные узла сети;
29 - группа прокси.

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

Возможные значения, если eventsource объекта Action установлен в "event created on service status update":
25 - тег события;
26 - значение тега события;
27 - служба;
28 - имя службы.

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

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

Поведение свойства:
- обязательное, если eventsource объекта Action установлен в "event created by a trigger", conditiontype установлен в любое возможное значение для действий триггера, а тип условия (см. ниже) равен "26"
- обязательное, если eventsource объекта Action установлен в "internal event", conditiontype установлен в любое возможное значение для внутренних действий, а тип условия (см. ниже) равен "26"
- обязательное, если eventsource объекта Action установлен в "event created on service status update", conditiontype установлен в любое возможное значение для действий службы, а тип условия (см. ниже) равен "26"
formulaid string Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть задан пользователем при изменении условий фильтра, но при последующем запросе условий будет сгенерирован заново.
operator integer Оператор условия.

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

Чтобы лучше понять, как использовать фильтры с различными типами выражений, см. примеры на страницах методов action.get и action.create.

Ниже перечислены операторы и значения, поддерживаемые для каждого типа условия.

Условие Название условия Поддерживаемые операторы Ожидаемое значение
0 Группа узлов сети равно,
не равно		 Идентификатор группы узлов сети.
1 Узел сети равно,
не равно		 Идентификатор узла сети.
2 Триггер равно,
не равно		 Идентификатор триггера.
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 Шаблон узла сети равно,
не равно		 Идентификатор связанного шаблона.
16 Проблема подавлена Да, Нет Значение не требуется: оператор "Да" означает, что проблема должна быть подавлена, а "Нет" - что проблема не должна быть подавлена.
18 Правило обнаружения равно,
не равно		 Идентификатор правила обнаружения.
19 Проверка обнаружения равно,
не равно		 Идентификатор проверки обнаружения.
20 Прокси равно,
не равно		 Идентификатор прокси.
21 Объект обнаружения равно Тип объекта, вызвавшего событие обнаружения.

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

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