Sidebar

Zabbix Summit 2022
Register for Zabbix Summit 2022

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

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

Действие

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

Свойство Тип Описание
actionid строка (только чтение) ID действия.
esc_period
(требуется)
строка Длительность шага операции по умолчанию. Должна быть дольше 60 секунд. Принимает секунду, единицы времени с суффиксом и пользовательские макросы.

Обратите внимание, что эскалации поддерживаются только для действий триггеров и сервисов, а так же внутренних действий и только в обычных операциях.
eventsource
(required)
целое число (константа) Тип событий, которые будет обрабатывать действие

Обратитесь к свойству событий "source" для получения списка поддерживаемых типов событий.
name
(required)
строка Имя действия.
status целое число Активировано действие или деактивировано.

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

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

Обратите внимание, что этот параметр действителен только для действий триггера.
notify_if_canceled целое число Оповещать о том, что эскалация отменена или нет.

Possible values:
0 - Не оповещять, о том что эскалация отменена;
1 - (по умолчанию) Оповещать об отмене эскалации.

Обратите внимание, что этот параметр действителен только для действий триггера.

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

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

Свойство Тип Описание
operationid строка (только чтение) ID операции действия.
operationtype
(required)
целое число Тип операции.

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

Обратите внимание, что для действий триггеров и сервисов поддерживаются только типы «0» и «1», а для внутренних действий — только «0». Все типы поддерживаются для действий обнаружения и авторегистрации.
actionid строка (только чтение) действия, которому принадлежит операция.
esc_period строка Длительность шага эскалации в секундах. Должна быть больше 60 секунд. Принимает секунды, единицы времени с суффиксом и пользовательские макросы. Если задано равным 0 или 0s, будет использоваться период эскалации действия по умолчанию .

Default: 0s.

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

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

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

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

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

Возможные значения:
0 - (по умолчанию) И / ИЛИ;
1 - И;
2 - ИЛИ.
opcommand объект Объект, который содержит данные о выполняемой команде в операции.

Каждый объект имеет следующие свойства: scriptid - (строка) ID скрипта.

Требуется для операций с удаленной командой.
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 массив Пользователи которым будут отправляться сообщения.

Each object has the following properties:
operationid - (строка, только чтение) ID операции;
userid - (строка) ID пользователя.

Требуется при операциях с сообщениями, если не задано opmessage_grp.
optemplate массив Шаблоны к которым будет присоединён узлы сети.

Каждый объект имеет следующие свойства:
operationid - (строка, только чтение) ID операции;
templateid - (строка) ID шаблона.

Требуется для операций "присоединение шаблона" и "отсоединение шаблона".
opinventory объект Режим инвентарных данных, который необходимо задать узлу сети.

Объект имеет следующие свойства:
operationid - (строка, только чтение) ID операции;
inventory_mode - (строка) Режим инвентарных данных.

Требуется для операций "Установить режим инвентарных данных узлов сети".

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

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

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

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

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

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

Свойство Тип Описание
opconditionid string (readonly) ID условия операции действия
conditiontype
(обязательно)
integer Тип условия.

Возможные значения:
14 - событие подтверждено.
value
(обязательно)
string Сравниваемое значение.
operationid string (readonly) ID операции.
operator integer Оператор условия.

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

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

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

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

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

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

Свойство Тип Описание
operationid string (readonly) ID операции действия.
operationtype
(обязательно)
integer Тип операции.

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

Возможные значения для внутренних действий:
0 - отправить сообщение;
11 - уведомить всех участников.
actionid string (readonly) ID действия которому принадлежит операция восстановления.
opcommand object Объект содержащий данные о глобальном сценарии действия запускаемом операцией.

Каждый объект имеет одно следующее свойство: scriptid - (string) ID типа действия сценария.

Требуется для глобальных операций скрипта.
opcommand_grp array Группы хостов для запуска глобальных скриптов.

Каждый объект имеет следующие свойства:
opcommand_grpid - (string, readonly) ID объекта;
operationid - (string, readonly) ID операции;
groupid - (string) ID группы хостов.

Требуется для глобальных операций скрипта, если opcommand_hst не установлено.
opcommand_hst array Хост для запуска глобальных скриптов.

Каждый объект имеет следующие свойства:
opcommand_hstid - (string, readonly) ID объекта;
operationid - (string, readonly) ID операции;
hostid - (string) ID хоста; если установлено значение 0, команда будет запущена на текущем хосте.

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

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

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

Каждый объект имеет следующие свойства:
operationid - (string, readonly) ID операции;
usrgrpid - (string) ID группы пользователей.

Требуется для операций с сообщениями если opmessage_usr не установлен.
opmessage_usr array Пользователи которым нужно отправлять сообщения.

Каждый объект имеет следующие свойства:
operationid - (string, readonly) ID операции;
userid - (string) ID пользователя.

Требуется для операций с сообщениями если opmessage_grp не установлен.

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

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

Свойство Тип Описание
operationid string (readonly) ID операции действия.
operationtype
(обязательно)
integer Тип операции.

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

Каждый объект имеет одно следующее свойство: scriptid - (string) ID действия типа скрипт.

Требуется для глобальных операций скрипта.
opcommand_grp array Группы хостов для запуска глобальных скриптов.

Каждый объект имеет следующие свойства:
groupid - (string) ID группы хостов.

Требуется для глобальных операций скрипта, если opcommand_hst не установлен.
opcommand_hst array Хост для запуска глобальных скриптов.

Каждый объект имеет следующие свойства:
hostid - (string) ID хоста; если установлено значение 0, команда будет запущена на текущем хосте.

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

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

Каждый объект имеет следующие свойства:
usrgrpid - (string) ID группы пользователей.

>Требуется только для операций send message если opmessage_usr не установлен.
Игнорируется для операций send update message.
opmessage_usr array Пользователи которым нужно отправлять сообщения.

Каждый объект имеет следующие свойства:
userid - (string) ID пользователя.

Обязательный только для операций send message, если opmessage_grp не установлен.
Игнорируется для операций send update message.

Действие фильтр

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

Свойство Тип Описание
conditions
(required)
array Набор условий фильтрации используемых для фильтрации результатов.
evaltype
(required)
integer Метод оценки условия фильтра.

Возможные значения:
0 - и/или;
1 - и;
2 - или;
3 - пользовательское выражение.
eval_formula string (readonly) Сгенерированное выражение которое будет использоваться для оценки условий фильтра. Выражение содержит идентификаторы которые ссылаются на определенные условия фильтрации по его формуле. Значение eval_formula равно значению formula для фильтров с пользовательским выражением.
formula string Определенное пользователем выражение которое будет использоваться для оценки условий фильтров с пользовательским выражением. Выражение должно содержать идентификаторы которые ссылаются на определенные условия фильтрации по его formulaid. Идентификаторы используемые в выражении должны точно совпадать с идентификаторами определенными в условиях фильтра: ни одно условие не может оставаться неиспользованным или пропущенным.

Требуется для настраиваемых выражений фильтров.

Действие условия фильтра

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

Свойство Тип Описание
conditionid string (readonly) ID действия условие.
conditiontype
(обязательно)
integer Тип состояния.

Возможные значения для действий триггера:
0 - группа хостов;
1 - узел сети;
2 - триггер;
3 - имя триггера;
4 - важность триггера;
6 - период времени;
13 - шаблон хоста;
16 - проблема подавлена;
25 - тег события;
26 - значение тега события.

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

Возможные значения для действий авторегистрации:
20 - прокси;
22 - имя узла сети;
24 - метаданные узла сети.

Возможные значения для внутренних действий:
0 - группа узлов сети;
1 - узел сети;
13 - шаблон узла сети;
23 - тип события;
25 - тег события;
26 - значение тега события.

Возможные значения для действий службы:
25 - тег события;
26 - значение тега события;
27 - служба;
28 - название службы.
value
(обязательно)
string Значение для сравнения.
value2
string Вторичное значение для сравнения. Требуется для триггерных, внутренних и сервисных действий, когда тип условия равен 26.
actionid string (readonly) Идентификатор действия которому принадлежит условие.
formulaid string Произвольный уникальный идентификатор который используется для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть определен пользователем при изменении условий фильтрации, но будет сгенерирован заново при последующем запросе.
operator integer Оператор условия.

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

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

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

Условие Название условия Поддерживаемые операторы Ожидаемое значение
0 Группа узлов сети равно,
не равно
Идентификатор группы хостов.
1 Узел сети равен,
не равен
Идентификатор хоста.
2 Триггер равен,
не равен
Идентификатор триггера.
3 Имя триггера содержит,
не содержит
Имя триггера.
4 Важность триггера равна,
не равна,
больше или равно,
меньше или равно
Важность триггера. Обратитесь к свойству trigger "severity" property для получения списка поддерживаемых степеней важности триггера.
5 Значение триггера равно Значению триггера. Обратитесь к свойству trigger "value" для получения списка поддерживаемых значений триггера.
6 Период времени в, не в
(in, not in)
Время, когда событие было запущено в период времени.
7 IP узла сети равно,
не равно
Один или несколько диапазонов IP для проверки, разделенных запятыми. Обратитесь к разделу конфигурация обнаружения сети для получения дополнительной информации о поддерживаемых форматах диапазонов IP.
8 Обнаруженный тип службы равен,
не равен
Типу обнаруженной службы. Тип службы соответствует типу проверки обнаружения используемой для обнаружения службы. Обратитесь к свойству проверка обнаружения "тип" для получения списка поддерживаемых типов.
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 Service равно,
не равно
Идентификатор службы.
28 Имя службы равно,
не равно
Имени службы.