Documentation
Table of Contents
- 2 Шаблоны
- Обзор
- Экспорт
- Импорт
- Формат экспорта
- Теги элементов
- Теги шаблона
- Теги элемента данных шаблона
- Template item value preprocessing steps
- Теги правил низкоуровневого обнаружения шаблона
- Template low-level discovery rule filters
- Template low-level discovery rule override operations
- Теги триггеров шаблона
- Теги веб-сценария шаблона
- Template web scenario steps
- Теги панели шаблона
- Template dashboard widgets
- Template value maps
2 Шаблоны
Обзор
Шаблоны экспортируются вместе со множеством связанных объектов и со связями с объектами.
Экспорт шаблона содержит:
- присоединенные группы узлов сети
- данные шаблона
- связи с другими шаблонами
- связи с группами узлов сети
- напрямую присоединенные элементы данных
- напрямую присоединенные триггеры
- напрямую присоединенные графики
- напрямую присоединенные панели
- напрямую присоединенные правила обнаружения со всеми прототипами
- напрямую присоединенные веб-сценарии
- преобразования значений
Экспорт
Для экспорта шаблонов выполните следующее:
- Перейдите в: Настройки → Шаблоны
- Отметьте шаблоны, которые нужно экспортировать
- Нажмите на Экспорт ниже списка
В зависимости от выбранного формата шаблоны будут экспортированы в локальный файл со следующим именем по умолчанию:
- zabbix_export_templates.yaml - в YAML экспорте (опция экспорта по умолчанию)
- zabbix_export_templates.xml - в XML экспорте
- zabbix_export_templates.json - в JSON экспорте
Импорт
Для импорта шаблонов выполните следующее:
- Перейдите в: Настройка → Шаблоны
- Нажмите на Импорт справа
- Выберите импортируемый файл
- Отметьте необходимые опции в правилах импорта
- Нажмите на Импорт
Все обязательные поля ввода отмечены красной звёздочкой.
Правила импорта:
| Правило | Описание |
|---|---|
| Обновить существующее | Существующие элементы будут обновлены данными взятыми с файла импорта. В противном случае они не будут обновляться. |
| Создать новое | Импорт добавит новые элементы, используя данные из файла импорта. В противном случае они не будут добавлены. |
| Удалить пропущенное | Импорт удалит существующие элементы, которые отсутствуют в файле импорта. В противном случае они не будут удаляться. Если для связи с шаблонами выбрана опция Удалить пропущенное, существующее присоединение к шаблону, но отсутствующее в файле импорта, будет удалено с шаблона вместе со всеми объектами, унаследованными от потенциально отсоединяемых шаблонов (элементы данных, триггеры и т.п.). |
На следующем экране вы можете просмотреть содержимое импортируемого шаблона. Если импортируемый шаблон новый, все перечисленные элементы будут зелеными. При обновлении существующего шаблона все новые элементы шаблона будут подсвечены зеленым; удаленные из шаблона элементы будут подсвечены красным; элементы, которые не изменились будут перечислены с серым фоном.
Меню слева можно использовать для перехода по списку изменений. Раздел Обновлено подсвечивает все изменения сделанные над существующими элементами шаблона. раздел Добавлено перечисляет новые элементы шаблона. Элементы каждой группы сгруппированы по типу элемента; нажмите на серую стрелку, чтобы развернуть или свернуть группу элементов.
Проверьте изменения шаблона, затем нажмите Импорт для подтверждения операции импорта шаблона. В веб-интерфейсе отобразится сообщение об успехе или об ошибке импорта.
Формат экспорта
<?xml version="1.0" encoding="UTF-8"?>
<zabbix_export>
<version>4.0</version>
<date>2018-04-03T06:25:22Z</date>
<groups>
<group>
<name>Templates/Databases</name>
</group>
</groups>
<templates>
<template>
<template>Template DB MySQL</template>
<name>Template DB MySQL</name>
<description/>
<groups>
<group>
<name>Templates/Databases</name>
</group>
</groups>
<applications>
<application>
<name>MySQL</name>
</application>
</applications>
<items>
<item>
<name>MySQL status</name>
<type>0</type>
<snmp_community/>
<snmp_oid/>
<key>mysql.ping</key>
<delay>1m</delay>
<history>1w</history>
<trends>365d</trends>
<status>0</status>
<value_type>3</value_type>
<allowed_hosts/>
<units/>
<snmpv3_contextname/>
<snmpv3_securityname/>
<snmpv3_securitylevel>0</snmpv3_securitylevel>
<snmpv3_authprotocol>0</snmpv3_authprotocol>
<snmpv3_authpassphrase/>
<snmpv3_privprotocol>0</snmpv3_privprotocol>
<snmpv3_privpassphrase/>
<params/>
<ipmi_sensor/>
<authtype>0</authtype>
<username/>
<password/>
<publickey/>
<privatekey/>
<port/>
<description>It requires user parameter mysql.ping, which is defined in userparameter_mysql.conf.
0 - MySQL server is down
1 - MySQL server is up</description>
<inventory_link>0</inventory_link>
<applications>
<application>
<name>MySQL</name>
</application>
</applications>
<valuemap>
<name>Service state</name>
</valuemap>
<logtimefmt/>
<preprocessing/>
<jmx_endpoint/>
<timeout>3s</timeout>
<url/>
<query_fields/>
<posts/>
<status_codes>200</status_codes>
<follow_redirects>1</follow_redirects>
<post_type>0</post_type>
<http_proxy/>
<headers/>
<retrieve_mode>0</retrieve_mode>
<request_method>1</request_method>
<output_format>0</output_format>
<allow_traps>0</allow_traps>
<ssl_cert_file/>
<ssl_key_file/>
<ssl_key_password/>
<verify_peer>0</verify_peer>
<verify_host>0</verify_host>
<master_item/>
</item>
<item>
<name>MySQL begin operations per second</name>
<type>0</type>
<snmp_community/>
<snmp_oid/>
<key>mysql.status[Com_begin]</key>
<delay>1m</delay>
<history>1w</history>
<trends>365d</trends>
<status>0</status>
<value_type>0</value_type>
<allowed_hosts/>
<units>qps</units>
<snmpv3_contextname/>
<snmpv3_securityname/>
<snmpv3_securitylevel>0</snmpv3_securitylevel>
<snmpv3_authprotocol>0</snmpv3_authprotocol>
<snmpv3_authpassphrase/>
<snmpv3_privprotocol>0</snmpv3_privprotocol>
<snmpv3_privpassphrase/>
<params/>
<ipmi_sensor/>
<authtype>0</authtype>
<username/>
<password/>
<publickey/>
<privatekey/>
<port/>
<description>It requires user parameter mysql.status[*], which is defined in userparameter_mysql.conf.</description>
<inventory_link>0</inventory_link>
<applications>
<application>
<name>MySQL</name>
</application>
</applications>
<valuemap/>
<logtimefmt/>
<preprocessing>
<step>
<type>10</type>
<params/>
</step>
</preprocessing>
<jmx_endpoint/>
<timeout>3s</timeout>
<url/>
<query_fields/>
<posts/>
<status_codes>200</status_codes>
<follow_redirects>1</follow_redirects>
<post_type>0</post_type>
<http_proxy/>
<headers/>
<retrieve_mode>0</retrieve_mode>
<request_method>1</request_method>
<output_format>0</output_format>
<allow_traps>0</allow_traps>
<ssl_cert_file/>
<ssl_key_file/>
<ssl_key_password/>
<verify_peer>0</verify_peer>
<verify_host>0</verify_host>
<master_item/>
</item>
<item>
<name>MySQL queries per second</name>
<type>0</type>
<snmp_community/>
<snmp_oid/>
<key>mysql.status[Questions]</key>
<delay>1m</delay>
<history>1w</history>
<trends>365d</trends>
<status>0</status>
<value_type>0</value_type>
<allowed_hosts/>
<units>qps</units>
<snmpv3_contextname/>
<snmpv3_securityname/>
<snmpv3_securitylevel>0</snmpv3_securitylevel>
<snmpv3_authprotocol>0</snmpv3_authprotocol>
<snmpv3_authpassphrase/>
<snmpv3_privprotocol>0</snmpv3_privprotocol>
<snmpv3_privpassphrase/>
<params/>
<ipmi_sensor/>
<authtype>0</authtype>
<username/>
<password/>
<publickey/>
<privatekey/>
<port/>
<description>It requires user parameter mysql.status[*], which is defined in userparameter_mysql.conf.</description>
<inventory_link>0</inventory_link>
<applications>
<application>
<name>MySQL</name>
</application>
</applications>
<valuemap/>
<logtimefmt/>
<preprocessing>
<step>
<type>10</type>
<params/>
</step>
</preprocessing>
<jmx_endpoint/>
<timeout>3s</timeout>
<url/>
<query_fields/>
<posts/>
<status_codes>200</status_codes>
<follow_redirects>1</follow_redirects>
<post_type>0</post_type>
<http_proxy/>
<headers/>
<retrieve_mode>0</retrieve_mode>
<request_method>1</request_method>
<output_format>0</output_format>
<allow_traps>0</allow_traps>
<ssl_cert_file/>
<ssl_key_file/>
<ssl_key_password/>
<verify_peer>0</verify_peer>
<verify_host>0</verify_host>
<master_item/>
</item>
</items>
<discovery_rules/>
<httptests/>
<macros/>
<templates/>
<screens>
<screen>
<name>MySQL performance</name>
<hsize>2</hsize>
<vsize>1</vsize>
<screen_items>
<screen_item>
<resourcetype>0</resourcetype>
<width>500</width>
<height>200</height>
<x>0</x>
<y>0</y>
<colspan>1</colspan>
<rowspan>1</rowspan>
<elements>0</elements>
<valign>1</valign>
<halign>0</halign>
<style>0</style>
<url/>
<dynamic>0</dynamic>
<sort_triggers>0</sort_triggers>
<resource>
<name>MySQL operations</name>
<host>Template DB MySQL</host>
</resource>
<max_columns>3</max_columns>
<application/>
</screen_item>
</screen_items>
</screen>
</screens>
</template>
</templates>
<triggers>
<trigger>
<expression>{Template DB MySQL:mysql.ping.last(0)}=0</expression>
<recovery_mode>0</recovery_mode>
<recovery_expression/>
<name>MySQL is down</name>
<correlation_mode>0</correlation_mode>
<correlation_tag/>
<url/>
<status>0</status>
<priority>2</priority>
<description/>
<type>0</type>
<manual_close>0</manual_close>
<dependencies/>
<tags/>
</trigger>
</triggers>
<graphs>
<graph>
<name>MySQL operations</name>
<width>900</width>
<height>200</height>
<yaxismin>0.0000</yaxismin>
<yaxismax>100.0000</yaxismax>
<show_work_period>1</show_work_period>
<show_triggers>1</show_triggers>
<type>0</type>
<show_legend>1</show_legend>
<show_3d>0</show_3d>
<percent_left>0.0000</percent_left>
<percent_right>0.0000</percent_right>
<ymin_type_1>0</ymin_type_1>
<ymax_type_1>0</ymax_type_1>
<ymin_item_1>0</ymin_item_1>
<ymax_item_1>0</ymax_item_1>
<graph_items>
<graph_item>
<sortorder>0</sortorder>
<drawtype>0</drawtype>
<color>C8C800</color>
<yaxisside>0</yaxisside>
<calc_fnc>2</calc_fnc>
<type>0</type>
<item>
<host>Template DB MySQL</host>
<key>mysql.status[Com_begin]</key>
</item>
</graph_item>
</graph_items>
</graph>
</graphs>
<value_maps>
<value_map>
<name>Service state</name>
<mappings>
<mapping>
<value>0</value>
<newvalue>Down</newvalue>
</mapping>
<mapping>
<value>1</value>
<newvalue>Up</newvalue>
</mapping>
</mappings>
</value_map>
</value_maps>
</zabbix_export>Теги элементов
Значения тегов элементов описаны в таблице ниже.
Теги шаблона
| Элемент | Свойство элемента | Обязательный | Тип | Диапазон | Описание |
|---|---|---|---|---|---|
| templates | - | Корневой элемент шаблонов. | |||
| uuid | x | строка |
Уникальный идентификатор конкретного шаблона. | ||
| template | x | строка |
Уникальное имя шаблона. | ||
| name | - | строка |
Видимое имя шаблона. | ||
| description | - | текст |
Описание шаблона. | ||
| groups | x | Корневой элемент групп узлов сети шаблонов. | |||
| uuid | x | строка |
Уникальный идентификатор конкретной группы узлов сети. | ||
| name | x | строка |
Уникальное имя группы. | ||
| templates | - | Корневой элемент присоединенных шаблонов. | |||
| name | x | строка |
Имя шаблона. | ||
| tags | - | Корневой элемент тегов шаблона. | |||
| tag | x | строка |
Имя тега. | ||
| value | - | строка |
Значение тега. | ||
| macros | - | Корневой элемент макросов шаблона. | |||
| macro | x | строка |
Одиночный макрос шаблона. | ||
| type | - | строка |
0 - TEXT (по умолчанию) 1 - SECRET_TEXT 2 - VAULT |
Тип макроса. | |
| name | - | строка |
Имя пользовательского макроса. | ||
| value | - | строка |
Значение пользовательского макроса. | ||
| description | - | строка |
Описание пользовательского макроса. | ||
| valuemaps | - | Корневой элемент преобразований значений шаблона. | |||
| uuid | x | строка |
Уникальный идентификатор конкретного преобразования значений. | ||
| name | x | строка |
Имя преобразования значений. | ||
| mapping | - | Корневой элемент преобразований. | |||
| value | x | строка |
Значение преобразования. | ||
| newvalue | x | строка |
Новое значение преобразования. |
Теги элемента данных шаблона
| Элемент | Свойство элемента | Обязательный | Тип | Диапазон1 | Описание |
|---|---|---|---|---|---|
| items | - | Корневой элемент элементов данных. | |||
| uuid | x | строка |
Уникальный идентификатор элемента данных | ||
| name | x | строка |
Имя элемента данных. | ||
| type | - | строка |
0 - ZABBIX_PASSIVE (default) 2 - TRAP 3 - SIMPLE 5 - INTERNAL 7 - ZABBIX_ACTIVE 10 - EXTERNAL 11 - ODBC 12 - IPMI 13 - SSH 14 - TELNET 15 - CALCULATED 16 - JMX 17 - SNMP_TRAP 18 - DEPENDENT 19 - HTTP_AGENT 20 - SNMP_AGENT 21 - ITEM_TYPE_SCRIPT |
Тип элемента данных. | |
| snmp_oid | - | строка |
ID SNMP объекта. | ||
| key | x | строка |
Ключ элемента данных. | ||
| delay | - | строка |
По умолчанию: 1m | Интервал обновления элемента данных. Принимает секунды или единицы времени с суффиксом (30s, 1m, 2h, 1d). Опционально можно указать один и более пользовательских интервалов как гибких интервалов, так и интервалов по расписанию. Несколько интервалов отделяются при помощи двоеточия. Можно использовать пользовательские макросы. Один макрос должен занимать все поле. Несколько макросов в поле или макросы вместе с текстом не поддерживаются. Гибкие интервалы можно указывать в виде двух макросов с разделением прямой косой чертой (например, {$FLEX_INTERVAL}/{$FLEX_PERIOD}). |
|
| history | - | строка |
По умолчанию: 90d | Единица времени как долго хранить данные истории. Единица времени с суффиксом, пользовательский макрос или LLD макросы. | |
| trends | - | строка |
По умолчанию: 365d | Единица времени как долго хранить данные динамики изменений. Единица времени с суффиксом, пользовательский макрос или LLD макросы. | |
| status | - | целое число |
0 - ENABLED (по умолчанию) 1 - DISABLED |
Состояние элемента данных. | |
| value_type | - | строка |
0 - FLOAT 1 - CHAR 2 - LOG 3 - UNSIGNED (по умолчанию) 4 - TEXT |
Тип получаемого значения. | |
| allowed_hosts | - | строка |
Список IP адресов (разделенных запятыми) узлов сети, с которых разрешена отправка данных на элемент данных Используется элементами данных с типами траппер и HTTP агент. |
||
| units | - | строка |
Единицы измерений получаемых значений (bps, B и т.п.). | ||
| params | - | текст |
Дополнительные параметры, зависящие от типа элемента данных: - выполняемый скрипт для элементов данных с типами Скрипт, SSH и Telnet; - SQL запрос для элементов данных с типом монитор баз данных; - формула для вычисляемых элементов данных. |
||
| ipmi_sensor | - | строка |
ID IPMI сенсора. Используется только IPMI элементами данных. |
||
| authtype | - | строка |
Тип аутентификации для элементов данных типа SSH агент: 0 - PASSWORD (по умолчанию) 1 - PUBLIC_KEY Тип аутентификации для элементов данных типа HTTP агент: 0 - NONE (default) 1 - BASIC 2 - NTLM |
Тип аутентификации. Используется только элементами данных с типами SSH и HTTP агент. |
|
| username | - | строка |
Имя пользователя для аутентификации. Используется элементами данных с типами простая проверка, SSH, Telnet, монитор баз данных, JMX и HTTP агент. Требуется SSH и Telnet элементам данных. При использовании с JMX агентом пароль также должен быть указан вместе с именем пользователя или оба свойства должны быть пустыми. |
||
| password | - | строка |
Пароль для аутентификации. Используется элементами данных с типами простая проверка, SSH, Telnet, монитор баз данных, JMX и HTTP агент. При использовании с JMX агентом имя пользователя также должно быть указано вместе с именем пользователя или оба свойства должны быть пустыми. |
||
| publickey | - | строка |
Имя файла публичного ключа Требуемся SSH агент элементам данных. |
||
| privatekey | - | строка |
Имя файла приватного ключа Требуемся SSH агент элементам данных. |
||
| port | - | строка |
Пользовательский порт элемента данных. Может содержать пользовательские макросы. Используется только SNMP элементами данных. |
||
| description | - | текст |
Описание элемента данных. | ||
| inventory_link | - | строка |
0 - NONE Имя поля инвентарных данных в верхнем регистре. Например: 4 - ALIAS 6 - OS_FULL 14 - HARDWARE и т.п. |
Поле инвентарных данных, которое заполняется элементом данных. Обратитесь к странице инвентарных данных узлов сети для получения списка поддерживаемых полей инвентарных данных и их ID. |
|
| logtimefmt | - | строка |
Формат времени в записях в журнале. Используется только журнал (лог) элементами данных. |
||
| jmx_endpoint | - | строка |
JMX endpoint. Используется только JMX агент элементами данных. |
||
| url | - | строка |
Строка URL. Требуется только HTTP агент элементам данных. |
||
| allow_traps | - | строка |
0 - NO (по умолчанию) 1 - YES |
Свойство позволяет отправку данных на элемент данных Используется только HTTP агент элементами данных. |
|
| follow_redirects | - | строка |
0 - NO 1 - YES (по умолчанию). |
Следование перенаправлениям HTTP ответа Используется только HTTP агент элементами данных. |
|
| headers | - | Корневой элемент заголовков HTTP(S) запроса, где имя заголовка используется ключем, а значение заголовка значением. Используется только HTTP агент элементами данных. |
|||
| name | x | строка |
Имя заголовка. | ||
| value | x | строка |
Значение заголовка. | ||
| http_proxy | - | строка |
Строка подключения к HTTP(S) прокси Используется только HTTP агент элементами данных. |
||
| output_format | - | строка |
0 - RAW (по умолчанию) 1 - JSON |
Каким образом обрабатывать ответ Используется только HTTP агент элементами данных. |
|
| post_type | - | строка |
0 - RAW (по умолчанию) 2 - JSON 3 - XML |
Тип тела post данных. Используется только HTTP агент элементами данных. |
|
| posts | - | строка |
Данные тела HTTP(S) запроса. Используется только HTTP агент элементами данных. |
||
| query_fields | - | Корневой элемент для параметров запроса. Используется только HTTP агент элементами данных. |
|||
| name | x | строка |
Имя параметра. | ||
| value | - | строка |
Значение параметра. | ||
| request_method | - | строка |
0 - GET (по умолчанию) 1 - POST 2 - PUT 3 - HEAD |
Метод запроса. Используется только HTTP агент элементами данных. |
|
| retrieve_mode | - | строка |
0 - BODY (default) 1 - HEADERS 2 - BOTH |
Какую часть ответа нужно записывать. Используется только HTTP агент элементами данных. |
|
| ssl_cert_file | - | строка |
Путь к файлу публичного ключа SSL. Используется только HTTP агент элементами данных. |
||
| ssl_key_file | - | строка |
Путь к файлу приватного ключа SSL. Используется только HTTP агент элементами данных. |
||
| ssl_key_password | - | строка |
Пароль к файлу SSL ключа. Используется только HTTP агент элементами данных. |
||
| status_codes | - | строка |
Диапазоны требуемых кодов HTTP состояний, разделенные запятыми. Поддерживаются пользовательские макросы. Например: 200,200-{$M},{$M},200-400 Используется только HTTP агент элементами данных. |
||
| timeout | - | строка |
Время ожидания при выполнении запроса данных элемента данных. Поддерживаются пользовательские макросы. Используется только HTTP агент элементами данных. |
||
| verify_host | - | строка |
0 - NO (по умолчанию) 1 - YES |
Проверка имени узла в URL в полях Common Name или Subject Alternate Name сертификата хоста. Используется только HTTP агент элементами данных. |
|
| verify_peer | - | строка |
0 - NO (по умолчанию) 1 - YES |
Проверка подлинности сертификата хоста. Используется только HTTP агент элементами данных. |
|
| parameters | - | Корневой элемент пользовательских параметров. Используется только Скрипт элементами данных. |
|||
| name | x | строка |
Имя параметра. Используется только Скрипт элементами данных. |
||
| value | - | строка |
Значение параметра. Используется только Скрипт элементами данных. |
||
| value map | - | Преобразование значений. | |||
| name | x | строка |
Имя преобразования значений, которое используется элементом данных. | ||
| preprocessing | - | Корневой элемент предварительной обработки элемента данных. | |||
| step | - | Отдельный шаг предварительной обработки значений элемента данных. | |||
| type | x | строка |
1 - MULTIPLIER 2 - RTRIM 3 - LTRIM 4 - TRIM 5 - REGEX 6 - BOOL_TO_DECIMAL 7 - OCTAL_TO_DECIMAL 8 - HEX_TO_DECIMAL 9 - SIMPLE_CHANGE (вычисляется как (полученное значение-предыдущее значение)) 10 - CHANGE_PER_SECOND (вычисляется как (полученное значение-предыдущее значение)/(текущее время-время последней проверки)) 11 - XMLPATH 12 - JSONPATH 13 - IN_RANGE 14 - MATCHES_REGEX 15 - NOT_MATCHES_REGEX 16 - CHECK_JSON_ERROR 17 - CHECK_XML_ERROR 18 - CHECK_REGEX_ERROR 19 - DISCARD_UNCHANGED 20 - DISCARD_UNCHANGED_HEARTBEAT 21 - JAVASCRIPT 22 - PROMETHEUS_PATTERN 23 - PROMETHEUS_TO_JSON 24 - CSV_TO_JSON 25 - STR_REPLACE 26 - CHECK_NOT_SUPPORTED |
Тип шага предварительной обработки значений элемента данных. | |
| parameters | - | Корневой элемент параметров шага предварительной обработки значений элемента данных. | |||
| parameter | x | строка |
Конкретный параметр шага предварительной обработки значений элемента данных. | ||
| error_handler | - | строка |
0 - ORIGINAL_ERROR (по умолчанию) 1 - DISCARD_VALUE 2 - CUSTOM_VALUE 3 - CUSTOM_ERROR |
Тип действия, используемого в случае ошибки на шаге предварительной обработки. | |
| error_handler_params | - | строка |
Параметры обработки ошибки, используемой с 'error_handler'. | ||
| master_item | - | Конкретный элемент основного элемента данных. Требуется зависимым элементам данных. |
|||
| key | x | строка |
Значение ключа основного элемента данных зависимого элемента данных. Допускается рекурсия до 3 зависимых элементов данных и максимальное количество зависимых элементов данных равно 29999. |
||
| triggers | - | Корневой элемент простых триггеров. | |||
| Для значений тегов элементов триггеров смотрите теги триггеров шаблонов. | |||||
| tags | - | Корневой элемент тегов элемента данных. | |||
| tag | x | строка |
Имя тега. | ||
| value | - | строка |
Значение тега. |
Template item value preprocessing steps
| Element | Type | Description | |
|---|---|---|---|
| type | string | (required) The item value preprocessing step type. Possible values:1 MULTIPLIER (1), RTRIM (2), LTRIM (3), TRIM (4), REGEX (5), BOOL_TO_DECIMAL (6), OCTAL_TO_DECIMAL (7), HEX_TO_DECIMAL (8), SIMPLE_CHANGE (9, calculated: received value - previous value), CHANGE_PER_SECOND (10, calculated: (received value - previous value)/(time now - time of last check)), XMLPATH (11), JSONPATH (12), IN_RANGE (13), MATCHES_REGEX (14), NOT_MATCHES_REGEX (15), CHECK_JSON_ERROR (16), CHECK_XML_ERROR (17), CHECK_REGEX_ERROR (18), DISCARD_UNCHANGED (19), DISCARD_UNCHANGED_HEARTBEAT (20), JAVASCRIPT (21), PROMETHEUS_PATTERN (22), PROMETHEUS_TO_JSON (23), CSV_TO_JSON (24), STR_REPLACE (25), CHECK_NOT_SUPPORTED (26), XML_TO_JSON (27), SNMP_WALK_VALUE (28), SNMP_WALK_TO_JSON (29), SNMP_GET_VALUE (30). |
|
| parameters | (required) Root element for parameters of the item value preprocessing step. | ||
| parameter | string | Individual parameter of the item value preprocessing step. | |
| error_handler | string | Action type used in case of preprocessing step failure. Possible values:1 ORIGINAL_ERROR (0, default), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3). |
|
| error_handler_params | string | Error handler parameters. | |
See also: Item preprocessing object (refer to the relevant property with a matching name).
Теги правил низкоуровневого обнаружения шаблона
| Элемент | Свойство элемента | Требуемый | Тип | Диапазон | Описание |
|---|---|---|---|---|---|
| discovery_rules | - | Корневой элемент правил низкоуровневого обнаружения. | |||
| По большинству значений тегов элементов, смотрите значения тегов элементов обычных элементов данных. Ниже описаны только те теги, которые являются специфичными для правил низкоуровневого обнаружения. | |||||
| type | - | строка |
0 - ZABBIX_PASSIVE (по умолчанию) 2 - TRAP 3 - SIMPLE 5 - INTERNAL 7 - ZABBIX_ACTIVE 10 - EXTERNAL 11 - ODBC 12 - IPMI 13 - SSH 14 - TELNET 16 - JMX 18 - DEPENDENT 19 - HTTP_AGENT 20 - SNMP_AGENT |
Тип элемента данных. | |
| lifetime | - | строка |
По умолчанию: 30d | Период времени после которого элементы данных, которые более не обнаруживаются, будут удалены. Секунды, единицы времени с суффиксом или пользовательский макрос. | |
| filter | Одиночный фильтр. | ||||
| evaltype | - | строка |
0 - AND_OR (по умолчанию) 1 - AND 2 - OR 3 - FORMULA |
Логика использования условий фильтра для проверки правила низкоуровневого обнаружения. | |
| formula | - | строка |
Пользовательская формула вычисления условий фильтрации. | ||
| conditions | - | Корневой элемент условий фильтров. | |||
| macro | x | строка |
Имя макроса низкоуровневого обнаружения. | ||
| value | - | строка |
Значение фильтра: регулярное выражение или глобальное регулярное выражение. | ||
| operator | - | строка |
8 - MATCHES_REGEX (по умолчанию) 9 - NOT_MATCHES_REGEX |
Оператор условия. | |
| formulaid | x | символ |
Произвольный уникальный ID, который используется ссылкой на условие из пользовательского выражения. Может содержать только заглавные буквы. ID должен быть задан пользователем при изменении условий фильтра, но он будет сгенерирован заново при последующем запросе. | ||
| lld_macro_paths | - | Корневой элемент для путей LLD макросов. | |||
| lld_macro | x | строка |
Имя макроса низкоуровневого обнаружения. | ||
| path | x | строка |
Селектор значения, которое будет присвоено соответствующему макросу. | ||
| preprocessing | - | Предварительная обработка значений LLD правила. | |||
| step | - | Конкретное значение шага предварительной обработки LLD правила. | |||
| По большинству значений тегов элементов, смотрите значения тегов элементов предварительной обработки значений элементов данных шаблона. Ниже описаны только те теги, которые являются специфичными для предварительной обработки значений правил низкоуровневого обнаружения шаблона. | |||||
| type | x | строка |
5 - REGEX 11 - XMLPATH 12 - JSONPATH 15 - NOT_MATCHES_REGEX 16 - CHECK_JSON_ERROR 17 - CHECK_XML_ERROR 20 - DISCARD_UNCHANGED_HEARTBEAT 21 - JAVASCRIPT 23 - PROMETHEUS_TO_JSON 24 - CSV_TO_JSON 25 - STR_REPLACE |
Тип шага предварительной обработки значений элементов данных. | |
| trigger_prototypes | - | Корневой элемент прототипов триггеров. | |||
| По большинству значений тегов элементов прототипов триггеров, смотрите значения тегов элементов обычных триггеров шаблона. | |||||
| graph_prototypes | - | Корневой элемент прототипов графиков. | |||
| По большинству значений тегов элементов прототипов графиков, смотрите значения тегов элементов обычных графиков шаблона. | |||||
| host_prototypes | - | Корневой элемент прототипов узлов сети. | |||
| По большинству значений тегов элементов прототипов узлов сети, смотрите значения тегов элементов обычных узлов сети. | |||||
| item_prototypes | - | Корневой элемент прототипов элементов данных. | |||
| По большинству значений тегов элементов прототипов элементов данных, смотрите значения тегов элементов обычных элементов данных шаблона. | |||||
| master_item | - | Конкретные данные прототипа элементов данных основного элемента данных / прототипа элементов данных. | |||
| key | x | строка |
Значение ключа зависимого прототипа элементов данных основного элемента данных / прототипа элементов данных. Требуется зависимому элементу данных. |
Template low-level discovery rule filters
| Element | Type | Description | |
|---|---|---|---|
| evaltype | string | Override filter condition evaluation method. Possible values:1 AND_OR (0, default), AND (1), OR (2), FORMULA (3). |
|
| formula | string | Custom calculation formula for filter conditions. | |
| conditions | Root element for filter conditions. | ||
| macro | string | (required) The name of the low-level discovery macro to perform the check on. | |
| value | string | Value to compare with. | |
| operator | string | Condition operator. Possible values:1 MATCHES_REGEX (8, default), NOT_MATCHES_REGEX (9). |
|
| formulaid | string | (required) Arbitrary unique ID that is used to reference a condition from the custom expression. Can only contain capital-case letters. The ID must be defined by the user when modifying filter conditions, but will be generated anew when requesting them afterward. | |
See also: LLD rule filter object (refer to the relevant property with a matching name).
Template low-level discovery rule override operations
| Element | Type | Description | |
|---|---|---|---|
| operationobject | string | Object to which the operation is applied. Possible values:1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3). |
|
| operator | string | Override condition operator. Possible values:1 EQUAL (1), NOT_EQUAL (2), LIKE (3), NOT_LIKE (4), REGEXP (5), NOT_REGEXP (6). |
|
| value | string | A regular expression or a string for the override condition operator. | |
| status | string | Status of the object upon the override operation. | |
| discover | string | Whether the object is added as a result of the discovery. | |
| delay | string | Update interval set for the item prototype upon the override operation. | |
| history | string | History storage period set for the item prototype upon the override operation. | |
| trends | string | Trend storage period set for the item prototype upon the override operation. | |
| severity | string | Trigger prototype severity set upon the override operation. | |
| tags | Root element for the tags set for the object upon the override operation. | ||
| tag | string | (required) Tag name. | |
| value | string | Tag value. | |
| templates | Root element for the templates linked to the host prototype upon the override operation. | ||
| name | string | (required) Template name. | |
| inventory_mode | string | Host prototype inventory mode set upon the override operation. | |
See also: LLD rule override operation object (refer to the relevant property with a matching name).
Теги триггеров шаблона
| Элемент | Свойство элемента | Требуемый | Тип | Диапазон1 | Описание |
|---|---|---|---|---|---|
| triggers | - | Корневой элемент триггеров. | |||
| uuid | x | строка |
Уникальный идентификатор конкретного триггера. | ||
| expression | x | строка |
Выражение триггера. | ||
| recovery_mode | - | строка |
0 - EXPRESSION (по умолчанию) 1 - RECOVERY_EXPRESSION 2 - NONE |
Основа генерирования ОК событий. | |
| recovery_expression | - | строка |
Выражение восстановления триггера. | ||
| name | x | строка |
Имя триггера. | ||
| correlation_mode | - | строка |
0 - DISABLED (по умолчанию) 1 - TAG_VALUE |
Режим корреляции (без корреляции событий или корреляция событий по тегу). | |
| correlation_tag | - | строка |
Имя тега используемое для корреляции событий. | ||
| url | - | строка |
URL связанный с триггером. | ||
| status | - | строка |
0 - ENABLED (по умолчанию) 1 - DISABLED |
Состояние триггера. | |
| priority | - | строка |
0 - NOT_CLASSIFIED (по умолчанию) 1 - INFO 2 - WARNING 3 - AVERAGE 4 - HIGH 5 - DISASTER |
Важность триггера. | |
| description | - | текст |
Описание триггера. | ||
| type | - | строка |
0 - SINGLE (по умолчанию) 1 - MULTIPLE |
Тип формирования событий (одиночное событие о проблеме или множественные события о проблемах). | |
| manual_close | - | строка |
0 - NO (по умолчанию) 1 - YES |
Ручное закрытие событий о проблемах. | |
| dependencies | - | Корневой элемент зависимостей. | |||
| name | x | строка |
Имя триггера от которого имеется зависимость. | ||
| expression | x | строка |
Выражение триггера от которого имеется зависимость. | ||
| recovery_expression | - | строка |
Выражение восстановления триггера от которого имеется зависимость. | ||
| tags | - | Корневой элемент тегов триггера. | |||
| tag | x | строка |
Имя тега. | ||
| value | - | строка |
Значение тега. |
Теги веб-сценария шаблона
| Элемент | Свойство элемента | Требуемый | Тип | Диапазон1 | Описание |
|---|---|---|---|---|---|
| httptests | - | Корневой элемент веб-сценариев. | |||
| uuid | x | строка |
Уникальный идентификатор конкретного веб-сценария. | ||
| name | x | строка |
Имя веб-сценария. | ||
| delay | - | строка |
По умолчанию: 1m | Частота выполнения веб-сценария. Секунды, единицы времени с суффиксом или пользовательский макрос. | |
| attempts | - | целое число |
1-10 (по умолчанию: 1) | Количество попыток выполнения шагов веб-сценария. | |
| agent | - | строка |
По умолчанию: Zabbix | Агент клиента. Zabbix будет притворяться выбранным браузером. Эта опция полезна, когда веб-сайт возвращает разное содержимое для разных браузеров. | |
| http_proxy | - | строка |
Укажите используемый HTTP прокси, используя следующий формат: http://[имя пользователя[:пароль]@]прокси.example.com[:порт] |
||
| variables | - | Корневой элемент переменных (макросов) уровня сценария, которые могут использоваться в шагах сценария. | |||
| name | x | текст |
Имя переменной. | ||
| value | x | текст |
Значение переменной. | ||
| headers | - | Корневой элемент HTTP заголовков, которые будут отправлены при выполнении запроса. Заголовки нужно перечислять с использованием такого же синтаксиса, что и в HTTP протоколе. | |||
| name | x | текст |
Имя заголовка. | ||
| value | x | текст |
Значение заголовка. | ||
| status | - | строка |
0 - ENABLED (по умолчанию) 1 - DISABLED |
Состояние веб-сценария. | |
| authentication | - | строка |
0 - NONE (по умолчанию) 1 - BASIC 2 - NTLM |
Метод аутентификации. | |
| http_user | - | строка |
Имя пользователя для простой, HTTP или NTLM аутентификации. | ||
| http_password | - | строка |
Пароль для простой, HTTP или NTLM аутентификации. | ||
| verify_peer | - | строка |
0 - NO (по умолчанию) 1 - YES |
Проверка SSL сертификата веб-сервера. | |
| verify_host | - | строка |
0 - NO (по умолчанию) 1 - YES |
Проверка, что поле Общее Имя или поле Дополнительное Имя Субъекта сертификата веб-сервера совпадают. | |
| ssl_cert_file | - | строка |
Имя используемого файла SSL сертификата для аутентификации клиента (должно быть в формате PEM). | ||
| ssl_key_file | - | строка |
Имя используемого файла приватного ключа SSL для аутентификации клиента (должно быть в формате PEM). | ||
| ssl_key_password | - | строка |
Пароль к файлу приватного ключа SSL. | ||
| steps | x | Корневой элемент шагов веб-сценария. | |||
| name | x | строка |
Имя шага веб-сценария. | ||
| url | x | строка |
Наблюдаемый URL. | ||
| query_fields | - | Корневой элемент полей запроса - массив HTTP полей, которые будут добавлены к URL при выполнении запроса. | |||
| name | x | строка |
Имя поля запроса. | ||
| value | - | строка |
Значение поля запроса. | ||
| posts | - | Переменные HTTP POST в виде строки (сырые post данные) или в виде массива HTTP полей (данные полей формы). | |||
| name | x | строка |
Имя post поля. | ||
| value | x | строка |
Значение post поля. | ||
| variables | - | Корневой элемент переменных (макросов) уровня шага, которые будут применены после этого шага. Если значение переменной имеет префикс 'regex:', тогда ее значение извлекается из данных, которые получены на этом шаге, в соответствии с шаблоном регулярного выражения следующим за 'regex:' префиксом |
|||
| name | x | текст |
Имя переменной. | ||
| value | x | текст |
Значение переменной. | ||
| headers | - | Корневой элемент HTTP заголовков, которые будут отправлены при выполнении запроса. Заголовки нужно перечислять с использованием такого же синтаксиса, что и в HTTP протоколе. | |||
| name | x | текст |
Имя заголовка. | ||
| value | x | текст |
Значение заголовка. | ||
| follow_redirects | - | строка |
0 - NO 1 - YES (по умолчанию) |
Следовать HTTP перенаправлениям. | |
| retrieve_mode | - | строка |
0 - BODY (по умолчанию) 1 - HEADERS 2 - BOTH |
Режим получения HTTP ответа. | |
| timeout | - | строка |
По умолчанию: 15s | Время выполнения шага. Секунды, единицы времени с суффиксом или пользовательский макрос. | |
| required | - | строка |
Текст, который должен присутствовать в ответе. Игнорируется если пустой. | ||
| status_codes | - | строка |
Список допустимых HTTP кодов состояний разделенных запятыми. Игнорируется, если пустой. Например: 200-201,210-299 | ||
| tags | - | Корневой элемент тегов веб-сценария. | |||
| tag | x | строка |
Имя тега. | ||
| value | - | строка |
Значение тега. |
Template web scenario steps
| Element | Type | Description | |
|---|---|---|---|
| name | string | (required) Web scenario step name. | |
| url | string | (required) URL for monitoring. | |
| query_fields | Root element for query parameters (an array of HTTP fields to be added to the URL when performing a request). | ||
| name | string | (required) Query parameter name. | |
| value | string | Query parameter value. | |
| posts | Root element for HTTP POST variables (a string (raw post data) or an array of HTTP fields (form field data)). | ||
| name | string | (required) Post field name. | |
| value | string | (required) Post field value. | |
| variables | Root element of step-level variables (macros) that should be applied after this step. If the variable value has a 'regex:' prefix, then its value is extracted from the data returned by this step according to the regular expression pattern following the 'regex:' prefix |
||
| name | string | (required) Variable name. | |
| value | text | (required) Variable value. | |
| headers | Root element for HTTP headers to be sent when performing a request. | ||
| name | string | (required) Header name. | |
| value | text | (required) Header value. | |
| follow_redirects | string | Follow HTTP redirects. Possible values:1 NO (0), YES (1, default). |
|
| retrieve_mode | string | HTTP response retrieve mode. Possible values:1 BODY (0, default), HEADERS (1), BOTH (2). |
|
| timeout | string | Timeout (using seconds, time suffix, or user macro) of step execution. Default: 15s. |
|
| required | string | Text that must be present in the response (ignored if empty). | |
| status_codes | string | A comma-delimited list of accepted HTTP status codes (e.g., 200-201,210-299; ignored if empty). |
|
See also: Web scenario step object (refer to the relevant property with a matching name).
Теги панели шаблона
| Элемент | Свойство элемента | Обязательный | Тип | Диапазон1 | Описание |
|---|---|---|---|---|---|
| dashboards | - | Корневой элемент панелей шаблона. | |||
| uuid | x | строка |
Уникальный идентификатор конкретной панели. | ||
| name | x | строка |
Имя панели шаблона. | ||
| display period | - | целое число |
Период отображения страниц панели. | ||
| auto_start | - | строка |
0 - нет 1 - да |
Автоматический запуск слайд-шоу. | |
| pages | - | Корневой элемент страниц панели шаблона. | |||
| name | - | строка |
Имя страницы. | ||
| display period | - | целое число |
Период отображения страницы. | ||
| sortorder | - | целое число |
Порядок сортировки страниц. | ||
| widgets | - | Корневой элемент виджетов панели шаблона. | |||
| type | x | строка |
Тип виджета. | ||
| name | - | строка |
Имя виджета. | ||
| x | - | целое число |
0-23 | Позиция по горионтали от левого края панели шаблона. | |
| y | - | целое число |
0-62 | Позиция по вертикали от верхнего края панели шаблона. | |
| width | - | целое число |
1-24 | Ширина виджета. | |
| height | - | целое число |
2-32 | Высота виджета. | |
| hide_header | - | строка |
0 - нет 1 - да |
Скрывать заголовок виджета. | |
| fields | - | Корневой элемент полей виджета панели шаблона. | |||
| type | x | строка |
0 - ЦЕЛОЕ ЧИСЛО 1 - СТРОКА 3 - УЗЕЛ СЕТИ 4 - ЭЛЕМЕНТ ДАННЫХ 5 - ПРОТОТИП_ЭЛЕМЕНТОВ_ДАННЫХ 6 - ГРАФИК 7 - ПРОТОТИП_ГРАФИКОВ |
Тип поля виджета. | |
| name | x | строка |
Имя поля виджета. | ||
| value | x | смешанный | Значение поля виджета, зависит от типа поля. |
Template dashboard widgets
| Element | Type | Description | |
|---|---|---|---|
| type | string | (required) Widget type. | |
| name | string | Widget name. | |
| x | integer | Horizontal position from the left side of the template dashboard. Possible values:1 0-23. |
|
| y | integer | Vertical position from the top of the template dashboard. Possible values:1 0-62. |
|
| width | integer | Widget width. Possible values:1 1-24. |
|
| height | integer | Widget height. Possible values:1 2-32. |
|
| hide_header | string | Hide widget header. Possible values:1 NO (0, default), YES (1). |
|
| fields | Root element for the template dashboard widget fields. | ||
| type | string | (required) Widget field type. Possible values:1 INTEGER (0), STRING (1), ITEM (4), ITEM_PROTOTYPE (5), GRAPH (6), GRAPH_PROTOTYPE (7), MAP (8), SERVICE (9), SLA (10), USER (11), ACTION (12), MEDIA_TYPE (13). |
|
| name | string | (required) Widget field name. | |
| value | mixed | (required) Widget field value, depending on the field type. | |
See also: Template dashboard widget object (refer to the relevant property with a matching name).
Template value maps
| Element | Type | Description | |
|---|---|---|---|
| uuid | string | (required) Unique identifier for this value map. | |
| name | string | (required) Value map name. | |
| mapping | Root element for mappings. | ||
| type | string | Mapping match type. Possible values:1 EQUAL (0, default), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6). |
|
| value | string | Original value. | |
| newvalue | string | (required) Value to which the original value is mapped to. | |
See also: Value map object (refer to the relevant property with a matching name).
Заметки
1 Для строковых значений экспортируется только строка (например, "ZABBIX_ACTIVE") без использования нумерации из таблицы. Числовые диапазоны значений (соответствующие значениям API) в этой таблицы используются только для сортировки.