3. Шаблоны

Обзор

Шаблоны экспортируются вместе со множеством связанных объектов и со связями между объектами.

Экспорт шаблона содержит:

  • Присоединённые группы шаблонов
  • Присоединённые группы узлов сети (если используются в настройках прототипа узла сети)
  • Данные шаблона
  • Связи с другими шаблонами
  • Связи с группами шаблонов
  • Напрямую присоединённые элементы данных
  • Напрямую присоединённые триггеры
  • Напрямую присоединённые графики
  • Напрямую присоединённые панели
  • Напрямую присоединённые правила обнаружения со всеми прототипами
  • Напрямую присоединённые веб-сценарии
  • Преобразования значений

Экспорт

Для экспорта шаблонов выполните следующее:

  1. Перейдите к: Сбор данныхШаблоны (Data collectionTemplates)
  2. Отметьте шаблоны, которые нужно экспортировать
  3. Нажмите на Экспорт (Export) ниже списка

В зависимости от выбранного формата шаблоны будут экспортированы в локальный файл со следующим именем по умолчанию:

  • zabbix_export_templates.yaml — при экспорте в YAML (опция экспорта по умолчанию);
  • zabbix_export_templates.xml — при экспорте в XML;
  • zabbix_export_templates.json — при экспорте в JSON.

Импорт

Чтобы импортировать шаблоны, выполните следующие действия:

  1. Перейдите в Сбор данныхШаблоны.
  2. Нажмите Импорт в правом верхнем углу.
  3. Выберите файл импорта.
  4. Нажмите Импорт в правом нижнем углу формы настройки.

Если установить флажок Дополнительные параметры, будет отображен подробный список всех элементов, доступных для импорта — отметьте или снимите отметку для каждого правила импорта по необходимости.

Если щелкнуть флажок в строке Все, все элементы ниже будут отмечены или сняты.

Правила импорта:

Правило Описание
Обновить существующие Существующие элементы будут обновлены с использованием данных из файла импорта. В противном случае они не будут обновлены.
Создать новые Новые элементы будут созданы с использованием данных из файла импорта. В противном случае они не будут созданы.
Удалить отсутствующие Существующие элементы, отсутствующие в файле импорта, будут удалены. В противном случае они не будут удалены.
Если для Связь шаблонов отмечено Удалить отсутствующие, текущая связь шаблонов, отсутствующая в файле импорта, будет разорвана. Наследуемые от отвязанных шаблонов сущности (элементы данных, триггеры, графики и т. д.) не будут удалены (если только для каждой такой сущности также не выбрана опция Удалить отсутствующие).

Если шаблоны с теми же именами уже существуют, при импорте следует отметить параметры Удалить отсутствующие, чтобы выполнить корректный импорт. Так будут удалены старые элементы, которые больше не присутствуют в обновленном шаблоне (учтите, что это приведет к потере истории этих старых элементов).

На следующем экране вы сможете просмотреть содержимое импортируемого шаблона. Если это новый шаблон, все элементы будут выделены зеленым цветом. При обновлении существующего шаблона новые элементы шаблона будут выделены зеленым цветом; удаленные элементы шаблона будут выделены красным; элементы, которые не изменились, будут отображаться на сером фоне.

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

Проверьте изменения шаблона, а затем нажмите Импорт, чтобы выполнить импорт шаблона. В веб-интерфейсе будет отображено сообщение об успешном завершении или ошибке импорта.

Формат экспорта

Когда шаблон экспортируется, Zabbix генерирует структурированный формат YAML, JSON или XML. Экспорт включает элементы шаблона, такие как метаданные шаблона, элементы данных, макросы, триггеры, дашборды и многое другое.

Каждый элемент выполняет определенную функцию и может содержать вложенные элементы.

В следующих разделах описан каждый элемент в формате экспорта. В примерах используется шаблон Linux by Zabbix agent.

Многоточие (...) обозначает элементы, опущенные для краткости. Примечание (see table below) используется, когда элемент объясняется более подробно в последующих разделах.

Метаданные шаблона

zabbix_export:
  version: '7.4'
  template_groups:
    - uuid: 846977d1dfed4968bc5f8bdb363285bc
      name: 'Templates/Operating systems'
  templates: (см. таблицу ниже)
  triggers: (см. таблицу ниже)
  graphs: (см. таблицу ниже)
Element Type Description
version string (обязательно) Версия экспорта.
template_groups (обязательно) Корневой элемент для групп шаблонов.
uuid string (обязательно) Уникальный идентификатор для этой группы шаблонов.
name string (обязательно) Имя группы шаблонов.
host_groups Корневой элемент для групп узлов сети, которые используются прототипами узлов сети.
uuid string (обязательно) Уникальный идентификатор для этой группы узлов сети.
name string (обязательно) Имя группы узлов сети.
templates Корневой элемент для шаблонов.
triggers Корневой элемент для элементов триггеров шаблона, которые совпадают с триггерами элементов данных шаблона.
graphs Корневой элемент для элементов графиков шаблона, которые совпадают с графиками узлов сети.

Шаблоны

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      template: 'Linux by Zabbix agent'
      name: 'Linux by Zabbix agent'
      description: |
        Это официальный шаблон Linux. Для него требуется Zabbix agent 7.4 или новее. (...)
      wizard_ready: 'YES'
      readme: |
        ## Обзор

        Это официальный шаблон Linux. Для него требуется Zabbix agent 7.4 или новее. (...)
      vendor:
        name: Zabbix
        version: 7.4-2
      groups:
        - name: 'Templates/Operating systems'
      items: (see table below)
      discovery_rules: (see table below)
      tags:
        - tag: class
          value: os
        - tag: target
          value: linux
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          value: 3m
          description: 'Тайм-аут, после которого агент считается недоступным. Работает только для агентов, доступных с сервера/прокси Zabbix (пассивный режим).'
          config: (see table below)
        - macro: '{$CPU.UTIL.CRIT}'
          value: '90'
          description: 'Критический порог загрузки CPU, выраженный в %.'
          config: (see table below)
        (...)
      dashboards: (see table below)
      valuemaps: (see table below)
    (...)
Element Type Description
uuid string (required) Уникальный идентификатор этого шаблона.
template string (required) Уникальное имя шаблона.
name string Отображаемое имя шаблона.
description text Описание шаблона.
wizard_ready text Доступен ли шаблон для выбора в Мастере узлов сети.
Возможные значения:1 NO (0, по умолчанию), YES (1).
См. также: Объект Template (wizard_ready).
readme text Инструкции по настройке, относящиеся к шаблону, для отображения в Мастере узлов сети. Поддерживает форматирование Markdown.
vendor Корневой элемент для поставщика шаблона (присутствует, если экспортированный шаблон содержит данные о поставщике).
name string (required) Имя поставщика шаблона.
version string (required) Версия шаблона.
Для готовых шаблонов версия отображается следующим образом: основная версия Zabbix, разделитель ("-"), номер ревизии (увеличивается с каждой новой версией шаблона и сбрасывается с каждой основной версией Zabbix). Например, 7.0-0, 7.0-3, 7.4-0, 7.4-3.
templates Корневой элемент для связанных шаблонов.
name string (required) Имя шаблона.
groups Корневой элемент для групп шаблонов.
name string (required) Имя группы шаблонов.
items Корневой элемент для элементов данных шаблона.
discovery_rules Корневой элемент для правил низкоуровневого обнаружения шаблона.
httptests Корневой элемент для веб-сценариев шаблона.
tags Корневой элемент для тегов шаблона.
tag string (required) Имя тега.
value string Значение тега.
macros Корневой элемент для пользовательских макросов шаблона.
macro string (required) Имя пользовательского макроса.
type string Тип пользовательского макроса.
Возможные значения:1 TEXT (0, по умолчанию), SECRET_TEXT (1), VAULT (2).
См. также: Объект User macro (type).
value string Значение пользовательского макроса.
description string Описание пользовательского макроса.
config Корневой элемент для конфигурации макроса шаблона, отвечающей за то, как макрос отображается в Мастере узлов сети.
dashboards Корневой элемент для панелей шаблона.
valuemaps Корневой элемент для карт значений шаблона.

Элементы шаблона

zabbix_export:
  (...)
  templates:
    (...)
      items:
        - uuid: f94f9f4699e94c369e6c98b2a2f485ce
          name: 'Пинг агента Zabbix'
          key: agent.ping
          description: 'Агент всегда возвращает "1" для этого элемента данных. Может использоваться в сочетании с `nodata()` для проверки доступности.'
          valuemap:
            name: 'Статус пинга агента Zabbix'
          tags:
            - tag: component
              value: system
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          name: 'Количество установленных пакетов'
          key: system.sw.packages.get
          delay: 1h
          preprocessing: (см. таблицу ниже)
          tags:
            - tag: component
              value: os
          triggers: (см. таблицу ниже)
        - uuid: 403cebed115441369e94d35d070ca7b8
          name: 'Использование памяти'
          type: DEPENDENT
          key: vm.memory.utilization
          value_type: FLOAT
          units: '%'
          description: 'Процент используемой памяти вычисляется как `100-pavailable`.'
          preprocessing: (см. таблицу ниже)
          master_item:
            key: 'vm.memory.size[pavailable]'
          tags:
            - tag: component
              value: memory
          triggers: (см. таблицу ниже)
        (...)
Элемент Тип Описание
uuid string (обязательно) Уникальный идентификатор этого элемента данных.
name string (обязательно) Имя элемента данных.
type string Тип элемента данных.
Возможные значения:1 ZABBIX_PASSIVE (0, по умолчанию), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), CALCULATED (15), JMX (16), SNMP_TRAP (17), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
snmp_oid string (обязательно для элементов данных SNMP_AGENT) Идентификатор объекта SNMP.
key string (обязательно) Ключ элемента данных.
delay string Интервал обновления элемента данных.
По умолчанию: 1m. Для элементов данных TRAP значение всегда будет 0.
history string Период времени (с использованием суффикса времени, пользовательского макроса или LLD-макроса), в течение которого должны храниться данные истории.
По умолчанию: 31d.
trends string Период времени (с использованием суффикса времени, пользовательского макроса или LLD-макроса), в течение которого должны храниться данные трендов.
По умолчанию: 365d.
status string Статус элемента данных.
Возможные значения:1 ENABLED (0, по умолчанию), DISABLED (1).
value_type string Тип получаемого значения.
Возможные значения:1 FLOAT (0), CHAR (1), LOG (2), UNSIGNED (3, по умолчанию), TEXT (4), BINARY (5).
allowed_hosts string Список IP-адресов узлов сети, разделенных запятыми, которым разрешено отправлять данные для элемента данных.
Поддерживается для элементов данных TRAP и HTTP_AGENT.
units string Единицы получаемого значения (bps, B, и т. д.).
params text Дополнительные параметры в зависимости от типа элемента данных (выполняемый скрипт для элементов данных SSH и TELNET; SQL-запрос для элементов данных ODBC; формула для элементов данных CALCULATED; скрипт для элементов данных ITEM_TYPE_SCRIPT и ITEM_TYPE_BROWSER).
ipmi_sensor string Датчик IPMI.
Поддерживается для элементов данных IPMI.
authtype string Тип аутентификации.
Поддерживается для элементов данных SSH и HTTP_AGENT.
Возможные значения для элементов данных SSH:1 PASSWORD (0, по умолчанию), PUBLIC_KEY (1).
Возможные значения для элементов данных HTTP_AGENT:1 NONE (0, по умолчанию), BASIC (1), NTLM (2), Kerberos (3) или Digest (4).
username string (обязательно для элементов данных SSH и TELNET) Имя пользователя для аутентификации.
Поддерживается для элементов данных SIMPLE, ODBC, JMX и HTTP_AGENT.
При использовании для элементов данных JMX также следует указать password (см. ниже) либо оставить оба элемента пустыми.
password string (обязательно для элементов данных SSH и TELNET) Пароль для аутентификации.
Поддерживается для элементов данных SIMPLE, ODBC, JMX и HTTP_AGENT.
При использовании для элементов данных JMX также следует указать username (см. выше) либо оставить оба элемента пустыми.
publickey string (обязательно для элементов данных SSH) Имя файла открытого ключа.
privatekey string (обязательно для элементов данных SSH) Имя файла закрытого ключа.
description text Описание элемента данных.
inventory_link string Поле инвентаря узла сети, которое заполняется этим элементом данных.
Возможные значения:1 NONE (0), ALIAS (4) и т. д. (поддерживаемые поля см. в разделе Инвентарь узла сети).
valuemap Корневой элемент для карт значений элемента данных.
name string (обязательно) Имя карты значений, используемой для элемента данных.
logtimefmt string Формат времени в записях журнала.
Поддерживается для элементов данных типа LOG.
preprocessing Корневой элемент для предварительной обработки значений элемента данных.
step Корневой элемент для шагов предварительной обработки значений элемента данных шаблона.
jmx_endpoint string Конечная точка JMX.
Поддерживается для элементов данных JMX.
master_item (обязательно для элементов данных DEPENDENT) Корневой элемент для master item зависимого элемента данных.
key string (обязательно) Ключ master item зависимого элемента данных.
timeout string Тайм-аут запроса опроса данных элемента данных.
Поддерживается для списка типов элементов данных Тайм-ауты.
url string (обязательно для элементов данных HTTP_AGENT) Строка URL.
query_fields Корневой элемент для параметров запроса.
Поддерживается для элементов данных HTTP_AGENT.
name string (обязательно для элементов данных HTTP_AGENT) Имя параметра запроса.
value string Значение параметра запроса.
Поддерживается для элементов данных HTTP_AGENT.
parameters Корневой элемент для пользовательских параметров.
Поддерживается для элементов данных ITEM_TYPE_SCRIPT и ITEM_TYPE_BROWSER.
name string (обязательно для элементов данных ITEM_TYPE_SCRIPT и ITEM_TYPE_BROWSER) Имя пользовательского параметра.
value string Значение пользовательского параметра.
Поддерживается для элементов данных ITEM_TYPE_SCRIPT и ITEM_TYPE_BROWSER.
posts string Данные тела HTTP(S)-запроса.
Поддерживается для элементов данных HTTP_AGENT.
status_codes string Диапазоны требуемых HTTP-кодов состояния, разделенные запятыми.
Поддерживается для элементов данных HTTP_AGENT.
follow_redirects string Следовать перенаправлениям ответа при опросе данных.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 NO (0, по умолчанию), YES (1).
post_type string Тип тела данных POST.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 RAW (0, по умолчанию), JSON (2), XML (3).
http_proxy string Строка подключения к HTTP(S)-прокси.
Поддерживается для элементов данных HTTP_AGENT.
headers Корневой элемент для заголовков HTTP(S)-запроса.
Поддерживается для элементов данных HTTP_AGENT.
name string (обязательно для элементов данных HTTP_AGENT) Имя заголовка.
value string (обязательно для элементов данных HTTP_AGENT) Значение заголовка.
retrieve_mode string Какая часть ответа должна быть сохранена.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 BODY (0, по умолчанию), HEADERS (1), BOTH (2).
request_method string Тип метода запроса.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 GET (0, по умолчанию), POST (1), PUT (2), HEAD (3).
output_format string Как обрабатывать ответ.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 RAW (0, по умолчанию), JSON (1).
allow_traps string Разрешить заполнение значения аналогично элементу данных trapper.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 NO (0, по умолчанию), YES (1).
ssl_cert_file string Путь к файлу открытого SSL-ключа.
Поддерживается для элементов данных HTTP_AGENT.
ssl_key_file string Путь к файлу закрытого SSL-ключа.
Поддерживается для элементов данных HTTP_AGENT.
ssl_key_password string Пароль для файла SSL-ключа.
Поддерживается для элементов данных HTTP_AGENT.
verify_peer string Проверять ли подлинность сертификата узла сети.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 NO (0, по умолчанию), YES (1).
verify_host string Проверять ли, что имя узла для подключения совпадает с именем в сертификате узла сети.
Поддерживается для элементов данных HTTP_AGENT.
Возможные значения:1 NO (0, по умолчанию), YES (1).
tags Корневой элемент для тегов элемента данных.
tag string (обязательно) Имя тега.
value string Значение тега.
triggers Корневой элемент для триггеров элемента данных шаблона.

См. также: Объект элемента данных (см. соответствующее свойство с совпадающим именем).

Шаги предварительной обработки значения элемента данных шаблона
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          preprocessing:
            - type: JSONPATH
              parameters:
                - $.length()
            - type: DISCARD_UNCHANGED_HEARTBEAT
              parameters:
                - 12h
          (...)
Element Type Description
type string (обязательно) Тип шага предварительной обработки значения элемента данных.
Возможные значения: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, вычисляется: полученное значение - предыдущее значение), CHANGE_PER_SECOND (10, вычисляется: (полученное значение - предыдущее значение)/(текущее время - время последней проверки)), 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 (обязательно) Корневой элемент для параметров шага предварительной обработки значения элемента данных.
parameter string Отдельный параметр шага предварительной обработки значения элемента данных.
error_handler string Тип действия, используемый в случае сбоя шага предварительной обработки.
Возможные значения:1 ORIGINAL_ERROR (0, по умолчанию), DISCARD_VALUE (1), CUSTOM_VALUE (2), CUSTOM_ERROR (3).
error_handler_params string Параметры обработчика ошибок.

См. также: Объект предварительной обработки элемента данных (см. соответствующее свойство с совпадающим именем).

Триггеры шаблона
zabbix_export:
  (...)
  templates:
    (...)
      items:
        (...)
        - uuid: 58818005e76d46dda14d6592f601ab00
          (...)
          triggers:
            - uuid: b950c306394f4b3c902060a8273cbcde
              expression: 'change(/Linux by Zabbix agent/system.sw.packages.get)<>0'
              name: 'Linux: Количество установленных пакетов изменилось'
              priority: WARNING
              manual_close: 'YES'
              tags:
                - tag: scope
                  value: notice
        (...)
        - uuid: 403cebed115441369e94d35d070ca7b8
          (...)
          triggers:
            - uuid: cfd395b1cde74ef18a5e5f840bd5142a
              expression: 'min(/Linux by Zabbix agent/vm.memory.utilization,5m)>{$MEMORY.UTIL.MAX}'
              name: 'Linux: Высокое использование памяти'
              event_name: 'Linux: Высокое использование памяти (>{$MEMORY.UTIL.MAX}% за 5m)'
              priority: AVERAGE
              description: 'В системе заканчивается свободная память.'
              dependencies:
                - name: 'Linux: Недостаток доступной памяти'
                  expression: 'max(/Linux by Zabbix agent/vm.memory.size[available],5m)<{$MEMORY.AVAILABLE.MIN} and last(/Linux by Zabbix agent/vm.memory.size[total])>0'
              tags:
                - tag: scope
                  value: capacity
                - tag: scope
                  value: performance
        (...)
Element Type Description
uuid string (обязательно) Уникальный идентификатор этого триггера.
expression string (обязательно) Выражение триггера.
recovery_mode string Основа для генерации событий OK.
Возможные значения:1 EXPRESSION (0, по умолчанию), RECOVERY_EXPRESSION (1), NONE (2).
recovery_expression string Выражение восстановления триггера.
correlation_mode string Режим корреляции (без корреляции событий или корреляция событий по тегу).
Возможные значения:1 DISABLED (0, по умолчанию), TAG_VALUE (1).
correlation_tag string Имя тега, используемое для корреляции событий.
name string (обязательно) Имя триггера.
event_name string Имя события.
opdata string Оперативные данные.
url_name string Метка для URL, связанного с триггером.
url string URL, связанный с триггером.
status string Статус триггера.
Возможные значения:1 ENABLED (0, по умолчанию), DISABLED (1).
priority string Критичность триггера.
Возможные значения:1 NOT_CLASSIFIED (0, по умолчанию), INFO (1), WARNING (2), AVERAGE (3), HIGH (4), DISASTER (5).
description text Описание триггера.
type string Тип генерации событий (одно проблемное событие или несколько проблемных событий).
Возможные значения:1 SINGLE (0, по умолчанию), MULTIPLE (1).
manual_close string Ручное закрытие проблемных событий.
Возможные значения:1 NO (0, по умолчанию), YES (1).
dependencies Корневой элемент для зависимостей.
name string (обязательно) Имя зависимого триггера.
expression string (обязательно) Выражение зависимого триггера.
recovery_expression string Выражение восстановления зависимого триггера.
tags Корневой элемент для тегов триггера.
tag string (обязательно) Имя тега.
value string Значение тега.

См. также: Объект Trigger (см. соответствующее свойство с совпадающим именем).

Правила низкоуровневого обнаружения шаблона

zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          name: 'Network interface discovery'
          key: net.if.discovery
          delay: 1h
          filter: (see table below)
          description: 'The discovery of network interfaces.'
          item_prototypes: (see table below)
          trigger_prototypes: (see table below)
          graph_prototypes: (see table below)
        (...)

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

Element Type Description
type string Тип элемента данных.
Возможные значения:1 ZABBIX_PASSIVE (0, по умолчанию), TRAP (2), SIMPLE (3), INTERNAL (5), ZABBIX_ACTIVE (7), EXTERNAL (10), ODBC (11), IPMI (12), SSH (13), TELNET (14), JMX (16), DEPENDENT (18), HTTP_AGENT (19), SNMP_AGENT (20), ITEM_TYPE_SCRIPT (21), ITEM_TYPE_BROWSER (22).
key string (обязательно) Ключ правила низкоуровневого обнаружения.
filter Корневой элемент для фильтров правил низкоуровневого обнаружения шаблона.
lifetime string Период времени (в секундах, суффикс времени или пользовательский макрос), по истечении которого обнаруженные ресурсы, которые больше не обнаруживаются, будут удалены.
По умолчанию: 7d.
lifetime_type string Сценарий удаления потерянных ресурсов LLD.
Возможные значения: DELETE_NEVER, DELETE_IMMEDIATELY, DELETE_AFTER.
enabled_lifetime string Период времени (в секундах, суффикс времени или пользовательский макрос), по истечении которого обнаруженные ресурсы, которые больше не обнаруживаются, будут отключены.
enabled_lifetime_type string Сценарий отключения потерянных ресурсов LLD.
Возможные значения: DISABLE_NEVER, DISABLE_IMMEDIATELY, DISABLE_AFTER.
item_prototypes Корневой элемент для элементов-прототипов шаблона, которые совпадают с элементами данных шаблона.
trigger_prototypes Корневой элемент для триггеров-прототипов шаблона, которые совпадают с триггерами элементов данных шаблона.
graph_prototypes Корневой элемент для графиков-прототипов шаблона, которые совпадают с графиками узла сети.
host_prototypes Корневой элемент для прототипов узлов сети шаблона, которые совпадают с узлами сети.
parent_discovery_rule Корневой элемент для родительского правила низкоуровневого обнаружения (или прототипа правила) прототипа правила низкоуровневого обнаружения. Это свойство указывает, что это прототип LLD-правила, прямой дочерний элемент указанного правила/прототипа правила.
key string (обязательно) Ключ родительского правила низкоуровневого обнаружения (или прототипа правила).
master_item string (обязательно для правил DEPENDENT) Корневой элемент для master-элемента зависимого правила.
lld_macro_paths Корневой элемент для путей макросов правила низкоуровневого обнаружения.
lld_macro string (обязательно) Имя макроса правила низкоуровневого обнаружения.
path string (обязательно) Селектор значения, которое будет назначено соответствующему макросу.
preprocessing Корневой элемент для предварительной обработки значения правила низкоуровневого обнаружения.
step Корневой элемент для элементов шага предварительной обработки значения правила низкоуровневого обнаружения, которые совпадают с шагами предварительной обработки значения элемента данных шаблона, но с меньшим количеством возможных значений. См. также: объект предварительной обработки LLD-правила.
overrides Корневой элемент для правил переопределения правила низкоуровневого обнаружения.
name string (обязательно) Уникальное имя переопределения.
step string (обязательно) Уникальный порядковый номер переопределения.
stop string Остановить обработку следующих переопределений, если совпадает.
filter Корневой элемент для элементов фильтра правила переопределения правила низкоуровневого обнаружения шаблона, которые совпадают с фильтрами правил низкоуровневого обнаружения шаблона.
operations Корневой элемент для операций переопределения правила низкоуровневого обнаружения шаблона.

См. также: объект LLD-правила (см. соответствующее свойство с совпадающим именем).

Фильтры правила низкоуровневого обнаружения шаблона
zabbix_export:
  (...)
  templates:
    (...)
      discovery_rules:
        - uuid: acfdea9c46ef48c68e6636f43b8f96a2
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.MATCHES}'
              - macro: '{#IFNAME}'
                value: '{$NET.IF.IFNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
          (...)
        - uuid: 2bbdc79f082d4c618e01bec625e9c90a
          (...)
          filter:
            evaltype: AND
            conditions:
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.MATCHES}'
              - macro: '{#DEVNAME}'
                value: '{$VFS.DEV.DEVNAME.NOT_MATCHES}'
                operator: NOT_MATCHES_REGEX
              - macro: '{#DEVTYPE}'
                value: disk
          (...)
Element Type Description
evaltype string Переопределяет метод оценки условий фильтра.
Возможные значения:1 AND_OR (0, по умолчанию), AND (1), OR (2), FORMULA (3).
formula string Пользовательская формула вычисления для условий фильтра.
conditions Корневой элемент для условий фильтра.
macro string (обязательно) Имя макроса низкоуровневого обнаружения, для которого выполняется проверка.
value string Значение для сравнения.
operator string Оператор условия.
Возможные значения:1 MATCHES_REGEX (8, по умолчанию), NOT_MATCHES_REGEX (9).
formulaid string (обязательно) Произвольный уникальный ID, который используется для ссылки на условие из пользовательского выражения. Может содержать только заглавные буквы. ID должен быть задан пользователем при изменении условий фильтра, но будет сгенерирован заново при последующем запросе.

См. также: объект фильтра правила LLD (обратитесь к соответствующему свойству с совпадающим именем).

Операции замещения правил низкоуровневого обнаружения шаблона
Элемент Тип Описание
operationobject строка Объект, к которому применяется операция.
Возможные значения:1 ITEM_PROTOTYPE (0), TRIGGER_PROTOTYPE (1), GRAPH_PROTOTYPE (2), HOST_PROTOTYPE (3).
operator строка Оператор условия замещения.
Возможные значения:1 EQUAL (1), NOT_EQUAL (2), LIKE (3), NOT_LIKE (4), REGEXP (5), NOT_REGEXP (6).
value строка Регулярное выражение или строка для оператора условия замещения.
status строка Состояние объекта при операции замещения.
discover строка Добавляется ли объект в результате обнаружения.
delay строка Интервал обновления, установленный для прототипа элемента данных при операции замещения.
history строка Период хранения истории, установленный для прототипа элемента данных при операции замещения.
trends строка Период хранения динамики изменений, установленный для прототипа элемента данных при операции замещения.
severity строка Важность прототипа триггера, установленная при операции замещения.
tags Корневой элемент для тегов, установленных для объекта при операции замещения.
tag строка (обязательный) Имя тега.
value строка Значение тега.
templates Корневой элемент для шаблонов, присоединённых к прототипу узла сети при операции замещения.
name строка (обязательный) Имя шаблона.
inventory_mode строка Режим инвентаризации прототипа узла сети, установленный при операции замещения.

Смотрите также: объект операции замещения правила LLD (смотрите соответствующее свойство с совпадающим именем).

Веб-сценарии шаблона

Элемент Тип Описание
uuid строка (обязательный) Уникальный идентификатор конкретного веб-сценария.
name строка (обязательный) Имя веб-сценария.
delay строка Частота выполнения веб-сценария (используя секунды, единицы времени с суффиксом или пользовательский макрос).
По умолчанию: 1m.
attempts целое число Количество попыток выполнения шагов веб-сценария.
Возможные значения:1 1-10 (по умолчанию: 1).
agent строка Агент клиента. Zabbix будет притворяться выбранным браузером.
Эта опция полезна, когда веб-сайт возвращает разное содержимое для разных браузеров.
По умолчанию: Zabbix.
http_proxy строка Укажите используемый HTTP прокси, используя следующий формат: http://[имя пользователя[:пароль]@]прокси.example.com[:порт]
variables Корневой элемент для переменных уровня сценария, которые могут использоваться в шагах сценария.
name строка (обязательный) Имя переменной.
value текст (обязательный) Значение переменной.
headers Корневой элемент для HTTP заголовков, которые будут отправлены при выполнении запроса.
Заголовки нужно перечислять с использованием такого же синтаксиса, что и в HTTP протоколе.
name строка (обязательный) Имя заголовка.
value текст (обязательный) Значение заголовка.
status строка Состояние веб-сценария.
Возможные значения:1 ENABLED (0, по умолчанию), DISABLED (1).
authentication строка Метод аутентификации.
Возможные значения:1 NONE (0, по умолчанию), BASIC (1), NTLM (2), Kerberos (3) или Digest (4).
http_user строка Имя пользователя для простой (BASIC HTTP), NTLM, Kerberos или Digest аутентификации.
http_password строка Пароль для для простой (BASIC HTTP), NTLM, Kerberos или Digest аутентификации.
verify_peer строка Проверка SSL сертификата веб-сервера.
Возможные значения:1 NO (0, по умолчанию), YES (1).
verify_host строка Проверка, что поле Общее Имя (Common Name) или поле Дополнительное Имя Субъекта (Subject Alternate Name) сертификата веб-сервера совпадают.
Возможные значения:1 NO (0, по умолчанию), YES (1).
ssl_cert_file строка Имя используемого файла SSL сертификата для аутентификации клиента (должен быть в формате PEM).
ssl_key_file строка Имя используемого файла закрытого ключа (private key) SSL для аутентификации клиента (должен быть в формате PEM).
ssl_key_password строка Пароль к файлу закрытого ключа (private key) SSL.
steps (обязательный) Корневой элемент для шагов веб-сценария шаблона.
tags Корневой элемент тегов веб-сценария.
tag строка (обязательный) Имя тега.
value строка Значение тега.

Смотрите также: Объект веб-сценария (смотрите соответствующее свойство с совпадающим именем).

Шаги веб-сценария шаблона
Элемент Тип Описание
name строка (обязательный) Имя шага веб-сценария.
url строка (обязательный) URL для мониторинга.
query_fields Корневой элемент для параметров запроса (массив полей HTTP, которые будут добавлены к URL при выполнении запроса).
name строка (обязательный) Имя параметра запроса.
value строка Значение параметра запроса.
posts Корневой элемент для переменных HTTP POST (строка (необработанные post данные) или массив полей HTTP (данные полей формы)).
name строка (обязательный) Имя поля post.
value строка (обязательный) Значение поля post.
variables Корневой элемент переменных (макросов) уровня шага, которые следует применить после этого шага.
Если значение переменной имеет префикс «regex:», то её значение извлекается из данных, возвращаемых этим шагом в соответствии с шаблоном регулярного выражения, следующим за префиксом «regex:».
name строка (обязательный) Имя переменной.
value текст (обязательный) Значение переменной.
headers Корневой элемент для заголовков HTTP, которые будут отправлены при выполнении запроса.
name строка (обязательный) Имя заголовка.
value текст (обязательный) Значение заголовка.
follow_redirects строка Следовать перенаправлениям HTTP.
Возможные значения:1 NO (0), YES (1, по умолчанию).
retrieve_mode строка Режим получения ответа HTTP.
Возможные значения:1 BODY (0, по умолчанию), HEADERS (1), BOTH (2).
timeout строка Таймаут (используя секунды, единицы времени с суффиксом или пользовательский макрос) шага выполнения.
По умолчанию: 15s.
required строка Текст, который должен присутствовать в ответе (игнорируется, если пусто).
status_codes строка Список (через запятую) принимаемых кодов состояния HTTP (например: 200-201,210-299; игнорируется, если пусто).

Смотрите также: Объект шага веб-сценария (смотрите соответствующее свойство с совпадающим именем).

Конфигурация макросов шаблона

zabbix_export:
  (...)
  templates:
    - uuid: f8f7908280354f2abeed07dc788c3747
      (...)
      macros:
        - macro: '{$AGENT.TIMEOUT}'
          (...)
          config:
            type: TEXT
            priority: '1'
            label: 'Секунды с момента последнего обнаружения агента Zabbix'
            description: 'Тайм-аут, после которого агент считается недоступным.'
        - macro: '{$CPU.UTIL.CRIT}'
          (...)
          config:
            type: TEXT
            priority: '2'
            section_name: Thresholds
            label: 'Порог выраженной загрузки CPU'
            description: 'Критический порог выраженной загрузки CPU в %. Диапазон от 0 до 100 включительно.'
            regex: '^-?([0-9]+|(([0-9]+)\.([0-9]+)))$'
        (...)
        - macro: '{$IFCONTROL}'
          (...)
          config:
            type: CHECKBOX
            priority: '19'
            label: 'Управление интерфейсами'
            description: 'Создавать триггер, когда рабочее состояние интерфейса изменяется на "Link down".'
            options:
              - checked: '1'
                unchecked: '0'
        (...)
Элемент Тип Описание
type string (обязательно) Тип поля ввода макроса.
Возможные значения:1 NOCONF (0), TEXT (1), LIST (2), CHECKBOX (3).
priority string Позиция макроса в списке макросов.
section_name string Метка сворачиваемого раздела, в котором сгруппирован макрос.
label string (обязательно для макросов TEXT, LIST, CHECKBOX) Метка макроса.
description text Справочный текст макроса. Поддерживает форматирование Markdown.
required string Помечает макрос как обязательный.
Возможные значения:1 NO (0), YES (1).
Поддерживается для макросов TEXT и LIST.
regex string Регулярное выражение для проверки ввода пользователя в поле текстового ввода.
Поддерживается для макросов TEXT.
options Корневой элемент для элементов LIST или значений CHECKBOX.
value string (обязательно для макросов LIST) Значение элемента LIST.
text string (обязательно для макросов LIST) Текст элемента LIST.
checked string (обязательно для макросов CHECKBOX) Значение, представляющее состояние "включено".
Возможные значения:1 0 (false), 1 (true).
Поддерживается для макросов CHECKBOX.
unchecked string (обязательно для макросов CHECKBOX) Значение, представляющее состояние "выключено".
Возможные значения:1 0 (false), 1 (true).
Поддерживается для макросов CHECKBOX.

См. также: Объект конфигурации макроса (см. соответствующее свойство с совпадающим именем).

Панели шаблона

zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets: (see table below)
        (...)
Element Type Description
uuid string (required) Уникальный идентификатор этой панели.
name string (required) Имя панели шаблона.
display period integer Период отображения страниц панели.
auto_start string Автоматический запуск слайд-шоу.
Возможные значения:1 NO (0), YES (1, default).
pages Корневой элемент для страниц панели шаблона.
name string Имя страницы.
display period integer Период отображения страницы.
sortorder integer Порядок сортировки страницы.
widgets Корневой элемент для виджетов панели шаблона.

См. также: Объект панели шаблона (см. соответствующее свойство с совпадающим именем).

Виджеты панели шаблона
zabbix_export:
  (...)
  templates:
    (...)
      dashboards:
        - uuid: c689ad3115fd46a4b927d1f70ee2e5a4
          name: Filesystems
          pages:
            - name: Overview
              widgets:
                - type: graphprototype
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '3'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: Диаграмма использования пространства (относительно общего объема)'
                    - type: STRING
                      name: reference
                      value: AAAEB
                - type: graphprototype
                  'y': '5'
                  width: '72'
                  height: '5'
                  fields:
                    - type: INTEGER
                      name: columns
                      value: '1'
                    - type: GRAPH_PROTOTYPE
                      name: graphid.0
                      value:
                        host: 'Linux by Zabbix agent'
                        name: 'FS [{#FSTYPE}({#FSNAME})]: График использования пространства, в %, (относительно максимального доступного)'
                    - type: STRING
                      name: reference
                      value: AAAEC
        (...)
Element Type Description
type string (required) Тип виджета.
name string Имя виджета.
x integer Горизонтальная позиция от левой стороны панели шаблона.
Возможные значения:1 0-71.
y integer Вертикальная позиция от верхней стороны панели шаблона.
Возможные значения:1 0-63.
width integer Ширина виджета.
Возможные значения:1 1-72.
height integer Высота виджета.
Возможные значения:1 1-64.
hide_header string Скрыть заголовок виджета.
Возможные значения:1 NO (0, по умолчанию), YES (1).
fields Корневой элемент для полей виджета панели шаблона.
type string (required) Тип поля виджета.
Возможные значения: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) Имя поля виджета.
value mixed (required) Значение поля виджета в зависимости от типа поля.

См. также: Объект виджета панели шаблона (см. соответствующее свойство с совпадающим именем).

Карта значений шаблона

zabbix_export:
  (...)
  templates:
    (...)
      valuemaps:
        - uuid: 8c048c6cca8248f2860c208e8db0f59e
          name: ifOperStatus
          mappings:
            - value: '0'
              newvalue: unknown
            - value: '1'
              newvalue: notpresent
            - value: '2'
              newvalue: down
            - value: '3'
              newvalue: lowerlayerdown
            - value: '4'
              newvalue: testing
            - value: '5'
              newvalue: dormant
            - value: '6'
              newvalue: up
        (...)
Элемент Тип Описание
uuid string (обязательно) Уникальный идентификатор этой карты значений.
name string (обязательно) Имя карты значений.
mapping Корневой элемент для сопоставлений.
type string Тип сопоставления по совпадению.
Возможные значения:1 EQUAL (0, по умолчанию), GREATER_OR_EQUAL (2), LESS_OR_EQUAL (3), IN_RANGE (4), REGEXP (5), DEFAULT (6).
value string Исходное значение.
newvalue string (обязательно) Значение, в которое сопоставляется исходное значение.

См. также: Объект карты значений (см. соответствующее свойство с совпадающим именем).

Примечания

1 Целочисленные значения API в скобках, например, ENABLED (0), упоминаются только для справки. Для получения дополнительной информации смотрите связанную страницу объекта API в записи таблицы или в конце каждого раздела.