Documentation
Table of Contents
- > Об'єкт правила LLD
- Правило LLD
- Фільтр правил LLD
- Шлях макросу LLD
- Попередня обробка правила LLD
- Перевизначення правил LLD
- Фільтр перевизначення правил LLD
- Умова фільтра перевизначення правила LLD
- Операція заміни правила LLD
- Статус операції перевизначення правила LLD
- Виявлення операції перевизначення правила LLD
- Період дії перевизначення правила LLD
- Історія операцій перевизначення правила LLD
- Правило LLD перевизначає тенденції роботи
- Правило LLD перевизначає серйозність операції
- Тег операції перевизначення правила LLD
- Шаблон операції перевизначення правила LLD
- Інвентаризація операцій перевизначає правило LLD
> Об'єкт правила LLD
Наступні об’єкти безпосередньо пов’язані з API «discoveryrule».
Правило LLD
Об'єкт правила виявлення низького рівня має такі властивості.
| Властивість | Тип | Опис |
|---|---|---|
| itemid | рядок | (лише для читання) ID правила LLD. |
| затримка (обов'язково) |
рядок | Інтервал оновлення правила LLD. Приймає секунди або одиниці вимірювання часу з суфіксом і з одним або декількома настроюваними інтервалами, які складаються з гнучких інтервалів і інтервалів планування як серіалізованих рядків. Також приймає макроси користувача. Гнучкі інтервали можна записати у вигляді двох макросів, розділених косою рискою. Інтервали відокремлюються крапкою з комою. Необов’язково для трапера Zabbix, залежних елементів і для агента Zabbix (активного) з ключем mqtt.get. |
| hostid (обов’язково) |
рядок | Ідентифікатор хоста, якому належить правило LLD. |
| interfaceid (обов'язково) |
рядок | ID інтерфейсу хоста правила LLD. Використовується лише для правил LLD хоста. Не потрібно для правил LLD агента Zabbix (активного), внутрішнього Zabbix, перехоплювача Zabbix, залежного, монітора бази даних і сценарію. Необов’язковий для правил HTTP агента LLD. |
| ключ_ (обов’язково) |
рядок | ключ правила LLD. |
| назва (обов’язково) |
рядок | Назва правила LLD. |
| тип (обов’язково) |
ціле число | Тип правила LLD. Можливі значення: 0 - агент Zabbix; 2 - перехоплювач Zabbix; 3 - проста перевірка; 5 - Zabbix внутрішній; 7 - Zabbix агент (активний); 10 - зовнішня перевірка; 11 - монітор бази даних; 12 - IPMI агент; 13 - Агент SSH; 14 - Агент TELNET; 16 - Агент JMX; 18 - Залежний елемент; 19 - Агент HTTP; 20 - Агент SNMP; 21 - Сценарій. |
| url (обов’язково) |
рядок | Рядок URL-адреси, необхідний для правила LLD агента HTTP. Підтримує макроси користувача, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| allow_traps | integer | Поле правила LLD агента HTTP. Дозволити також заповнювати значення, як у типі елемента trapper. 0 - (за замовчуванням) Не дозволяти приймати вхідні дані. 1 - Дозволяти приймати вхідні дані. |
| authtype | integer | Використовується лише агентом SSH або правилами LLD агента HTTP. Можливі значення методу автентифікації агента SSH: 0 - (за замовчуванням) пароль; 1 - відкритий ключ.< br> Можливі значення методу автентифікації агента HTTP: 0 - (за замовчуванням) немає 1 - базовий 2 - NTLM |
| опис | рядок | Опис правила LLD. |
| помилка | рядок | (лише читання) Текст помилки, якщо є проблеми з оновленням правила LLD. |
| follow_redirects | integer | Поле правила LLD агента HTTP. Дотримуйтесь переспрямувань відповідей під час об’єднання даних. 0 - Не слідуйте переспрямуванням. 1 - (за замовчуванням) Слідкуйте за переспрямуваннями. |
| headers | object | Поле правила LLD агента HTTP. Об’єкт із заголовками запитів HTTP(S), де назва заголовка використовується як ключ, а значення заголовка – як значення. Приклад: { "User-Agent": "Zabbix" } |
| http_proxy | рядок | Поле правила LLD агента HTTP. Рядок підключення проксі-сервера HTTP(S). |
| ipmi_sensor | рядок | датчик IPMI. Використовується лише за правилами IPMI LLD. |
| jmx_endpoint | рядок | спеціальний рядок підключення агента JMX. Значення за замовчуванням: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT }/jmxrmi |
| тривалість | рядок | Період часу, після якого елементи, які більше не виявлено, буде видалено. Приймає секунди, одиницю часу з суфіксом і макрос користувача. За замовчуванням: 30d. |
| master_itemid | integer | Ідентифікатор головного елемента. Дозволяється рекурсія до 3 залежних елементів і максимальна кількість залежних елементів дорівнює 999. Правило виявлення не може бути головним елементом для іншого правила виявлення. < br>Потрібно для залежного елемента. |
| виведення_формат | ціле | Поле правила LLD агента HTTP. Відповідь має бути перетворено в JSON. 0 - (за замовчуванням) Зберігати необроблені дані. 1 - Перетворити в JSON. |
| params | string | Додаткові параметри залежно від типу правила LLD: - виконаний скрипт для правил SSH і Telnet LLD; - SQL-запит для правил LLD монітора бази даних; - формула для обчислених правил LLD . |
| параметри | масив | Додаткові параметри для правила LLD типу сценарію. Масив об’єктів із властивостями «ім’я» та «значення», де ім’я має бути унікальним. |
| password | string | Пароль для автентифікації. Використовується простою перевіркою, SSH, Telnet, монітором бази даних, правилами LLD JMX і агента HTTP. |
| post_type | integer | Поле правила LLD агента HTTP. Тип тіла даних публікації, що зберігається у властивості posts. 0 - (за замовчуванням) Необроблені дані. 2 - Дані JSON. 3 - Дані XML. |
| повідомлення | рядок | Поле правила LLD агента HTTP. Дані тіла запиту HTTP(S). Використовується з post_type. |
| privatekey | рядок | Назва файлу закритого ключа. |
| publickey | рядок | Назва файлу відкритого ключа. |
| query_fields | array | Поле правила LLD агента HTTP. Параметри запиту. Масив об’єктів із парами «ключ»:«значення», де значенням може бути порожній рядок. |
| request_method | integer | Поле правила LLD агента HTTP. Тип методу запиту. 0 - (за замовчуванням) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | Поле правила LLD агента HTTP. Яку частину відповіді слід зберегти. 0 - (за замовчуванням) Тіло. 1 - Заголовки. 2 - Буде збережено як тіло, так і заголовки. Для запит_метод HEAD лише 1 допустиме значення. |
| snmp_oid | рядок | SNMP OID. |
| ssl_cert_file | рядок | Поле правила LLD агента HTTP. Шлях до файлу публічного ключа SSL. |
| ssl_key_file | рядок | Поле правила LLD агента HTTP. Шлях до файлу приватного ключа SSL. |
| ssl_key_password | рядок | Поле правила LLD агента HTTP. Пароль для файлу ключа SSL. |
| стан | ціле | (лише для читання) Стан правила LLD. Можливі значення: 0 - (за замовчуванням) нормальний; 1 - не підтримується. |
| статус | ціле число | Статус правила LLD. Можливі значення: 0 - (за замовчуванням) правило LLD увімкнено; 1 - правило LLD вимкнено. |
| статус_коди | рядок | Поле правила LLD агента HTTP. Діапазони необхідних кодів стану HTTP, розділених комами. Також підтримує макроси користувача як частину списку, розділеного комами. Приклад: 200,200-{$M},{$M},200-400 |
| templateid | рядок | (лише для читання) Ідентифікатор правила LLD батьківського шаблону. |
| timeout | string | Тайм-аут запиту опитування даних елемента. Використовується для правил агента HTTP та сценарію LLD. Підтримує макроси користувача. за умовчанням: 3 с максимальне значення: 60 с |
| trapper_hosts | рядок | Дозволені хости. Використовується правилами LLD перехоплювача або правилами LLD агента HTTP. |
| ім'я користувача | рядок | Ім'я користувача для автентифікації. Використовується простою перевіркою, SSH, Telnet, монітором бази даних, правилами LLD JMX і агента HTTP. Потрібно правилами LLD SSH і Telnet. |
| uuid | рядок | Універсальний унікальний ідентифікатор, який використовується для зв’язування імпортованих правил LLD із уже існуючими. Використовується лише для правил LLD у шаблонах. Автоматично генерується, якщо не вказано. Для операцій оновлення це поле є лише для читання. |
| verify_host | integer | Поле правила LLD агента HTTP. Перевірте ім’я хоста в URL-адресі в полі Common Name або Subject Alternate Name сертифіката хоста. 0 - (за замовчуванням) Не перевіряти. 1 - Перевірити. |
| verify_peer | integer | Поле правила LLD агента HTTP. Перевірка є автентичним сертифікатом хоста. 0 - (за замовчуванням) Не перевіряти. 1 - Перевірити. |
Зауважте, що для деяких методів (оновлення, видалення) комбінація обов’язкових/необов’язкових параметрів відрізняється.
Фільтр правил LLD
Об’єкт фільтра правила LLD визначає набір умов, які можна використовувати для фільтрації виявлених об’єктів. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| conditions (обов’язково) |
масив | Набір умов фільтра для використання для фільтрації результатів. |
| evaltype (обов’язково) |
ціле | Метод оцінки умови фільтра. Можливі значення: 0 - та/або; 1 - і; 2 - або; 3 - спеціальний вираз. |
| eval_formula | рядок | (лише для читання) Згенерований вираз, який використовуватиметься для оцінки умов фільтра. Вираз містить ідентифікатори, які посилаються на конкретні умови фільтра за його "формулою". Значення eval_formula дорівнює значенню formula для фільтрів із спеціальним виразом. |
| формула | рядок | Визначений користувачем вираз, який буде використовуватися для оцінки умов фільтрів за допомогою спеціального виразу. Вираз має містити ідентифікатори, які посилаються на конкретні умови фільтра за його "формулою". Ідентифікатори, які використовуються у виразі, мають точно відповідати ідентифікаторам, визначеним в умовах фільтра: жодна умова не може залишатися невикористаною або пропущеною. Потрібно для фільтрів користувацьких виразів. |
Умова фільтра правила LLD
Об’єкт умов фільтра правила LLD визначає окрему перевірку значення макросу LLD. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| macro (обов’язково) |
рядок | макрос LLD для виконання перевірки. |
| value (обов’язково) |
рядок | Значення для порівняння. |
| formulaid | рядок | Довільний унікальний ідентифікатор, який використовується для посилання на умову з користувацького виразу. Може містити лише великі літери. Ідентифікатор має бути визначений користувачем під час зміни умов фільтра, але буде згенеровано заново під час їхнього запиту пізніше. |
| оператор | ціле | Оператор умови. Можливі значення: 8 - (за замовчуванням) відповідає регулярному виразу; 9 - не відповідає регулярному виразу; 12 - існує;< br>13 - не існує. |
Щоб краще зрозуміти, як використовувати фільтри з різними типами виразів, перегляньте приклади на сторінках методів discoveryrule.get і discoveryrule.create.
Шлях макросу LLD
Шлях макросу LLD має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| lld_macro (обов’язково) |
рядок | LLD макрос. |
| path (обов’язково) |
рядок | Селектор для значення, яке буде призначено відповідному макросу. |
Попередня обробка правила LLD
Об’єкт попередньої обробки правила LLD має такі властивості.
| Властивість | Тип | Опис |
|---|---|---|
| тип (обов’язково) |
ціле | Тип параметра попередньої обробки. Можливі значення: 5 – Зіставлення регулярного виразу; 11 – XML XPath; 12 - JSONPath; 15 - Не збігається з регулярним виразом; 16 - Перевірте наявність помилок у JSON; 17 - Перевірте наявність помилок у XML; 20 - Відкинути без змін із серцевим ритмом; 23 - Prometheus до JSON; 24 - CSV до JSON; 25 - Замінити; 27 - XML до JSON. |
| параметри (обов’язково) |
рядок | Додаткові параметри, які використовуються параметром попередньої обробки. Кілька параметрів розділені символом LF (\n). |
| error_handler (обов’язково) |
ціле | Тип дії, який використовується у випадку помилки етапу попередньої обробки. Можливі значення: 0 - повідомлення про помилку встановлено сервером Zabbix;< br>1 - Відкинути значення; 2 - Установити спеціальне значення; 3 - Установити спеціальне повідомлення про помилку. |
| error_handler_params (обов’язково) |
рядок | Параметри обробника помилок. Використовується з error_handler.Повинен бути порожнім, якщо error_handler дорівнює 0 або 1.Може бути порожнім, якщо error_handler дорівнює 2.Не може бути порожнім, якщо error_handler становить 3. |
Наступні параметри та засоби обробки помилок підтримуються для кожного типу попередньої обробки.
|Тип попередньої обробки|Назва|Параметр 1|Параметр 2|Параметр 3|Підтримувані обробники помилок| |------------------|----|-----------|-----------|- ----------|-----------------------| |5|Регулярний вираз|шаблон1|вивід2|<|0, 1, 2, 3| |11|XML XPath|шлях3|<|<|0, 1, 2, 3| |12|JSONPath|шлях3|<|<|0, 1, 2, 3| |15|Не відповідає регулярному виразу|шаблону1|<|<|0, 1, 2, 3| |16|Перевірте наявність помилок у JSON|path3|<|<|0, 1, 2, 3| |17|Перевірити помилку в XML|path3|<|<|0, 1, 2, 3| |20|Відкинути без змін із серцебиттям|секунди4, 5, 6|<|<|<| |23|Prometheus до JSON|шаблон5, 7|<|<|0, 1, 2, 3| |24|CSV до JSON|символ2|символ2|0,1|0, 1, 2, 3| |25|Замінити|рядок пошуку2|заміна2|<|<| |27|XML до JSON|<|<|<|0, 1, 2, 3|
1 регулярний вираз
2 рядок
3 JSONPath або XML XPath
4 натуральне число (з підтримкою суфіксів часу, наприклад, 30 с, 1 хв, 2 год, 1 д)
5 макрос користувача
6 Макрос LLD
7 Шаблон Prometheus із синтаксисом: <назва метрики>{<назва мітки>="<значення мітки>", ...} == <значення>. Кожен компонент шаблону Prometheus (метрика, назва мітки, значення мітки та значення метрики) може бути макросом користувача.
8 Вихід Prometheus має такий синтаксис: <назва мітки>.
Перевизначення правил LLD
Правило LLD overrides object визначає набір правил (фільтрів, умов і операцій), які використовуються для заміни властивостей різних об’єктів-прототипів. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| name (обов'язково) |
рядок | Унікальне ім'я заміни. |
| step (обов'язково) |
ціле | Унікальний порядковий номер перевизначення. |
| зупинити | ціле число | Зупинити обробку наступних замін, якщо збігається. Можливі значення: 0 - (за замовчуванням) не зупиняти обробку замін; 1 - зупинити обробку замін, якщо фільтр збігається. |
| фільтр | об'єкт | Замінити фільтр. |
| операції | масив | Перевизначити операції. |
Фільтр перевизначення правил LLD
Об’єкт фільтра заміни правила LLD визначає набір умов, якщо вони відповідають виявленому об’єкту, застосовується заміна. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| evaltype (обов’язково) |
integer | Замінити метод оцінки умов фільтра. Можливі значення: 0 - і/або; 1 - і; 2 - або; 3 - спеціальний вираз. |
| conditions (обов’язково) |
масив | Набір умов заміни фільтра для використання для зіставлення виявлених об’єктів. |
| eval_formula | рядок | (лише для читання) Згенерований вираз, який використовуватиметься для оцінки умов заміни фільтра. Вираз містить ідентифікатори, які посилаються на конкретні умови заміни фільтра за його "формулою". Значення eval_formula дорівнює значенню formula для фільтрів із спеціальним виразом. |
| формула | рядок | Визначений користувачем вираз, який буде використовуватися для оцінки умов заміни фільтрів за допомогою спеціального виразу. Вираз має містити ідентифікатори, які посилаються на конкретні умови заміни фільтра за його formulaid. Ідентифікатори, які використовуються у виразі, мають точно відповідати ідентифікаторам, визначеним в умовах заміни фільтра: жодна умова не може залишатися невикористаною або пропущеною.Потрібно для фільтрів заміни користувацького виразу. |
Умова фільтра перевизначення правила LLD
Об’єкт умов фільтра заміни правила LLD визначає окрему перевірку значення макросу LLD. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| macro (обов’язково) |
рядок | макрос LLD для виконання перевірки. |
| value (обов’язково) |
рядок | Значення для порівняння. |
| formulaid | рядок | Довільний унікальний ідентифікатор, який використовується для посилання на умову з користувацького виразу. Може містити лише великі літери. Ідентифікатор має бути визначений користувачем під час зміни умов фільтра, але буде згенеровано заново під час їхнього запиту пізніше. |
| оператор | ціле | Оператор умови. Можливі значення: 8 - (за замовчуванням) відповідає регулярному виразу; 9 - не відповідає регулярному виразу; 12 - існує;< br>13 - не існує. |
Операція заміни правила LLD
Операція перевизначення правила LLD — це комбінація умов і дій, які потрібно виконати над об’єктом-прототипом. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| operationobject (обов’язково) |
integer | Тип виявленого об’єкта для виконання дії. Можливі значення: 0 – прототип елемента; 1 – прототип тригера;< br>2 - Прототип графа; 3 - Прототип хоста. |
| оператор | ціле | Оператор умови заміни. Можливі значення: 0 - (за замовчуванням) дорівнює; 1 - не дорівнює; 2 - містить; 3 - не містить; 8 - збігається; 9 - не збігається. |
| значення | рядок | Шаблон для відповідності імені елемента, тригера, графіка чи прототипу хосту залежно від вибраного об’єкта. |
| opstatus | object | Заміна об’єкта стану операції для об’єктів елемента, тригера та хост-прототипу. |
| opdiscover | об'єкт | Перевизначити операцію виявлення об'єкта статусу (усі типи об'єктів). |
| opperiod | object | Перевизначати об’єкт періоду операції (інтервал оновлення) для об’єкта прототипу елемента. |
| ophistory | object | Замінити об’єкт історії операцій для об’єкта прототипу елемента. |
| optrends | object | Замінити об’єкт трендів операцій для об’єкта прототипу елемента. |
| opseverity | object | Замінити об’єкт серйозності операції для об’єкта прототипу тригера. |
| optag | масив | Заміна об'єкта тегу операції для об'єктів тригера та прототипу хоста. |
| optemplate | масив | Замінити об'єкт шаблону операції для об'єкта прототипу хоста. |
| opinventory | object | Замінити об’єкт інвентаризації операцій для об’єкта прототипу хоста. |
Статус операції перевизначення правила LLD
Правило LLD перевизначає статус операції, встановлений для виявленого об’єкта. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| status (обов’язково) |
ціле число | Замінити статус для вибраного об’єкта. Можливі значення: 0 – Створювати ввімкнено; 1 – Створювати вимкнено. |
Виявлення операції перевизначення правила LLD
Статус виявлення операції перевизначення правила LLD, встановлений для виявленого об’єкта. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| discover (обов’язково) |
ціле число | Замінити статус виявлення для вибраного об’єкта. Можливі значення: 0 – Так, продовжити виявлення об’єктів; 1 – Ні , нові об'єкти не будуть виявлені, а існуючі будуть позначені як втрачені. |
Період дії перевизначення правила LLD
Період дії перевизначення правила LLD – це значення інтервалу оновлення (підтримує спеціальні інтервали), яке встановлено для виявленого елемента. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| delay (обов’язково) |
рядок | Замінити інтервал оновлення прототипу елемента. Приймає секунди або одиницю вимірювання часу з суфіксом (30 с, 1 хв, 2 год, 1 д), а також гнучкі інтервали планування та макроси користувача або макроси LLD. Кілька інтервалів розділяються крапкою з комою. |
Історія операцій перевизначення правила LLD
Правило LLD замінює значення історії операцій, яке встановлено для виявленого елемента. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| history (обов’язково) |
рядок | Замінити історію прототипу елемента, яка є одиницею часу, яка визначає, як довго мають зберігатися дані історії. Також приймає макрос користувача та макрос LLD. |
Правило LLD перевизначає тенденції роботи
Правило LLD перевизначає значення тенденцій операцій, яке встановлено для виявленого елемента. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| trends (обов’язково) |
рядок | Замінити тенденції прототипу елемента, який є одиницею часу, що визначає, як довго слід зберігати дані тенденцій. Також приймає макрос користувача та макрос LLD. |
Правило LLD перевизначає серйозність операції
Правило LLD перевизначає значення серйозності операції, яке встановлено як виявлений тригер. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| severity (обов’язково) |
ціле число | Замінити серйозність прототипу тригера. Можливі значення: 0 - (за замовчуванням) не класифіковано; 1 - інформація;< br>2 - попередження; 3 - середній; 4 - високий; 5 - катастрофа. |
Тег операції перевизначення правила LLD
Об’єкт тегу операції заміни правила LLD містить ім’я та значення тегу, встановлені для виявленого об’єкта. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| tag (обов’язково) |
рядок | Назва нового тегу. |
| значення | рядок | Нове значення тегу. |
Шаблон операції перевизначення правила LLD
Об’єкт шаблону операції заміни правила LLD, який пов’язано з виявленим хостом. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| templateid (обов’язково) |
рядок | Замінити шаблон пов’язаних шаблонів прототипу хосту. |
Інвентаризація операцій перевизначає правило LLD
Правило LLD замінює значення режиму інвентаризації операції, яке встановлено на виявлений хост. Він має такі властивості:
| Властивість | Тип | Опис |
|---|---|---|
| inventory_mode (обов’язково) |
integer | Замінити режим інвентаризації прототипу хосту. Можливі значення: -1 - вимкнено; 0 - (за замовчуванням ) ручна; 1 - автоматична. |