На странице

Объект прототипа правила LLD

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

Прототип правила НОР

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

Свойство Тип Описание
itemid ID ID прототипа правила НОР.

Поведение свойства:
- только для чтения
- обязательно для операций обновления
ruleid ID ID родительского правила НОР или прототипа правила НОР.

Поведение свойства:
- только для чтения
- обязательно для операций создания
delay string Интервал обновления прототипа правила НОР.

Принимает количество секунд (например, 1, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h, 1d) или, опционально, один или несколько пользовательских интервалов, разделенных точками с запятой. Пользовательские интервалы могут представлять собой сочетание гибких интервалов и интервалов расписания.

Поддерживает пользовательские макросы. При использовании значение должно состоять из одного макроса. Несколько макросов или макросы в сочетании с текстом не поддерживаются. Гибкие интервалы можно записывать как два макроса, разделенных косой чертой (например, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

Пример:
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

Поведение свойства:
- обязательно, если type имеет значение "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), "Telemetry query" (24), или если type имеет значение "Zabbix agent (active)" (7), а key_ не содержит "mqtt.get"
hostid ID ID узла сети, которому принадлежит прототип правила НОР.

Поведение свойства:
- постоянное
- обязательно для операций создания
flags integer Источник прототипа правила НОР.

Возможные значения:
3 - прототип правила низкоуровневого обнаружения;
7 - обнаруженный прототип правила низкоуровневого обнаружения.

Поведение свойства:
- только для чтения
interfaceid ID ID интерфейса узла сети прототипа правила НОР.

Поведение свойства:
- обязательно, если прототип правила НОР принадлежит узлу сети, а type имеет значение "Zabbix agent", "IPMI agent", "JMX agent" или "SNMP agent"
- поддерживается, если прототип правила НОР принадлежит узлу сети, а type имеет значение "Simple check", "External check", "SSH agent", "TELNET agent" или "HTTP agent"
key_ string Ключ прототипа правила НОР. Требуется как минимум один макрос НОР.

Поведение свойства:
- обязательно для операций создания
- только для чтения для унаследованных объектов
name string Имя прототипа правила НОР.

Поведение свойства:
- обязательно для операций создания
- только для чтения для унаследованных объектов
type integer Тип прототипа правила НОР.

Возможные значения:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
16 - JMX agent;
18 - Dependent item;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser;
23 - Nested;
24 - Telemetry query.

Поведение свойства:
- обязательно для операций создания
- только для чтения для унаследованных объектов
url string Строка URL.
Поддерживает пользовательские макросы, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}.

Поведение свойства:
- обязательно, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
allow_traps integer Разрешить заполнение значения аналогично элементу данных типа trapper.

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

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
authtype integer Метод аутентификации.

Возможные значения, если type имеет значение "SSH agent":
0 - (по умолчанию) пароль;
1 - открытый ключ.

Возможные значения, если type имеет значение "HTTP agent":
0 - (по умолчанию) отсутствует;
1 - basic;
2 - NTLM.

Поведение свойства:
- поддерживается, если type имеет значение "SSH agent" или "HTTP agent"
- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent")
description string Описание прототипа правила НОР.
error string Текст ошибки, если возникли проблемы при обновлении значения прототипа правила НОР.

Поведение свойства:
- только для чтения
follow_redirects integer Следовать перенаправлениям ответа при опросе данных.

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

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
headers array Массив заголовков, отправляемых при выполнении HTTP-запроса.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
http_proxy string Строка подключения HTTP(S)-прокси.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
ipmi_sensor string Датчик IPMI.

Поведение свойства:
- обязательно, если type имеет значение "IPMI agent", а key_ не имеет значение "ipmi.get"
- поддерживается, если type имеет значение "IPMI agent"
- только для чтения для унаследованных объектов
jmx_endpoint string Пользовательская строка подключения агента JMX.

По умолчанию: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Поведение свойства:
- поддерживается, если type имеет значение "JMX agent"
lifetime string Период времени, по истечении которого элементы данных, обнаружение которых больше не выполняется, будут удалены. Принимает количество секунд (например, 1, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h, 1d) или пользовательский макрос.

По умолчанию: 7d.
lifetime_type integer Сценарий удаления потерянных ресурсов НОР.

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

По умолчанию: 0.
enabled_lifetime_type integer Сценарий отключения потерянных ресурсов НОР.

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

Поведение свойства:
- обязательно, если type имеет значение "Dependent item"
- только для чтения для унаследованных объектов
output_format integer Следует ли преобразовать ответ в JSON.

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

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
params string Дополнительные параметры в зависимости от типа прототипа правила НОР:
- выполняемый скрипт для правил НОР SSH и Telnet;
- SQL-запрос для правил НОР мониторинга баз данных;
- формула для вычисляемых правил НОР;
- скрипт для правил НОР типа Script и Browser.

Поведение свойства:
- обязательно, если type имеет значение "Database monitor", "SSH agent", "TELNET agent", "Script" или "Browser"
- только для чтения для унаследованных объектов (если type имеет значение "Script" или "Browser")
parameters object/array Дополнительные параметры, если type имеет значение "Script" или "Browser".
Массив объектов со свойствами name и value, где name должно быть уникальным.

Поведение свойства:
- поддерживается, если type имеет значение "Script" или "Browser"
- только для чтения для унаследованных объектов
password string Пароль для аутентификации.

Поведение свойства:
- обязательно, если type имеет значение "JMX agent" и задано username
- поддерживается, если type имеет значение "Simple check", "Database monitor", "SSH agent", "TELNET agent" или "HTTP agent"
- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent")
post_type integer Тип тела данных POST, хранящегося в свойстве posts.

Возможные значения:
0 - (по умолчанию) необработанные данные;
2 - данные JSON;
3 - данные XML.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
posts string Данные тела HTTP(S)-запроса.

Поведение свойства:
- обязательно, если type имеет значение "HTTP agent", а post_type имеет значение "JSON data" или "XML data"
- поддерживается, если type имеет значение "HTTP agent", а post_type имеет значение "Raw data"
- только для чтения для унаследованных объектов
privatekey string Имя файла закрытого ключа.

Поведение свойства:
- обязательно, если type имеет значение "SSH agent", а authtype имеет значение "public key"
publickey string Имя файла открытого ключа.

Поведение свойства:
- обязательно, если type имеет значение "SSH agent", а authtype имеет значение "public key"
query_fields array Массив полей запроса, отправляемых при выполнении HTTP-запроса.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
request_method integer Тип метода запроса.

Возможные значения:
0 - (по умолчанию) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
retrieve_mode integer Какая часть ответа должна быть сохранена.

Возможные значения, если request_method имеет значение "GET", "POST" или "PUT":
0 - (по умолчанию) тело;
1 - заголовки;
2 - сохранить тело и заголовки.

Возможные значения, если request_method имеет значение "HEAD":
1 - заголовки.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
snmp_oid string OID SNMP.

Поведение свойства:
- обязательно, если type имеет значение "SNMP agent"
- только для чтения для унаследованных объектов
ssl_cert_file string Путь к файлу открытого ключа SSL.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
ssl_key_file string Путь к файлу закрытого ключа SSL.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
ssl_key_password string Пароль для файла ключа SSL.

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
state integer Состояние прототипа правила НОР.

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

Поведение свойства:
- только для чтения
status integer Состояние прототипа правила НОР.

Возможные значения:
0 - (по умолчанию) включенный прототип правила НОР;
1 - отключенный прототип правила НОР.
status_codes string Диапазоны требуемых кодов состояния HTTP, разделенные запятыми. Также поддерживает пользовательские макросы в списке, разделенном запятыми.

Пример: 200,200-{$M},{$M},200-400

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
templateid ID ID родительского прототипа правила НОР шаблона.

Поведение свойства:
- только для чтения
timeout string Тайм-аут запроса на опрос данных элемента данных.
Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m). Также поддерживает пользовательские макросы.

Допустимый диапазон значений: 1-600s.

По умолчанию: "" - использовать настройки прокси или глобальные настройки.

Поведение свойства:
- поддерживается, если type имеет значение "Zabbix agent" (0), "Simple check" (3), а key_ не начинается с "vmware." и "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20), а snmp_oid начинается с "walk[" или "get[", "Script" (21), "Browser" (22), "Telemetry query" (24)
- только для чтения для унаследованных объектов
trapper_hosts string Разрешенные узлы сети.

Поведение свойства:
- поддерживается, если type имеет значение "Zabbix trapper" или если type имеет значение "HTTP agent", а allow_traps имеет значение "Allow incoming data".
Если свойство не указано, ему автоматически присваивается пользовательский макрос {$TRAPPER.ALLOWED_HOSTS} (значение по умолчанию). По умолчанию {$TRAPPER.ALLOWED_HOSTS} имеет значение 127.0.0.1,::1.
Если свойству присвоена пустая строка, входящие подключения от всех узлов сети будут запрещены.
username string Имя пользователя для аутентификации.

Поведение свойства:
- обязательно, если type имеет значение "SSH agent", "TELNET agent" или если type имеет значение "JMX agent" и задан password
- поддерживается, если type имеет значение "Simple check", "Database monitor" или "HTTP agent"
- только для чтения для унаследованных объектов (если type имеет значение "HTTP agent")
uuid string Универсальный уникальный идентификатор, используемый для связывания импортированных прототипов правил НОР с уже существующими. Создается автоматически, если не указан.

Поведение свойства:
- поддерживается, если прототип правила НОР принадлежит шаблону
verify_host integer Следует ли проверять соответствие имени узла сети для подключения имени, указанному в сертификате узла сети.

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

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
verify_peer integer Следует ли проверять подлинность сертификата узла сети.

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

Поведение свойства:
- поддерживается, если type имеет значение "HTTP agent"
- только для чтения для унаследованных объектов
query object Конфигурация запроса телеметрии. Определяет, какие данные прототип правила НОР запрашивает из источника данных телеметрии, как фильтрует данные и как агрегирует результат.

Поведение свойства:
- обязательно, если type имеет значение "Telemetry query"
- только для чтения для унаследованных объектов
time_shift string Минимальный интервал между концом временного диапазона запроса и текущим временем.

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы и макросы НОР.

Допустимый диапазон значений: 0-86400s.

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

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"
lookback_limit string Насколько далеко в прошлое (до конца временного диапазона запроса) начинается временной диапазон запроса, если:
- отсутствует предыдущий запрос, который можно продолжить (например, при первом запуске прототипа правила НОР);
- продолжение предыдущего запроса сделало бы временной диапазон запроса длиннее, чем lookback_limit (например, из-за недоступности сервера Zabbix).

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы и макросы НОР.

Допустимый диапазон значений: 1-259200s.

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

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"
granularity string Длительность сегмента, на который разбивается временной диапазон запроса.

Принимает количество секунд (например, 1, 60, 300) или значение с суффиксом времени (например, 30s, 1m, 2h, 1d). Также поддерживает пользовательские макросы и макросы НОР.

Значение не может быть больше lookback_limit.

Допустимый диапазон значений: 1-86400s.

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

Поведение свойства:
- поддерживается, если type имеет значение "Telemetry query"

HTTP-заголовок

Объект заголовка имеет следующие свойства:

Свойство Тип Описание
name string Имя HTTP-заголовка.

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

Поведение свойства:
- обязательно

Поле HTTP-запроса

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

Свойство Тип Описание
name string Имя параметра.

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

Поведение свойства:
- обязательно

Запрос телеметрии

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

Property Type Description
signal_type integer Тип сигнала, который запрашивает прототип правила LLD.

Возможные значения:
0 - Трассировки;
1 - Метрики;
2 - Журналы.

Поведение свойства:
- обязательное
metric_point_type integer Тип точки метрики, который запрашивает прототип правила LLD.

Возможные значения:
0 - Сумма;
1 - Измерение;
2 - Гистограмма;
3 - Экспоненциальная гистограмма.

Поведение свойства:
- обязательное, если для signal_type задано значение "Metrics"
columns array Массив столбцов данных телеметрии, которые запрашивает прототип правила LLD. Может быть пустым.

Поведение свойства:
- обязательное
aggregated_columns array Массив агрегированных столбцов данных телеметрии, которые запрашивает прототип правила LLD, а также способ вычисления значения на основе записей столбцов.

Поведение свойства:
- обязательное
filter object Фильтр запроса телеметрии для записей столбцов в запросе.

Поведение свойства:
- обязательное
Столбцы данных телеметрии

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

Property Type Description
column string Имя столбца данных телеметрии, к которому обращается прототип правила LLD.
См. поддерживаемые столбцы данных телеметрии.

Для нескольких столбцов с одиночными значениями каждое значение column должно быть уникальным. Для нескольких столбцов, содержащих пары «ключ-значение», каждая пара column и attribute_key должна быть уникальной.
attribute_key string Имя ключа, к которому обращается прототип правила LLD в столбце, содержащем пары «ключ-значение».

Для нескольких столбцов, содержащих пары «ключ-значение», каждая пара column и attribute_key должна быть уникальной.

Поведение свойства:
- обязательно, если для column задан столбец, содержащий пары «ключ-значение»
Агрегированные столбцы данных телеметрии

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

Property Type Description
column string Имя столбца данных телеметрии, к которому обращается прототип правила LLD.
См. поддерживаемые столбцы данных телеметрии.

Для нескольких столбцов каждое значение column должно быть уникальным.

Это свойство не поддерживается, если для function установлено значение "Count".

Поведение свойства:
- обязательно, если для function установлено значение "Min", "Max", "Average", "Sum" или "Percentile"
function integer Функция, которую прототип правила LLD применяет к записям столбца.

Возможные значения:
1 - Min;
2 - Max;
3 - Average;
4 - Count;
5 - Sum;
8 - Percentile.

Поведение свойства:
- обязательно
parameters array Процентиль, который прототип правила LLD вычисляет по записям столбца.

Возможное значение: число от 0 до 100, заданное в виде строки.

Поведение свойства:
- обязательно, если для function установлено значение "Percentile"
alias string Уникальное имя вычисленного значения, используемое для его идентификации в значении прототипа правила LLD.

Каждое значение alias должно быть уникальным и не может быть равно clock.

Поведение свойства:
- обязательно
Фильтр данных телеметрии

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

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

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

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

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

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

Поведение свойства:
- обязательное, если для evaltype установлено значение "Пользовательское выражение"
Условия фильтрации данных телеметрии

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

Property Type Description
column string Имя столбца данных телеметрии, к которому применяется условие фильтрации.
См. поддерживаемые столбцы данных телеметрии.

Поведение свойства:
- обязательное
attribute_key string Имя ключа, к которому применяется условие, в столбце, содержащем пары «ключ-значение».

Поведение свойства:
- обязательное, если column задан как столбец, содержащий пары «ключ-значение»
operator integer Оператор условия фильтрации.

Возможные значения для столбцов с одиночными значениями:
0 - Равно;
1 - Не равно;
2 - Содержит;
3 - Не содержит.

Возможные значения для столбцов, содержащих пары «ключ-значение»:
0 - Равно;
1 - Не равно;
12 - Существует.

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

Поведение свойства:
- обязательное, если operator задан как «Равно», «Не равно», «Содержит» или «Не содержит»
formulaid string Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть задан пользователем при изменении условий фильтрации, но при последующем запросе условий будет сгенерирован заново.

Поведение свойства:
- обязательное, если evaltype объекта фильтра телеметрического запроса задан как «Пользовательское выражение»

Фильтр прототипа правила LLD

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

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

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

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

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

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

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

Условие фильтра прототипа правила LLD

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

Свойство Type Описание
macro string Макрос LLD, для которого выполняется проверка.

Property behavior:
- required
value string Значение для сравнения.

Property behavior:
- required if operator is set to "matches regular expression" or "does not match regular expression"
formulaid string Произвольный уникальный идентификатор, используемый для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть задан пользователем при изменении условий фильтра, но будет сгенерирован заново при их последующем запросе.

Property behavior:
- required if evaltype of объект фильтра прототипа правила LLD is set to "custom expression"
operator integer Оператор условия.

Возможные значения:
8 - (по умолчанию) соответствует регулярному выражению;
9 - не соответствует регулярному выражению;
12 - существует;
13 - не существует.

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

Путь макроса LLD

Путь макроса LLD имеет следующие свойства:

Свойство Type Описание
lld_macro string Макрос LLD.

Поведение свойства:
- обязательно
path string Селектор значения, которое будет присвоено соответствующему макросу.

Поведение свойства:
- обязательно

Предобработка прототипа правила LLD

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

Свойство Тип Описание
type integer Тип параметра предобработки.

Возможные значения:
5 - Регулярное выражение;
11 - XML XPath;
12 - JSONPath;
14 - Соответствует регулярному выражению;
15 - Не соответствует регулярному выражению;
16 - Проверка наличия ошибки в JSON;
17 - Проверка наличия ошибки в XML;
20 - Отбрасывать неизменившиеся значения с контролем доступности;
21 - JavaScript;
23 - Prometheus в JSON;
24 - CSV в JSON;
25 - Замена;
27 - XML в JSON;
28 - Значение SNMP walk;
29 - SNMP walk в JSON;
30 - Значение SNMP get.

Поведение свойства:
- обязательное
params string Дополнительные параметры, используемые параметром предобработки. Несколько параметров разделяются символом новой строки (\n).

Поведение свойства:
- обязательное, если для type установлено значение «Регулярное выражение» (5), «XML XPath» (11), «JSONPath» (12), «Соответствует регулярному выражению» (14), «Не соответствует регулярному выражению» (15), «Проверка наличия ошибки в JSON» (16), «Проверка наличия ошибки в XML» (17), «Отбрасывать неизменившиеся значения с контролем доступности» (20), «JavaScript» (21), «Prometheus в JSON» (23), «CSV в JSON» (24), «Замена» (25), «Значение SNMP walk» (28), «SNMP walk в JSON» (29) или «Значение SNMP get» (30)
error_handler integer Тип действия, выполняемого в случае сбоя шага предобработки.

Возможные значения:
0 - Сообщение об ошибке задается сервером Zabbix;
1 - Отбросить значение;
2 - Установить пользовательское значение;
3 - Установить пользовательское сообщение об ошибке.

Поведение свойства:
- обязательное, если для type установлено значение «Регулярное выражение» (5), «XML XPath» (11), «JSONPath» (12), «Соответствует регулярному выражению» (14), «Не соответствует регулярному выражению» (15), «Проверка наличия ошибки в JSON» (16), «Проверка наличия ошибки в XML» (17), «Prometheus в JSON» (23), «CSV в JSON» (24), «XML в JSON» (27), «Значение SNMP walk» (28), «SNMP walk в JSON» (29) или «Значение SNMP get» (30)
error_handler_params string Параметры обработчика ошибок.

Поведение свойства:
- обязательное, если для error_handler установлено значение «Установить пользовательское значение» или «Установить пользовательское сообщение об ошибке»

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

Тип предобработки Название Параметр 1 Параметр 2 Параметр 3 Поддерживаемые обработчики ошибок
5 Регулярное выражение pattern1 output2 0, 1, 2, 3
11 XML XPath path3 0, 1, 2, 3
12 JSONPath path3 0, 1, 2, 3
14 Соответствует регулярному выражению pattern1 0, 1, 2, 3
15 Не соответствует регулярному выражению pattern1 0, 1, 2, 3
16 Проверка наличия ошибки в JSON path3 0, 1, 2, 3
17 Проверка наличия ошибки в XML path3 0, 1, 2, 3
20 Отбрасывать неизменившиеся значения с контролем доступности seconds4, 5
21 JavaScript script2
23 Prometheus в JSON pattern5, 6 0, 1, 2, 3
24 CSV в JSON character2 character2 0,1 0, 1, 2, 3
25 Замена search string2 replacement2
27 XML в JSON 0, 1, 2, 3
28 Значение SNMP walk OID2 Формат:
0 - Без изменений
1 - UTF-8 из Hex-STRING
2 - MAC из Hex-STRING
3 - Целое число из BITS
0, 1, 2, 3
29 SNMP walk в JSON7 Имя поля2 Префикс OID2 Формат:
0 - Без изменений
1 - UTF-8 из Hex-STRING
2 - MAC из Hex-STRING
3 - Целое число из BITS
0, 1, 2, 3
30 Значение SNMP get Формат:
1 - UTF-8 из Hex-STRING
2 - MAC из Hex-STRING
3 - Целое число из BITS
0, 1, 2, 3

1 регулярное выражение
2 строка
3 JSONPath или XML XPath
4 положительное целое число (с поддержкой суффиксов времени, например 30s, 1m, 2h, 1d)
5 пользовательский макрос
6 шаблон Prometheus, соответствующий синтаксису: <metric name>{<label name>="<label value>", ...} == <value>. Каждый компонент шаблона Prometheus (метрика, имя метки, значение метки и значение метрики) может быть пользовательским макросом.
7 Поддерживает несколько записей «Имя поля,Префикс OID,Формат», разделенных символом новой строки.

Переопределения прототипов правил LLD

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

Свойство Type Описание
name string Уникальное имя переопределения.

Поведение свойства:
- обязательно
step integer Уникальный порядковый номер переопределения.

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

Возможные значения:
0 - (по умолчанию) не останавливать обработку переопределений;
1 - остановить обработку переопределений, если фильтр совпадает.
filter object Фильтр переопределения.
operations object/array Операции переопределения.

Фильтр переопределения прототипа правила LLD

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

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

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

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

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

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

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

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

Свойство Type Описание
macro string Макрос LLD, для которого выполняется проверка.

Property behavior:
- required
value string Значение для сравнения.

Property behavior:
- required if operator is set to "matches regular expression" or "does not match regular expression"
formulaid string Произвольный уникальный идентификатор, который используется для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. Идентификатор должен быть определён пользователем при изменении условий фильтра, но будет сгенерирован заново при их последующем запросе.

Property behavior:
- required if evaltype of объект фильтра переопределения прототипа правила LLD is set to "custom expression"
operator integer Оператор условия.

Возможные значения:
8 - (по умолчанию) соответствует регулярному выражению;
9 - не соответствует регулярному выражению;
12 - существует;
13 - не существует.

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

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

Свойство Type Описание
operationobject integer Тип обнаруженного объекта, для которого выполняется действие.

Возможные значения:
0 - Прототип элемента данных;
1 - Прототип триггера;
2 - Прототип графика;
3 - Прототип узла сети.

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

Возможные значения:
0 - (по умолчанию) равно;
1 - не равно;
2 - содержит;
3 - не содержит;
8 - соответствует;
9 - не соответствует.
value string Шаблон для сопоставления с именем прототипа элемента данных, триггера, графика или узла сети в зависимости от выбранного объекта.
opstatus object Объект статуса операции переопределения для объектов прототипа элемента данных, триггера и узла сети.
opdiscover object Объект статуса обнаружения операции переопределения (для всех типов объектов).
opperiod object Объект периода операции переопределения (интервала обновления) для объекта прототипа элемента данных.
ophistory object Объект истории операции переопределения для объекта прототипа элемента данных.
optrends object Объект трендов операции переопределения для объекта прототипа элемента данных.
opseverity object Объект важности операции переопределения для объекта прототипа триггера.
optag object/array Объект тега операции переопределения для объектов прототипа триггера и узла сети.
optemplate object/array Объект шаблона операции переопределения для объекта прототипа узла сети.
opinventory object Объект инвентаризации операции переопределения для объекта прототипа узла сети.
Статус операции переопределения прототипа правила LLD

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

Свойство Type Описание
status integer Переопределяет статус для выбранного объекта.

Возможные значения:
0 - Создать включённым;
1 - Создать отключённым.

Поведение свойства:
- обязательно
Операция переопределения обнаружения для прототипа правила LLD

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

Свойство Type Описание
discover integer Переопределяет статус обнаружения для выбранного объекта.

Возможные значения:
0 - Да, продолжать обнаружение объектов;
1 - Нет, новые объекты не будут обнаруживаться, а существующие будут помечены как потерянные.

Поведение свойства:
- обязательно
Период операции переопределения прототипа правила LLD

Период операции переопределения прототипа правила LLD — это значение интервала обновления, заданное для обнаруженного элемента данных. Он имеет следующие свойства:

Property Type Description
delay string Переопределяет интервал обновления прототипа элемента данных.

Принимает количество секунд (например, 1, 60, 300), значение с суффиксом времени (например, 30s, 1m, 2h, 1d) или, опционально, один или несколько пользовательских интервалов, разделённых точками с запятой. Пользовательские интервалы могут представлять собой комбинацию гибких интервалов и интервалов расписания.

Поддерживает пользовательские макросы или макросы LLD. При использовании значение должно состоять из одного макроса. Несколько макросов или макросы, объединённые с текстом, не поддерживаются. Гибкие интервалы можно записывать как два макроса, разделённых косой чертой (например, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).

Пример:
1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}

Поведение свойства:
- обязательное
История операции переопределения прототипа правила LLD

Значение истории операции переопределения прототипа правила LLD, которое устанавливается для обнаруженного элемента данных. Имеет следующие свойства:

Свойство Type Описание
history string Переопределяет историю прототипа элемента данных, то есть единицу времени, в течение которой должны храниться исторические данные. Также принимает пользовательский макрос и макрос LLD.

Поведение свойства:
- обязательно
Тенденции операции переопределения прототипа правила LLD

Значение тенденций операции переопределения прототипа правила LLD, которое задаётся для обнаруженного элемента данных. Оно имеет следующие свойства:

Свойство Type Описание
trends string Переопределяет тенденции прототипа элемента данных, то есть единицу времени, в течение которой данные тенденций должны храниться. Также принимает пользовательский макрос и макрос LLD.

Поведение свойства:
- обязательно
Значение важности операции переопределения прототипа правила LLD

Значение важности операции переопределения прототипа правила LLD, которое устанавливается для обнаруженного триггера. Имеет следующие свойства:

Свойство Тип Описание
severity integer Переопределяет важность прототипа триггера.

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

Поведение свойства:
- обязательно
Тег операции переопределения прототипа правила LLD

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

Свойство Type Описание
tag string Новое имя тега.

Поведение свойства:
- обязательно
value string Новое значение тега.
Шаблон операции переопределения прототипа правила LLD

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

Свойство Type Описание
templateid ID Переопределяет шаблон среди связанных шаблонов прототипа узла сети.

Поведение свойства:
- обязательно
Значение режима инвентаризации операции переопределения прототипа правила LLD

Значение режима инвентаризации операции переопределения прототипа правила LLD, которое устанавливается для обнаруженного узла сети. Имеет следующие свойства:

Свойство Type Описание
inventory_mode integer Переопределяет режим инвентаризации прототипа узла сети.

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

Поведение свойства:
- обязательно