On this page
Obiekt prototypu pozycji
Następujące obiekty są bezpośrednio powiązane z API itemprototype.
Prototyp pozycji
Obiekt prototypu pozycji ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| itemid | ID | ID prototypu pozycji. Property behavior: - read-only - required for update operations |
| delay | string | Interwał aktualizacji prototypu pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (np. 30s, 1m, 2h, 1d) oraz opcjonalnie jeden lub więcej custom intervals, wszystkie oddzielone średnikami. Niestandardowe interwały mogą być mieszanką interwałów elastycznych i harmonogramowych. Akceptuje makra użytkownika i makra LLD. Jeśli są używane, wartość musi być pojedynczym makrem. Nie są obsługiwane wiele makr ani makra połączone z tekstem. Interwały elastyczne można zapisywać jako dwa makra oddzielone ukośnikiem (np. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Przykład: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Property behavior: - required jeśli type jest ustawione na "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), lub jeśli type jest ustawione na "Zabbix agent (active)" (7) i key_ nie zawiera "mqtt.get" |
| hostid | ID | ID hosta, do którego należy prototyp pozycji. Property behavior: - constant - required for create operations |
| interfaceid | ID | ID interfejsu hosta prototypu pozycji. Property behavior: - required jeśli prototyp pozycji należy do hosta i type jest ustawione na "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" lub "SNMP agent"- supported jeśli prototyp pozycji należy do hosta i type jest ustawione na "Simple check", "External check", "SSH agent", "TELNET agent" lub "HTTP agent" |
| key_ | string | Klucz prototypu pozycji. Property behavior: - required for create operations - read-only for inherited objects |
| name | string | Nazwa prototypu pozycji. Obsługuje makra użytkownika. Property behavior: - required for create operations - read-only for inherited objects |
| type | integer | Typ prototypu pozycji. Possible values: 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. Property behavior: - required for create operations - read-only for inherited objects |
| url | string | Ciąg URL. Obsługuje makra LLD, makra użytkownika, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Property behavior: - required jeśli type jest ustawione na "HTTP agent"- read-only for inherited objects |
| value_type | integer | Typ informacji prototypu pozycji. Possible values: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary; 6 - JSON. Property behavior: - required for create operations - read-only for inherited objects |
| allow_traps | integer | Zezwala na wypełnianie wartości podobnie jak w przypadku pozycji typu trapper. 0 - (default) Nie zezwalaj na przyjmowanie danych przychodzących; 1 - Zezwalaj na przyjmowanie danych przychodzących. Property behavior: - supported jeśli type jest ustawione na "HTTP agent" |
| authtype | integer | Metoda uwierzytelniania. Possible values if type is set to "SSH agent":0 - (default) password; 1 - public key. Possible values if type is set to "HTTP agent":0 - (default) none; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest. Property behavior: - supported if type is set to "SSH agent" or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") |
| description | string | Opis prototypu pozycji. |
| flags | integer | Origin prototypu pozycji. Possible values: 2 - an item prototype; 6 - a discovered item prototype Property behavior: - read-only |
| follow_redirects | integer | Podążaj za przekierowaniami odpowiedzi podczas odpytywania danych. Possible values: 0 - Do not follow redirects; 1 - (default) Follow redirects. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| headers | array | Tablica headers, które zostaną wysłane podczas wykonywania żądania HTTP. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| history | string | Jednostka czasu określająca, jak długo mają być przechowywane dane historyczne. Obsługuje również makro użytkownika i makro LLD. Default: 31d. |
| http_proxy | string | Ciąg połączenia proxy HTTP(S). Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| ipmi_sensor | string | Czujnik IPMI. Property behavior: - required jeśli type jest ustawione na "IPMI agent" i key_ nie jest ustawione na "ipmi.get"- supported if type is set to "IPMI agent"- read-only for inherited objects |
| jmx_endpoint | string | Niestandardowy ciąg połączenia agenta JMX. Default: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Property behavior: - supported if type is set to "JMX agent" |
| logtimefmt | string | Format czasu w wpisach dziennika. Property behavior: - supported if value_type is set to "log"- read-only for inherited objects |
| master_itemid | ID | ID elementu nadrzędnego. Property behavior: - required jeśli type jest ustawione na "Dependent item"- read-only for inherited objects |
| output_format | integer | Czy odpowiedź ma zostać przekonwertowana do JSON. Possible values: 0 - (default) Store raw; 1 - Convert to JSON. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| params | string | Dodatkowe parametry zależne od typu prototypu pozycji: - wykonywany skrypt dla prototypów pozycji SSH agent i TELNET agent; - zapytanie SQL dla prototypów pozycji database monitor; - formuła dla prototypów pozycji calculated; - skrypt dla prototypów pozycji script i browser. Property behavior: - required jeśli type jest ustawione na "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" lub "Browser"- read-only for inherited objects (if type is set to "Script" or "Browser") |
| parameters | object/array | Dodatkowe parametry, jeśli type jest ustawione na "Script" lub "Browser". Tablica obiektów z właściwościami name i value, przy czym name musi być unikalne.Property behavior: - supported if type is set to "Script" or "Browser"- read-only for inherited objects |
| password | string | Hasło do uwierzytelniania. Property behavior: - required jeśli type jest ustawione na "JMX agent" i username jest ustawione- supported if type is set to "Simple check", "SSH agent", "TELNET agent", "Database monitor", or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") |
| post_type | integer | Typ treści danych POST przechowywanych we właściwości posts.Possible values: 0 - (default) Raw data; 2 - JSON data; 3 - XML data. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| posts | string | Dane treści żądania HTTP(S). Property behavior: - required jeśli type jest ustawione na "HTTP agent" i post_type jest ustawione na "JSON data" lub "XML data"- supported if type is set to "HTTP agent" and post_type is set to "Raw data"- read-only for inherited objects |
| privatekey | string | Nazwa pliku klucza prywatnego. Property behavior: - required jeśli type jest ustawione na "SSH agent" i authtype jest ustawione na "public key" |
| publickey | string | Nazwa pliku klucza publicznego. Property behavior: - required jeśli type jest ustawione na "SSH agent" i authtype jest ustawione na "public key" |
| query_fields | array | Tablica query fields, które zostaną wysłane podczas wykonywania żądania HTTP. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| request_method | integer | Typ metody żądania. Possible values: 0 - (default) GET; 1 - POST; 2 - PUT; 3 - HEAD. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| retrieve_mode | integer | Która część odpowiedzi ma zostać zapisana. Possible values if request_method is set to "GET", "POST", or "PUT":0 - (default) Body; 1 - Headers; 2 - Both body and headers will be stored. Possible values if request_method is set to "HEAD":1 - Headers. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| snmp_oid | string | OID SNMP. Property behavior: - required jeśli type jest ustawione na "SNMP agent"- read-only for inherited objects |
| ssl_cert_file | string | Ścieżka do pliku publicznego klucza SSL. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| ssl_key_file | string | Ścieżka do pliku prywatnego klucza SSL. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| ssl_key_password | string | Hasło do pliku klucza SSL. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| status | integer | Status prototypu pozycji. Possible values: 0 - (default) enabled item prototype; 1 - disabled item prototype; 3 - unsupported item prototype. |
| status_codes | string | Zakresy wymaganych kodów statusu HTTP, oddzielone przecinkami. Obsługuje również makra użytkownika lub makra LLD jako część listy rozdzielonej przecinkami. Przykład: 200,200-{$M},{$M},200-400 Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| templateid | ID | ID nadrzędnego prototypu pozycji szablonu. Property behavior: - read-only |
| timeout | string | Limit czasu żądania odpytywania danych pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (np. 30s, 1m). Akceptuje również makra użytkownika i makra LLD. Possible values range: 1-600s. Default: "" - use proxy/global settings. Property behavior: - supported if type is set to "Zabbix agent" (0), "Simple check" (3) and key_ does not start with "vmware." and "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 starts with "walk[" or "get[", "Script" (21), "Browser" (22)- read-only for inherited objects |
| trapper_hosts | string | Dozwolone hosty. Property behavior: - supported if type is set to "Zabbix trapper", or if type is set to "HTTP agent" and allow_traps is set to "Allow to accept incoming data".If the property is omitted, it is automatically set to the {$TRAPPER.ALLOWED_HOSTS} user macro (default value). By default, {$TRAPPER.ALLOWED_HOSTS} is 127.0.0.1,::1.If the property is set to an empty string, incoming connections will be denied from all hosts. |
| trends | string | Jednostka czasu określająca, jak długo mają być przechowywane dane trendów. Obsługuje również makro użytkownika i makro LLD. Default: 365d. Property behavior: - supported if value_type is set to "numeric float" or "numeric unsigned" |
| units | string | Jednostki wartości. Property behavior: - supported if value_type is set to "numeric float" or "numeric unsigned"- read-only for inherited objects |
| username | string | Nazwa użytkownika do uwierzytelniania. Property behavior: - required jeśli type jest ustawione na "SSH agent" lub "TELNET agent", albo jeśli type jest ustawione na "JMX agent" i password jest ustawione- supported if type is set to "Simple check", "Database monitor", or "HTTP agent"- read-only for inherited objects (if type is set to "HTTP agent") |
| uuid | string | Uniwersalny unikalny identyfikator, używany do łączenia importowanych prototypów pozycji z już istniejącymi. Generowany automatycznie, jeśli nie zostanie podany. Property behavior: - supported if the item prototype belongs to a template |
| valuemapid | ID | ID powiązanej mapy wartości. Property behavior: - supported if value_type is set to "numeric float", "character", or "numeric unsigned"- read-only for inherited objects |
| verify_host | integer | Czy sprawdzać, czy nazwa hosta dla połączenia zgadza się z nazwą w certyfikacie hosta. Possible values: 0 - (default) Do not validate; 1 - Validate. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| verify_peer | integer | Czy sprawdzać, czy certyfikat hosta jest autentyczny. Possible values: 0 - (default) Do not validate; 1 - Validate. Property behavior: - supported if type is set to "HTTP agent"- read-only for inherited objects |
| discover | integer | Status wykrywania prototypu pozycji. Possible values: 0 - (default) new items will be discovered; 1 - new items will not be discovered and existing items will be marked as lost. |
Nagłówek HTTP
Obiekt nagłówka ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| name | string | Nazwa nagłówka HTTP. Zachowanie właściwości: - wymagane |
| value | string | Wartość nagłówka. Zachowanie właściwości: - wymagane |
Pole zapytania HTTP
Obiekt pola zapytania definiuje nazwę i wartość używane do określenia parametru URL. Ma następujące właściwości:
| Właściwość | Typ | Opis |
|---|---|---|
| name | string | Nazwa parametru. Zachowanie właściwości: - wymagane |
| value | string | Wartość parametru. Zachowanie właściwości: - wymagane |
Tag prototypu pozycji
Obiekt tagu prototypu pozycji ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag | string | Nazwa tagu prototypu pozycji. Zachowanie właściwości: - wymagane |
| value | string | Wartość tagu prototypu pozycji. Zachowanie właściwości: - tylko do odczytu. |
| object | integer | Typ obiektu, z którego tag został odziedziczony. Możliwe wartości: 0 - szablon; 1 - host. Zachowanie właściwości: - tylko do odczytu. |
| objectid | ID | ID obiektu, z którego tag został odziedziczony. Zachowanie właściwości: - tylko do odczytu. |
Wstępne przetwarzanie prototypu pozycji
Obiekt wstępnego przetwarzania prototypu pozycji ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type | integer | Typ opcji wstępnego przetwarzania. Możliwe wartości: 1 - Mnożnik niestandardowy; 2 - Przytnij z prawej; 3 - Przytnij z lewej; 4 - Przytnij; 5 - Wyrażenie regularne; 6 - Wartość logiczna na dziesiętną; 7 - Ósemkowa na dziesiętną; 8 - Szesnastkowa na dziesiętną; 9 - Prosta zmiana; 10 - Zmiana na sekundę; 11 - XML XPath; 12 - JSONPath; 13 - W zakresie; 14 - Pasuje do wyrażenia regularnego; 15 - Nie pasuje do wyrażenia regularnego; 16 - Sprawdź błąd w JSON; 17 - Sprawdź błąd w XML; 18 - Sprawdź błąd za pomocą wyrażenia regularnego; 19 - Odrzuć niezmienione; 20 - Odrzuć niezmienione z heartbeat; 21 - JavaScript; 22 - Wzorzec Prometheus; 23 - Prometheus do JSON; 24 - CSV do JSON; 25 - Zamień; 26 - Sprawdź nieobsługiwane; 27 - XML do JSON; 28 - Wartość SNMP walk; 29 - SNMP walk do JSON; 30 - Wartość SNMP get. Zachowanie właściwości: - wymagane |
| params | string | Dodatkowe parametry używane przez opcję wstępnego przetwarzania. Wiele parametrów jest rozdzielanych znakiem nowej linii (\n). Jeśli type jest ustawione na "Sprawdź nieobsługiwane", parametry mają składnię <scope>[\n<pattern>], gdzie pattern jest wyrażeniem regularnym, a scope jest jednym z:-1 - dopasuj dowolny błąd; \ 0 - sprawdź, czy komunikat błędu pasuje do pattern; \ 1 - sprawdź, czy komunikat błędu nie pasuje do pattern. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na "Mnożnik niestandardowy" (1), "Przytnij z prawej" (2), "Przytnij z lewej" (3), "Przytnij" (4), "Wyrażenie regularne" (5), "XML XPath" (11), "JSONPath" (12), "W zakresie" (13), "Pasuje do wyrażenia regularnego" (14), "Nie pasuje do wyrażenia regularnego" (15), "Sprawdź błąd w JSON" (16), "Sprawdź błąd w XML" (17), "Sprawdź błąd za pomocą wyrażenia regularnego" (18), "Odrzuć niezmienione z heartbeat" (20), "JavaScript" (21), "Wzorzec Prometheus" (22), "Prometheus do JSON" (23), "CSV do JSON" (24), "Zamień" (25), "Sprawdź nieobsługiwane" (26), "Wartość SNMP walk" (28), "SNMP walk do JSON" (29) lub "Wartość SNMP get" (30) |
| error_handler | integer | Typ akcji używany w przypadku niepowodzenia kroku wstępnego przetwarzania. Możliwe wartości: 0 - Komunikat błędu jest ustawiany przez Zabbix server; 1 - Odrzuć wartość; 2 - Ustaw wartość niestandardową; 3 - Ustaw niestandardowy komunikat błędu. Możliwe wartości, jeśli type jest ustawione na "Sprawdź nieobsługiwane":1 - Odrzuć wartość; 2 - Ustaw wartość niestandardową; 3 - Ustaw niestandardowy komunikat błędu. Zachowanie właściwości: - wymagane, jeśli type jest ustawione na "Mnożnik niestandardowy" (1), "Wyrażenie regularne" (5), "Wartość logiczna na dziesiętną" (6), "Ósemkowa na dziesiętną" (7), "Szesnastkowa na dziesiętną" (8), "Prosta zmiana" (9), "Zmiana na sekundę" (10), "XML XPath" (11), "JSONPath" (12), "W zakresie" (13), "Pasuje do wyrażenia regularnego" (14), "Nie pasuje do wyrażenia regularnego" (15), "Sprawdź błąd w JSON" (16), "Sprawdź błąd w XML" (17), "Sprawdź błąd za pomocą wyrażenia regularnego" (18), "Wzorzec Prometheus" (22), "Prometheus do JSON" (23), "CSV do JSON" (24), "Sprawdź nieobsługiwane" (26), "XML do JSON" (27), "Wartość SNMP walk" (28), "SNMP walk do JSON" (29) lub "Wartość SNMP get" (30) |
| error_handler_params | string | Parametry obsługi błędów. Zachowanie właściwości: - wymagane, jeśli error_handler jest ustawione na "Ustaw wartość niestandardową" lub "Ustaw niestandardowy komunikat błędu" |
Dla każdego typu wstępnego przetwarzania obsługiwane są następujące parametry i procedury obsługi błędów.
| Typ wstępnego przetwarzania | Nazwa | Parametr 1 | Parametr 2 | Parametr 3 | Obsługiwane procedury obsługi błędów |
|---|---|---|---|---|---|
| 1 | Mnożnik niestandardowy | liczba1, 6 | 0, 1, 2, 3 | ||
| 2 | Przytnij z prawej | lista znaków2 | |||
| 3 | Przytnij z lewej | lista znaków2 | |||
| 4 | Przytnij | lista znaków2 | |||
| 5 | Wyrażenie regularne | wzorzec3 | wynik2 | 0, 1, 2, 3 | |
| 6 | Wartość logiczna na dziesiętną | 0, 1, 2, 3 | |||
| 7 | Ósemkowa na dziesiętną | 0, 1, 2, 3 | |||
| 8 | Szesnastkowa na dziesiętną | 0, 1, 2, 3 | |||
| 9 | Prosta zmiana | 0, 1, 2, 3 | |||
| 10 | Zmiana na sekundę | 0, 1, 2, 3 | |||
| 11 | XML XPath | ścieżka4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | ścieżka4 | 0, 1, 2, 3 | ||
| 13 | W zakresie | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Pasuje do wyrażenia regularnego | wzorzec3 | 0, 1, 2, 3 | ||
| 15 | Nie pasuje do wyrażenia regularnego | wzorzec3 | 0, 1, 2, 3 | ||
| 16 | Sprawdź błąd w JSON | ścieżka4 | 0, 1, 2, 3 | ||
| 17 | Sprawdź błąd w XML | ścieżka4 | 0, 1, 2, 3 | ||
| 18 | Sprawdź błąd za pomocą wyrażenia regularnego | wzorzec3 | wynik2 | 0, 1, 2, 3 | |
| 19 | Odrzuć niezmienione | ||||
| 20 | Odrzuć niezmienione z heartbeat | sekundy5, 6 | |||
| 21 | JavaScript | skrypt2 | |||
| 22 | Wzorzec Prometheus | wzorzec6, 7 | value, label, function |
wynik8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus do JSON | wzorzec6, 7 | 0, 1, 2, 3 | ||
| 24 | CSV do JSON | znak2 | znak2 | 0,1 | 0, 1, 2, 3 |
| 25 | Zamień | szukany ciąg2 | zamiennik2 | ||
| 26 | Sprawdź nieobsługiwane | zakres1 | wzorzec3, 6 | 1, 2, 3 | |
| 27 | XML do JSON | 0, 1, 2, 3 | |||
| 28 | Wartość SNMP walk | OID2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk do JSON10 | Nazwa pola2 | Prefiks OID2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 |
| 30 | Wartość SNMP get | Format: 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Liczba całkowita z BITS |
0, 1, 2, 3 | ||
1 liczba całkowita lub zmiennoprzecinkowa
2 ciąg znaków
3 wyrażenie regularne
4 JSONPath lub XML XPath
5 dodatnia liczba całkowita (z obsługą sufiksów czasu, np. 30s, 1m, 2h, 1d)
6 makro użytkownika, makro LLD
7 Wzorzec Prometheus zgodny ze składnią: <metric name>{<label name>="<label value>", ...} == <value>.
Każdy składnik wzorca Prometheus (metryka, nazwa etykiety, wartość etykiety i wartość metryki) może być makrem użytkownika lub makrem LLD.
8 Wynik Prometheus zgodny ze składnią: <label name> (może być makrem użytkownika lub makrem LLD), jeśli jako drugi parametr wybrano label.
9 Jedna z funkcji agregujących: sum, min, max, avg, count, jeśli jako drugi parametr wybrano function.
10 Obsługuje wiele rekordów "Nazwa pola,Prefiks OID,Format", rozdzielonych znakiem nowej linii.