Documentation
Table of Contents
Објект прототипа ставке
Следећи објекти су директно повезани са API-јем itemprototype.
Прототип ставке
Објекат прототипа ставке има следеће особине:
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID прототипа ставке. Понашање својства: - само за читање - обавезно за операције ажурирања |
| delay | string | Интервал ажурирања прототипа ставке. Прихвата секунде или временске јединице са суфиксом (нпр. 30s, 1m, 2h, 1d), као и један или више прилагођених интервала, раздвојених тачка-запетом. Прилагођени интервали могу бити мешавина флексибилних и распоредних интервала. Прихвата корисничке макрое и LLD макрое. Ако се користи, вредност мора бити један макро. Више макроа или мешавина макроа и текста нису подржани. Флексибилни интервали могу бити записани као два макроа раздвојена косом цртом (на пример, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Пример: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Понашање својства: - обавезно ако је type подешен на "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), или ако јеtype подешен на "Zabbix agent (active)" (7) и key_ не садржи "mqtt.get" |
| hostid | ID | ID домаћина коме припада прототип ставке. Понашање својства: - константно - обавезно за операције креирања |
| interfaceid | ID | ID интерфејса домаћина прототипа ставке. Понашање својства: - обавезно ако прототип ставке припада домаћину и type је подешен на "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", или "SNMP agent"- подржано ако прототип ставке припада домаћину и type је подешен на "Simple check", "External check", "SSH agent", "TELNET agent", или "HTTP agent" |
| key_ | string | Кључ прототипа ставке. Понашање својства: - обавезно за операције креирања - само за читање за наслеђене објекте |
| name | string | Назив прототипа ставке. Подржава корисничке макрое. Понашање својства: - обавезно за операције креирања - само за читање за наслеђене објекте |
| type | integer | Тип ставке прототипа. Могуће вредности: 0 - Zabbix agent; 2 - Zabbix trapper; 3 - Simple check; 5 - Zabbix internal; 7 - Zabbix agent (active); 10 - External check; 11 - Database monitor; 12 - IPMI agent; 13 - SSH agent; 14 - TELNET agent; 15 - Calculated; 16 - JMX agent; 17 - SNMP trap; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script; 22 - Browser. Понашање својства: - обавезно за операције креирања - само за читање за наслеђене објекте |
| url | string | URL string. Подржава LLD макрое, корисничке макрое, {HOST.IP}, {HOST.CONN}, {HOST.DNS }, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. Понашање својства:< br>- обавезно ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| value_type | integer | Тип информација од ставке прототипа. <br >Могуће вредности: 0 - flotante numérico; 1 - карактер; 2 - лог; 3 - нумеричка без знака; 4 - текст; 5 - бинарна Понашање својства: - обавезно за операције креирања - само за читање за наслеђене објекте |
| allow_traps | integer | Дозвола за пријем вредности као код trapper ставке. 0 - (подразумевано) Не дозвољава пријем података; 1 - Дозвољава пријем података. Понашање својства: - подржано ако је type подешен на "HTTP agent" |
| authtype | integer | Метод аутентификације. Могуће вредности ако је type подешен на "SSH agent":0 - (подразумевано) лозинка; 1 - јавни кључ. Могуће вредности ако је type подешен на "HTTP agent":0 - (подразумевано) без аутентификације; 1 - основна аутентификација; 2 - NTLM; 3 - Kerberos. Понашање својства: - подржано ако је type подешен на "SSH agent" или "HTTP agent"- само за читање за наслеђене објекте (ако је type подешен на "HTTP agent") |
| description | string | Опис за прототип ставке. |
| Праћење преусмеравања приликом прикупљања података. Могуће вредности: 0 - Не прати преусмеравања; 1 - (подразумевано) Прати преусмеравања. [Понашање својства] (/manual/api/reference_commentary#property-behavior): - подржано ако је type подешено на "HTTP agent"- само за читање за наслеђене објекте |
||
| headers | array | Низ headers који ће бити послат када се пошаље HTTP захтев Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| history | string | Временска јединица за чување података у историји. Такође прихвата макрое корисника и LLD макрое. Подразумевано: 31d |
| http_proxy | string | HTTP(S ) прокси веза. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| ipmi_sensor | string | IPMI сензор. Понашање својства: - обавезно ако је type подешен на "IPMI agent" и key_ није подешен на "ipmi.get"- обавезно ако је type подешен на "IPMI agent"- само за читање за наслеђене објекте |
| jmx_endpoint | string | Прилагођена веза до агента JMX. Подразумевано: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT }/jmxrmi Понашање својства: - подржано ако је type подешен на "JMX agent" |
| logtimefmt | string | Формат времена у лог уносима. Понашање својства: - подржано ако је value_type подешен на "log"<br >- само за читање за наслеђене објекте |
| master_itemid | ID | ID мастер ставке. Рекурзија до 3 зависне ставке и прототипа ставке и максимално 29999 зависних ставки и прототипа ставки. Понашање својствва: - обавезно ако је type подешен на "Зависна ставка"- само за читање за наслеђене објекте |
| output_format | integer | Треба ли одговор бити конвертован у JSON. Могуће вредности: 0 - (подразумевано) Сачувај сирове податке; 1 - Конвертуј у JSON. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| params | string | Додатни параметри зависно од типа прототипа ставке: - извршени скрипт за SSH и TELNET агент прототипе ставки; - SQL упит за прототипе ставки за мониторинг базе података; - формула за прототипе рачунатих ставки; - скрипт за скрипт и browser прототипе ставки. Понашање својства: - обавезно ако је type подешен на "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", или "Browser"- само за читање за наслеђене објекте (ако је type подешен на "Script" или "Browser") |
| parameters | object/array | Додатни параметри ако је type подешен на "Script" или "Browser". Низ објеката са својствима name и value properties, где name мора бити јединствено.Понашање својства: - подржано ако је type подешен на "Script" или "Browser- само за читање за наслеђене објекте |
| password | string | Лозинка за аутентификацију. Понашање својства: - обавезно ако је type подешен на "JMX agent" и username је подешен- подржано ако је type подешен на "Simple check", "SSH agent", "TELNET agent", "Database monitor", или "HTTP agent- само за читање за наслеђене објекте(ако је type подешен на "HTTP agent") |
| post_type | integer | Тип пост података сачуваних у posts својству.Могуће вредности: 0 - (подразумевано) Сирови подаци. 2 - JSON подаци. 3 - XML подаци. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| posts | string | HTTP(S) тело захтева. Понашање својства: - обавезно ако је type подешен на "HTTP agent" и post_type је подешен на "JSON data" или "XML data"- подржано ако је type подешен на "HTTP agent" и post_type је подешен на "Raw data"- само за читање за наслеђене објекте |
| privatekey | string | Назив датотеке приватног кључа. Понашање својства: - обавезно ако је type подешен на "SSH agent" и authtype је подешен на "јавни кључ" |
| publickey | string | Назив датотеке јавног кључа. Понашање својства: - обавезно ако је type подешен на "SSH agent" и authtype је подешен на "јавни кључ" |
| query_fields | array | Низ параметарапоља упита који ће бити послати приликом извршавања HTTP захтева. Понашање својства: - подржано ако је type постављен на "HTTP agent".- само за читање за наслеђене објекте. |
| request_method | integer | Тип методе захтева. Могуће вредности: 0 - (подразумевано) GET; 1 - POST; 2 - PUT; 3 - HEAD. Понашање својства: - обавезно ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| retrieve_mode | integer | Који део одговора ће бити сачуван. Могуће вредности ако је request_method подешен на "GET", "POST" или "PUT" :0 - (подразумевано) Тело; 1 - Заглавља; 2 - Тело и заглавља. Могуће вредности ако је request_method подешен на "HEAD ":1 - Заглавља. Понашање својства: - подржано ако је type подешен на "HTTP agent" - само за читање за наслеђене објекте |
| snmp_oid | string | SNMP OID. Понашање својства: - обавезно ако је type подешен на "SNMP agent"- само за читање за наслеђене објекте |
| ssl_cert_file | string | Путања до јавног SSL кључа. Понашање својства: - обавезно ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| ssl_key _file | string | Путања до приватног SSL кључа. Понашање својства: - обавезно ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| ssl_key_password | string | Лозинка за приватни SSL кључ. Понашање својства: - обавезно ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| status | integer | Статус прототипа ставке. Могуће вредности: 0 - (подразумевано) омогућен прототип ставке; 1 - онемогућен прототип ставке; 3 - неподржан прототип ставке. |
| status_codes | string | Опсези потребних HTTP статус кодова, одвојени запетама. Такође подржава корисничке или LLD макрое у оквиру листе. Пример: 200,200-{$M},{$M},200-400 Понашање својства: - подржано ако је typeподешен на "HTTP agent"- само за читање за наслеђене објекте |
| templateid | ID | ID надређеног шаблона прототипа ставке. Понашање својства: - само за читање |
| timeout | string | Време чекања за прикупљање података ставке. Прихвата секунде или јединицу времена са наставком (нпр. 30s, 1m). Такође прихвата корисничке и LLD макрое. Опсег могућих вредности: 1-600s. Подразумевано: "" - користе се прокси/глобална подешавања Понашање својства: - подржано ако је type подешен на "Zabbix agent" (0), "Simple check" (3) и key_ не поћиње са "vmware." и "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) and snmp_oid почиње са"walk[" или "get[", "Script" (21), "Browser" (22)- read-only fза наслеђене објекте |
| trapper_hosts | string | Подржани домаћини. Понашање својства: - подржано ако је type подешен на "Zabbix trapper", или је typeподешен на "HTTP agent" и allow_traps је подешен на "Дозвољено да прихвати долазне податке" |
| trends | string | Време трајања чувања података о трендовима. Такође прихвата корисничке и LLD макрое. Подразумевана вредност: 365d. Понашање својства: - подржано ако је value_type подешен на"numeric float" or "numeric unsigned" |
| units | string | Јединице вредности. Понашање својства: - подржано ако је value_type подешен на "numeric float" или "numeric unsigned"- само за читање за наслеђене објекте |
| username | string | Корисничко име за аутентификацију. Понашање својства: - обавезно ако је type подешен на "SSH agent"или "TELNET agent", или ако је type подешен на "JMX agent" и password је подешен- обавезно ако је type подешен на "Simple check", "Database monitor", или "HTTP agent"- само за читањеза наслеђене објекте (ако је typeподешен на "HTTP agent") |
| uuid | string | Универзални јединствени идентификатор, користи се за повезивање увезених прототипа ставки са већ постојећим. Аутоматски се генерише ако није унет. Понашање својства: - подржано ако прототип ставке припада шаблону |
| valuemapid | ID | ID мапе вредности која је повезана са ставком. Понашање својства: - подржано ако је value_type подешен на "numeric float", "character", или "numeric unsigned"- само за читање за наслеђене објекте |
| verify_host | integer | Да ли треба верификовати да име домаћина за конекцију одговара оном у домаћиновом сертификату. Могуће вредности: 0 - (подразумевано) Не верификовати; 1 - Верификовати. Понашање својства: - подржано ако је type подешен на "HTTP agent"- само за читање за наслеђене објекте |
| verify_peer | integer | Да ли треба верификовати аутентичност домаћиновог сертификата. Могуће вредности: 0 - (подразумевано) Не верификовати; 1 - Верификовати. Понашање својства: - * подржано* ако је type постављен на "HTTP agent".- само за читање за наслеђене објекте. |
| discover | integer | Статус откривања прототипа ставке. Могуће вредности: 0 - (подразумевано) нове ставке ће бити откривене; 1: нове ставке неће бити откривене, а постојеће ће бити означене као изгубљене. |
HTTP заглавље
Објекат заглавља има следећа својства:
| Property | Type | Description |
|---|---|---|
| name | string | Назив HTTP заглавља. Понашање својства: - обавезно |
| value | string | Вредност заглавља. [Понашање својства] |
| (/manual/api/reference_commentary#property-behavior): - обавезно |
HTTP поље за упит
Објекат поља упита дефинише име и вредност који се користе за навођење URL параметра. Има следећа својства:
| Property | Type | Description |
|---|---|---|
| name | string | Назив параметра. Понашање својства: - обавезно |
| value | string | Вредност параметра. Понашање својства: - обавезно |
Ознака прототипа ставке
Објекат ознаке прототипа ставке има следећа својства.
| Property | Type | Description |
|---|---|---|
| tag | string | Прототип ставке назива ознаке. Понашање својства: - обавезно |
| value | string | Вредност ознаке прототипа ставке. |
Предобрада прототипа ставке
Објекат предобраде прототипа ставке садржи следеће особине.
| Property | Type | Description |
|---|---|---|
| type | integer | Објекат предобраде прототипа ставке. Могуће вредности: 1 - Прилагођени множилац; 2 - Одсеци са десне стране; 3 - Одсеци са леве стране; 4 - Одсеци; 5 - Регуларни израз; 6 - Булово у децимално; 7 - Октални у децимални; 8 - Хексадецимални у децимални; 9 - Једноставна промена; 10 - Промена по секунди; 11 - XML XPath; 12 - JSONPath; 13 - У опсегу; 14 - Одговара регуларном изразу; 15 - Не одговара регуларном изразу; 16 - Провера грешке у JSON-у; 17 - Провера грешке у XML-у; 18 - Провера грешке коришћењем регуларног израза; 19 - Одбаци непромењено; 20 - Одбаци непромењено са провером; 21 - JavaScript; 22 - Прометеус образац; 23 - Прометеус у JSON; 24 - CSV у JSON; 25 - Замени; 26 - Означи неподржано; 27 - XML у JSON; 28 - SNMP преглед вредности; 29 - SNMP преглед у JSON формат; 30 - SNMP get вредност. Понашање својства: - обавезно |
| params | string | Додатни параметри који се користе у опцији предобраде. Више параметара се раздваја карактером новог реда (\n). Ако је type постављен на "Означи неподржано", параметри следе синтаксу <scope>[\n<pattern>] , где је pattern регуларни израз, а scope је један од:-1 - подударање било које грешке; 0 - провера да ли порука о грешци одговара pattern; 1 - провера да ли порука о грешци не одговара pattern. [Понашање својства(/manual/api/reference_commentary#property-behavior): - обавезно ако је type подешен на "Прилагођени множилац" (1), "Одсеци са десне стране" (2), "Одсеци са леве стране" (3), "Одсеци" (4), "Регуларни израз " (5), "XML XPath" (11), "JSONPath" (12), "У опсегу" (13), "Одговара регуларном изразу" (14), "Не одговара регуларном изразу" (15), "Провера грешке у JSON-у" (16), "Провера грешке у XML-у" (17), "Провера грешке коришћењем регуларног израза" (18), "Одбаци непромењено са провером" (20), "JavaScript" (21), "Прометеус образац" (22), "Прометеус у JSON" (23), "CSV у JSON" (24), "Замени" (25), "SNMP преглед вредности" (28), "SNMP преглед у JSON формат" (29 ), или "SNMP get вредност" (30) |
| error_handler | integer | Тип акције која се користи у случају неуспеха корака предобраде. Могуће вредности: 0: Поруку о грешци поставља сервер Zabbix-а; 1: Одбаци вредност; 2 - Постави прилагођену вредност; 3 - Постави прилагођену поруку о грешци. Могуће вредности ако је type постављен на "Означите неподржано":1 - Одбаци вредност; 2 - Постави прилагођену вредност; 3 - Постави прилагођену поруку о грешци. Понашање својства: - обавезно ако је type постављњн на "Прилагођени множилац" (1), "Регуларни израз" (5), "Булово у децимално" (6), "Октални у децимални" (7), "Хексадецимални у децимални" (8), "Једноставна промена" (9) , "Промена по секунди" (10), "XML XPath" (11), "JSONPath" (12), "У опсегу" (13), "Одговара регуларном изразу" (14), "Не одговара регуларном изразу" ( 15), "Провера грешке у JSON-у" (16), "Провера грешке у XML-у" (17), "Провера грешке коришћењем регуларног израза" (18), "Прометеус образац" (22), "Прометеус у JSON" (23), "CSV у JSON" (24), "Означи неподржано" (26), "XML у JSON" (27), "SNMP преглед вредности" (28), "SNMP преглед у JSON формат" (29), или "SNMP get вредност" (30) |
| error_handler | integer | Тип акције која се користи у случају неуспеха корака предобраде. Могуће вредности: 0: Поруку о грешци поставља сервер Zabbix-а; 1: Одбаци вредност; 2 - Постави прилагођену вредност; 3 - Постави прилагођену поруку о грешци. Могуће вредности ако је type постављено на "Означите неподржано":1 - Одбаци вредност; 2 - Постави прилагођену вредност; 3 - Постави прилагођену поруку о грешци. Понашање својства: - обавезно ако је type постављен на "Прилагођени множилац" (1), "Регуларни израз" (5), ";Булово у децимално" (6), "Октални у децимални" (7), ", Хексадецимални у децимални" (8), "Једноставна промена" (9) , "Промена по секунди" (10), "XML XPath" (11), "JSONPath" (12), "У опсегу" (13), "Одговара регуларном изразу" (14), "Не одговара регуларном изразу" ( 15), "Провера грешке у JSON-у; Провера грешке у JSON-у; Провера грешке у XML-у; Провера грешке коришћењем регуларног израза" (16), "Провера грешке у JSON-у" (17), "Провера грешке у XML-у" (18), "Прометеус образац" (22), "Прометеус у JSON;" (23), "CSV у JSON" (24), "Означи неподржано" (26), ", XML у JSON" (27), "SNMP преглед вредности" (28), ", SNMP преглед у JSON формат" (29), или "SNMP get вредност" (30) |
| error_handler_params | string | Параметри руковања грешкама. Понашање својства: - обавезно ако је error_handler подешен на "Постави прилагођену вредност" или "Постави прилагођену поруку о грешци" |
Следећи параметри и руковање грешкама су подржани за сваки тип предобраде.
| Preprocessing type | Name | Parameter 1 | Parameter 2 | Parameter 3 | Supported error handlers |
|---|---|---|---|---|---|
| 1 | Прилагођени множилац | number1, 6 | 0, 1, 2, 3 | ||
| 2 | Одсеци са десне стране | list of characters2 | |||
| 3 | Одсеци са леве стране | list of characters2 | |||
| 4 | Одсеци | list of characters2 | |||
| 5 | Регуларни израз | pattern3 | output2 | 0, 1, 2, 3 | |
| 6 | Булово у децимално | 0, 1, 2, 3 | |||
| 7 | Октални у децимални | 0, 1, 2, 3 | |||
| 8 | Хексадецимални у децимални | 0, 1, 2, 3 | |||
| 9 | Једноставна промена | 0, 1, 2, 3 | |||
| 10 | Промена по секунди | 0, 1, 2, 3 | |||
| 11 | XML XPath | path4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | path4 | 0, 1, 2, 3 | ||
| 13 | У опсегу | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Одговара регуларном изразу | pattern3 | 0, 1, 2, 3 | ||
| 15 | Не одговара регуларном изразу | pattern3 | 0, 1, 2, 3 | ||
| 16 | Провера грешке у JSON-у | path4 | 0, 1, 2, 3 | ||
| 17 | Провера грешке у XML-у | path4 | 0, 1, 2, 3 | ||
| 18 | Провера грешке коришћењем регуларног израза | pattern3 | outpu2 | 0, 1, 2, 3 | |
| 19 | Одбаци непромењено | ||||
| 20 | Одбаци непромењено са провером | seconds5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Прометеус образац | pattern6, 7 | value, label, function |
output8, 9 | 0, 1, 2, 3 |
| 23 | Прометеус у JSON | pattern6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV у JSON | character2 | character2 | 0,1 | 0, 1, 2, 3 |
| 25 | Замени | search string2 | replacement2 | ||
| 26 | Означи неподржано | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML у JSON | 0, 1, 2, 3 | |||
| 28 | SNMP преглед вредности | OID2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | |
| 29 | SNMP преглед у JSON формат10 | Field name2 | OID prefix2 | Format: 0 - Unchanged 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 |
| 30 | SNMP get вредност | Format: 1 - UTF-8 from Hex-STRING 2 - MAC from Hex-STRING 3 - Integer from BITS |
0, 1, 2, 3 | ||
1 integer или број са покретним зарезом
2 string
3 регуларни израз
4 JSONPath или XML XPath
5 позитивни integer (са подршком за суфиксе времена, 30s, 1m, 2h, 1d)
6 кориснички макро, LLD макро
7 Прометеус образац који прати следећу синтаксу: <metric name>{<label name>="<label value>", ...} == <value>. Сваки део Прометеус обрасца (метрика, назив етикете, вредност етикете и вредност метрике) може бити кориснички макро или LLD макро.
8 Прометеус излаз прати следећи излаз: <label name> (може бити кориснички макро или LLD макро) ако је label изабран као други параметар.\ 9 Једна од функција агрегације: suma, min, max, avg, count ако је function изабран као други параметар.
10 Подржава више записа у формату "Назив поља, OID префикс, формат записа", раздвојених карактером новог реда.