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

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

Действие

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

Property Type Description
actionid ID ID действия.

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

Поведение свойства:
- поддерживается, если 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 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".

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

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

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

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

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

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

Property behavior:
- supported если 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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Property behavior:
- required если operationtype установлен в "set host inventory mode"
optag array Теги узла сети, которые нужно добавить или удалить.

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

Property behavior:
- supported если 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"

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Condition Condition name Supported operators Expected value
0 Группа узлов сети equals,
does not equal		 ID группы узлов сети.
1 Узел сети equals,
does not equal		 ID узла сети.
2 Триггер equals,
does not equal		 ID триггера.
3 Имя события contains,
does not contain		 Имя события.
4 Серьезность триггера equals,
does not equal,
is greater than or equals,
is less than or equals		 Серьезность триггера. Список поддерживаемых уровней серьезности триггера см. в свойстве severity триггера.
5 Значение триггера equals Значение триггера. Список поддерживаемых значений триггера см. в свойстве value триггера.
6 Период времени in, not in Время, когда событие было сгенерировано, в виде периода времени.
7 IP узла сети equals,
does not equal		 Один или несколько диапазонов IP, разделенных запятыми. Дополнительные сведения о поддерживаемых форматах диапазонов IP см. в разделе конфигурации сетевого обнаружения.
8 Тип обнаруженной службы equals,
does not equal		 Тип обнаруженной службы. Тип службы соответствует типу проверки обнаружения, использованной для обнаружения службы. Список поддерживаемых типов см. в свойстве type проверки обнаружения.
9 Порт обнаруженной службы equals,
does not equal		 Один или несколько диапазонов портов, разделенных запятыми.
10 Статус обнаружения equals Статус обнаруженного объекта.

Возможные значения:
0 - узел сети или служба доступны;
1 - узел сети или служба недоступны;
2 - узел сети или служба обнаружены;
3 - узел сети или служба потеряны.
11 Длительность времени работы или простоя is greater than or equals,
is less than or equals		 Время в секундах, показывающее, как долго обнаруженный объект находится в текущем статусе.
12 Полученные значения equals,
does not equal,
is greater than or equals,
is less than or equals,
contains,
does not contain		 Значение, возвращаемое при выполнении проверки обнаружения Zabbix agent, SNMPv1, SNMPv2 или SNMPv3.
13 Шаблон узла сети equals,
does not equal		 ID связанного шаблона.
16 Проблема подавлена Yes, No Значение не требуется: использование оператора "Yes" означает, что проблема должна быть подавлена, "No" - не подавлена.
18 Правило обнаружения equals,
does not equal		 ID правила обнаружения.
19 Проверка обнаружения equals,
does not equal		 ID проверки обнаружения.
20 Прокси equals,
does not equal		 ID прокси.
21 Объект обнаружения equals Тип объекта, который вызвал событие обнаружения.

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

Возможные значения:
0 - элемент данных в состоянии "not supported";
1 - элемент данных в состоянии "normal";
2 - правило LLD в состоянии "not supported";
3 - правило LLD в состоянии "normal";
4 - триггер в состоянии "unknown";
5 - триггер в состоянии "normal".
24 Метаданные узла сети contains,
does not contain,
matches,
does not match		 Метаданные автоматически зарегистрированного узла сети.
Использование регулярного выражения поддерживается для операторов matches и does not match.
25 Тег equals,
does not equal,
contains,
does not contain		 Тег события.
26 Значение тега equals,
does not equal,
contains,
does not contain		 Значение тега события.
27 Служба equals,
does not equal		 ID службы.
28 Имя службы equals,
does not equal		 Имя службы.