Documentation
Table of Contents
> Объект прототипа элементов данных
Следующие объекты напрямую связаны с itemprototype API.
Прототипы элементов данных
Объект прототипа элементов данных имеет следующие свойства.
| Свойство | Тип | Описание |
|---|---|---|
| itemid | строка | (только чтение) ID прототипа элементов данных. |
| delay (требуется) |
строка | Интервал обновления прототипа элементов данных. Принимает секунды или единицы времени с суффиксом и с или без одного или нескольких пользовательских интервалов, которые состоят как из гибких интервалов, так и интервалов по расписанию в виде сериализованных строк. Также принимает пользовательские макросы и LLD макросы. Гибкие интервалы можно записать в виде двух макросов, разделенных прямой косой чертой. Интервалы разделаются точкой с запятой. Опционально для элементов данных Zabbix траппер и Зависимых. |
| hostid (требуется) |
строка | ID узла сети, которому принадлежит прототип элементов данных. При операциях обновления это поле только для чтения. |
| ruleid (требуется) |
строка | ID правила LLD, которому принадлежит прототип элементов данных. При операциях обновления это поле только для чтения. |
| interfaceid (требуется) |
строка | ID интерфейса узла сети прототипа элементов данных. Используется только прототипами элементов данных на узлах сети. Опционален для прототипов элементов данных Zabbix агента (активного), Zabbix внутреннего, Zabbix траппер, Зависимого элемента данных, Zabbix агрегированного, монитора баз данных и вычисляемого. |
| key_ (требуется) |
строка | Ключ прототипа элементов данных. |
| name (требуется) |
строка | Имя прототипа элементов данных. |
| type (требуется) |
целое число | Тип прототипа элементов данных. Возможные значения: 0 - Zabbix агент; 1 - SNMPv1 агент; 2 - Zabbix траппер; 3 - простая проверка; 4 - SNMPv2 агент; 5 - Zabbix внутренний; 6 - SNMPv3 агент; 7 - Zabbix агент (активный); 8 - Zabbix агрегированный; 10 - внешняя проверка; 11 - монитор баз данных; 12 - IPMI агент; 13 - SSH агент; 14 - TELNET агент; 15 - вычисляемый; 16 - JMX агент; 17 - SNMP трап; 18 - Зависимый элемент данных; 19 - HTTP агент; |
| url (требуется) |
строка | Строка URL, требуется для прототипа элементов данных типа HTTP агент. Поддерживаются пользовательские макросы, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| value_type (требуется) |
целое число | Тип информации прототипа элементов данных. Возможные значения: 0 - числовое с плавающей точкой; 1 - символ; 2 - журнал (лог); 3 - числовое целое положительное; 4 - текст. |
| allow_traps | целое число | Поле HTTP агента прототипа элементов данных. Позволяет заполнять значение также как и в элементе данных с типом траппер. 0 - (по умолчанию) Не разрешать принимать входящие данные. 1 - Разрешать принимать входящие данные. |
| authtype | целое число | Используется только SSH агент и HTTP агент прототипами элементов данных. Возможные значения метода аутентификации SSH агента: 0 - (по умолчанию) пароль; 1 - публичный ключ. Возможные значения метода аутентификации HTTP агента: 0 - (по умолчанию) нет 1 - простая 2 - NTLM |
| description | строка | Описание прототипа элементов данных. |
| follow_redirects | целое число | Поле HTTP агента прототипа элементов данных. Следование перенаправлениям при опросе данных. 0 - Не следовать перенаправлениям. 1 - (по умолчанию) Следовать перенаправлениям. |
| headers | объект | Поле HTTP агента прототипа элементов данных. Объект с HTTP(S) заголовками запроса, где имя заголовка используется ключом, а значение заголовка используется значением. Пример: { "User-Agent": "Zabbix" } |
| history | целое число | Количество времени хранения данных истории. Также принимает пользовательские макросы и LLD макросы. По умолчанию: 90d. |
| http_proxy | строка | Поле HTTP агента прототипа элементов данных. Строка подключения HTTP(S) прокси. |
| ipmi_sensor | строка | Сенсор IPMI. Используется только прототипами элементов данных IPMI. |
| jmx_endpoint | строка | Строка пользовательского соединения с JMX агентом. Значение по умолчанию: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| logtimefmt | строка | Формат времени в записях журнала. Используется только в элементах данных журналов. |
| master_itemid | целое число | ID основного элемента данных. Разрешена рекурсия до 3 зависимых элементов данных и прототипов элементов данных и максимальное количество зависимых элементов данных и прототипов элементов данных допустимо до 999. Требуется для Зависимых элементов данных. |
| output_format | целое число | Поле HTTP агента прототипа элементов данных. Нужно ли конвертировать ответ в JSON. 0 - (по умолчанию) Записывать сырым. 1 - Конвертировать в JSON. |
| params | строка | Дополнительные параметры, которые зависят от типа прототипа элементов данных: - выполняемый скрипт в случае элементов данных SSH и Telnet; - SQL запрос в случае элементов данных монитора базы данных; - формула в случае вычисляемых элементов данных. |
| password | строка | Пароль для аутентификации. Используется прототипами элементов данных простой проверки, SSH, Telnet, монитором баз данных, JMX и HTTP агентом. |
| port | строка | Наблюдаемый прототипом элементов данных порт. Используется только прототипами элементов данных SNMP. |
| post_type | целое число | Поле HTTP агента прототипа элементов данных. Тип тела post данных записываемых в post свойстве. 0 - (по умолчанию) Сырые данные. 2 - JSON данные. 3 - XML данные. |
| posts | строка | Поле HTTP агента прототипа элементов данных. Данные тела запроса HTTP(S). Используется совместно с post_type. |
| privatekey | строка | Имя файла приватного ключа. |
| publickey | строка | Имя файла публичного ключа. |
| query_fields | массив | Поле HTTP агента прототипа элементов данных. Параметры запроса. Массив объектов с парами 'ключ':'значение', где значение может быть пустой строкой. |
| request_method | целое число | Поле HTTP агента прототипа элементов данных. Тип метода запроса. 0 - (по умолчанию) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | целое число | Поле HTTP агента прототипа элементов данных. Какую часть ответа нужно сохранять. 0 - (по умолчанию) Тело. 1 - Заголовки. 2 - Сохранять как тело, так и заголовки. Для request_method HEAD разрешенное значение только 1. |
| snmp_community | строка | SNMP community. Используется только прототипами элементов данных SNMPv1 и SNMPv2. |
| snmp_oid | строка | SNMP OID. |
| snmpv3_authpassphrase | строка | Фраза-пароль аутентификации SNMPv3. Используется только прототипами элементов данных SNMPv3. |
| snmpv3_authprotocol | целое число | Протокол аутентификации SNMPv3. Используется только прототипами элементов данных SNMPv3. Возможные значения: 0 - (по умолчанию) MD5; 1 - SHA. |
| snmpv3_contextname | строка | Имя контекста SNMPv3. Используется только прототипами элементов данных SNMPv3. |
| snmpv3_privpassphrase | строка | Фраза-пароль безопасности SNMPv3. Используется только прототипами элементов данных SNMPv3. |
| snmpv3_privprotocol | целое число | Протокол безопасности SNMPv3. Используется только прототипами элементов данных SNMPv3. Возможные значения: 0 - (по умолчанию) DES; 1 - AES. |
| snmpv3_securitylevel | целое число | Уровень безопасности SNMPv3. Используется только прототипами элементов данных SNMPv3. Возможные значения: 0 - noAuthNoPriv; 1 - authNoPriv; 2 - authPriv. |
| snmpv3_securityname | строка | Имя безопасности SNMPv3. Используется только прототипами элементов данных SNMPv3. |
| ssl_cert_file | строка | Поле HTTP агента прототипа элементов данных. Путь к файлу публичного SSL ключа. |
| ssl_key_file | строка | Поле HTTP агента прототипа элементов данных. Путь к файлу приватного SSL ключа. |
| ssl_key_password | строка | Поле HTTP агента прототипа элементов данных. Пароль к файлу SSL ключа. |
| status | целое число | Состояние прототипа элементов данных. Возможные значения: 0 - (по умолчанию) активированный элемент данных; 1 - деактивированный элемент данных; 3 - неподдерживаемый прототип элементов данных. |
| status_codes | строка | Поле HTTP агента прототипа элементов данных. Диапазоны требуемых HTTP кодов состояний, разделенные запятыми. Также как часть списка разделенного запятыми поддерживаются пользовательские макросы. Пример: 200,200-{$M},{$M},200-400 |
| templateid | строка | (только чтение) ID родительского прототипа элементов данных из шаблона. |
| timeout | строка | Поле HTTP агента прототипа элементов данных. Время ожидания запроса данных элемента данных. Поддерживаются пользовательские макросы. по умолчанию: 3s максимальное значение: 60s |
| trapper_hosts | строка | Разрешенные хосты. Используется траппер и HTTP агент прототипами элементов данных. |
| trends | целое число | Количество времени хранения данных динамики изменений. Также принимает пользовательские макросы и LLD макросы. По умолчанию: 365d. |
| units | строка | Единицы измерения значения. |
| username | строка | Имя пользователя для аутентификации. Используется прототипами элементов данных простой проверкой, SSH, Telnet, монитором баз данных, JMX и HTTP агентом. Требуется для прототипов элементов данных SSH и Telnet. |
| valuemapid | строка | ID связанного преобразования значений. |
| verify_host | целое число | Поле HTTP агента прототипа элементов данных. Проверка имени узла в URL в полях Common Name или Subject Alternate Name сертификата хоста. 0 - (по умолчанию) Не проверять. 1 - Проверять. |
| verify_peer | целое число | Поле HTTP агента прототипа элементов данных. Проверка подлинности сертификата хоста. 0 - (по умолчанию) Не проверять. 1 - Проверять. |
Item prototype preprocessing
The item prototype preprocessing object has the following properties.
| Property | Type | Description |
|---|---|---|
| type (required) |
integer | The preprocessing option type. Possible values: 1 - Custom multiplier; 2 - Right trim; 3 - Left trim; 4 - Trim; 5 - Regular expression matching; 6 - Boolean to decimal; 7 - Octal to decimal; 8 - Hexadecimal to decimal; 9 - Simple change; 10 - Change per second; 11 - XML XPath; 12 - JSONPath; 13 - In range; 14 - Matches regular expression; 15 - Does not match regular expression; 16 - Check for error in JSON; 17 - Check for error in XML; 18 - Check for error using regular expression; 19 - Discard unchanged; 20 - Discard unchanged with heartbeat; 21 - JavaScript; 22 - Prometheus pattern; 23 - Prometheus to JSON; 24 - CSV to JSON; 25 - Replace. |
| params (required) |
string | Additional parameters used by preprocessing option. Multiple parameters are separated by LF (\n) character. |
| error_handler (required) |
integer | Action type used in case of preprocessing step failure. Possible values: 0 - Error message is set by Zabbix server; 1 - Discard value; 2 - Set custom value; 3 - Set custom error message. |
| error_handler_params (required) |
string | Error handler parameters. Used with error_handler.Must be empty, if error_handler is 0 or 1.Can be empty if, error_handler is 2.Cannot be empty, if error_handler is 3. |
The following parameters and error handlers are supported for each preprocessing type.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Custom multiplier | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Right trim | list of characters2 | |||
| 3 | Left trim | list of characters2 | |||
| 4 | Trim | list of characters2 | |||
| 5 | Regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Boolean to decimal | 0, 1, 2, 3 | |||
| 7 | Octal to decimal | 0, 1, 2, 3 | |||
| 8 | Hexadecimal to decimal | 0, 1, 2, 3 | |||
| 9 | Simple change | 0, 1, 2, 3 | |||
| 10 | Change per second | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | In range | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Matches regular expression | pattern3 | 0, 1, 2, 3 | ||
| 15 | Does not match regular expression | pattern3 | 0, 1, 2, 3 | ||
| 16 | Check for error in JSON | path4 | 0, 1, 2, 3 | ||
| 17 | Check for error in XML | path4 | 0, 1, 2, 3 | ||
| 18 | Check for error using regular expression | pattern3 | output2 | 0, 1, 2, 3 | |
| 19 | Discard unchanged | ||||
| 20 | Discard unchanged with heartbeat | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Prometheus pattern | pattern6, 7 | output6, 8 | 0, 1, 2, 3 | |
| 23 | Prometheus to JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV to JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Replace | search string2 | replacement2 | ||
1 integer or floating-point number
2 string
3 regular expression
4 JSONPath or XML XPath
5 positive integer (with support of time suffixes, e.g. 30s, 1m, 2h, 1d)
6 user macro, LLD macro
7 Prometheus pattern following the syntax: <metric name>{<label name>="<label value>", ...} == <value>. Each Prometheus pattern component (metric, label name, label value and metric value) can be user macro or LLD macro.
8 Prometheus output following the syntax: <label name>.