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: - tylko do odczytu - wymagane dla operacji aktualizacji |
| delay | string | Interwał aktualizacji prototypu pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (np. 30s, 1m, 2h, 1d) oraz opcjonalnie jeden lub więcej niestandardowych interwałów, wszystkie oddzielone średnikami. Niestandardowe interwały mogą być mieszanką interwałów elastycznych i harmonogramowanych. Akceptuje makra użytkownika i makra LLD. Jeśli są używane, wartość musi być pojedynczym makrem. Nie są obsługiwane wielokrotne makra ani makra połączone z tekstem. Interwały elastyczne można zapisać 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: - wymagane 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: - stałe - wymagane dla operacji tworzenia |
| interfaceid | ID | ID interfejsu hosta prototypu pozycji. Property behavior: - wymagane jeśli prototyp pozycji należy do hosta i type jest ustawione na "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap" lub "SNMP agent"- obsługiwane 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: - wymagane dla operacji tworzenia - tylko do odczytu dla obiektów dziedziczonych |
| name | string | Nazwa prototypu pozycji. Obsługuje makra użytkownika. Property behavior: - wymagane dla operacji tworzenia - tylko do odczytu dla obiektów dziedziczonych |
| type | integer | Typ prototypu pozycji. Możliwe wartości: 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: - wymagane dla operacji tworzenia - tylko do odczytu dla obiektów dziedziczonych |
| url | string | Łańcuch 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: - wymagane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| value_type | integer | Typ informacji prototypu pozycji. Możliwe wartości: 0 - numeric float; 1 - character; 2 - log; 3 - numeric unsigned; 4 - text; 5 - binary. Property behavior: - wymagane dla operacji tworzenia - tylko do odczytu dla obiektów dziedziczonych |
| allow_traps | integer | Zezwala na wypełnianie wartości podobnie jak w pozycji trapper. 0 - (domyślnie) Nie zezwalaj na przyjmowanie danych przychodzących; 1 - Zezwalaj na przyjmowanie danych przychodzących. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent" |
| authtype | integer | Metoda uwierzytelniania. Możliwe wartości jeśli type jest ustawione na "SSH agent":0 - (domyślnie) hasło; 1 - klucz publiczny. Możliwe wartości jeśli type jest ustawione na "HTTP agent":0 - (domyślnie) brak; 1 - basic; 2 - NTLM; 3 - Kerberos; 4 - Digest. Property behavior: - obsługiwane jeśli type jest ustawione na "SSH agent" lub "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych (jeśli type jest ustawione na "HTTP agent") |
| description | string | Opis prototypu pozycji. |
| flags | integer | Origin prototypu pozycji. Możliwe wartości: 2 - prototyp pozycji; 6 - wykryty prototyp pozycji Property behavior: - tylko do odczytu |
| follow_redirects | integer | Podążaj za przekierowaniami odpowiedzi podczas pobierania danych. Możliwe wartości: 0 - Nie podążaj za przekierowaniami; 1 - (domyślnie) Podążaj za przekierowaniami. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| headers | array | Tablica nagłówków, które zostaną wysłane podczas wykonywania żądania HTTP. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| history | string | Jednostka czasu określająca, jak długo mają być przechowywane dane historyczne. Akceptuje także makro użytkownika i makro LLD. Domyślnie: 31d. |
| http_proxy | string | Łańcuch połączenia proxy HTTP(S). Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| ipmi_sensor | string | Czujnik IPMI. Property behavior: - wymagane jeśli type jest ustawione na "IPMI agent" i key_ nie jest ustawione na "ipmi.get"- obsługiwane jeśli type jest ustawione na "IPMI agent"- tylko do odczytu dla obiektów dziedziczonych |
| jmx_endpoint | string | Niestandardowy łańcuch połączenia agenta JMX. Domyślnie: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Property behavior: - obsługiwane jeśli type jest ustawione na "JMX agent" |
| logtimefmt | string | Format czasu w wpisach dziennika. Property behavior: - obsługiwane jeśli value_type jest ustawione na "log"- tylko do odczytu dla obiektów dziedziczonych |
| master_itemid | ID | ID pozycji nadrzędnej. Property behavior: - wymagane jeśli type jest ustawione na "Dependent item"- tylko do odczytu dla obiektów dziedziczonych |
| output_format | integer | Czy odpowiedź ma zostać przekonwertowana do JSON. Możliwe wartości: 0 - (domyślnie) Zapisz surowe dane; 1 - Konwertuj do JSON. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| 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: - wymagane jeśli type jest ustawione na "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script" lub "Browser"- tylko do odczytu dla obiektów dziedziczonych (jeśli type jest ustawione na "Script" lub "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, gdzie name musi być unikalne.Property behavior: - obsługiwane jeśli type jest ustawione na "Script" lub "Browser"- tylko do odczytu dla obiektów dziedziczonych |
| password | string | Hasło do uwierzytelniania. Property behavior: - wymagane jeśli type jest ustawione na "JMX agent" i username jest ustawione- obsługiwane jeśli type jest ustawione na "Simple check", "SSH agent", "TELNET agent", "Database monitor" lub "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych (jeśli type jest ustawione na "HTTP agent") |
| post_type | integer | Typ treści danych POST przechowywanych we właściwości posts.Możliwe wartości: 0 - (domyślnie) Surowe dane; 2 - Dane JSON; 3 - Dane XML. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| posts | string | Dane treści żądania HTTP(S). Property behavior: - wymagane jeśli type jest ustawione na "HTTP agent" i post_type jest ustawione na "Dane JSON" lub "Dane XML"- obsługiwane jeśli type jest ustawione na "HTTP agent" i post_type jest ustawione na "Surowe dane"- tylko do odczytu dla obiektów dziedziczonych |
| privatekey | string | Nazwa pliku klucza prywatnego. Property behavior: - wymagane jeśli type jest ustawione na "SSH agent" i authtype jest ustawione na "klucz publiczny" |
| publickey | string | Nazwa pliku klucza publicznego. Property behavior: - wymagane jeśli type jest ustawione na "SSH agent" i authtype jest ustawione na "klucz publiczny" |
| query_fields | array | Tablica pól zapytania, które zostaną wysłane podczas wykonywania żądania HTTP. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| request_method | integer | Typ metody żądania. Możliwe wartości: 0 - (domyślnie) GET; 1 - POST; 2 - PUT; 3 - HEAD. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| retrieve_mode | integer | Która część odpowiedzi ma zostać zapisana. Możliwe wartości jeśli request_method jest ustawione na "GET", "POST" lub "PUT":0 - (domyślnie) Treść; 1 - Nagłówki; 2 - Zostaną zapisane zarówno treść, jak i nagłówki. Możliwe wartości jeśli request_method jest ustawione na "HEAD":1 - Nagłówki. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| snmp_oid | string | SNMP OID. Property behavior: - wymagane jeśli type jest ustawione na "SNMP agent"- tylko do odczytu dla obiektów dziedziczonych |
| ssl_cert_file | string | Ścieżka do pliku publicznego klucza SSL. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| ssl_key_file | string | Ścieżka do pliku prywatnego klucza SSL. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| ssl_key_password | string | Hasło do pliku klucza SSL. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| status | integer | Status prototypu pozycji. Możliwe wartości: 0 - (domyślnie) włączony prototyp pozycji; 1 - wyłączony prototyp pozycji; 3 - nieobsługiwany prototyp pozycji. |
| status_codes | string | Zakresy wymaganych kodów statusu HTTP, oddzielone przecinkami. Obsługuje także makra użytkownika lub makra LLD jako część listy rozdzielonej przecinkami. Przykład: 200,200-{$M},{$M},200-400 Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| templateid | ID | ID nadrzędnego prototypu pozycji szablonu. Property behavior: - tylko do odczytu |
| timeout | string | Limit czasu żądania odpytywania danych pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (np. 30s, 1m). Akceptuje także makra użytkownika i makra LLD. Zakres możliwych wartości: 1-600s. Domyślnie: "" - użyj ustawień proxy/globalnych. Property behavior: - obsługiwane jeśli type jest ustawione na "Zabbix agent" (0), "Simple check" (3) i key_ nie zaczyna się od "vmware." ani "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) i snmp_oid zaczyna się od "walk[" lub "get[", "Script" (21), "Browser" (22)- tylko do odczytu dla obiektów dziedziczonych |
| trapper_hosts | string | Dozwolone hosty. Property behavior: - obsługiwane jeśli type jest ustawione na "Zabbix trapper", lub jeśli type jest ustawione na "HTTP agent" i allow_traps jest ustawione na "Zezwalaj na przyjmowanie danych przychodzących" |
| trends | string | Jednostka czasu określająca, jak długo mają być przechowywane dane trendów. Akceptuje także makro użytkownika i makro LLD. Domyślnie: 365d. Property behavior: - obsługiwane jeśli value_type jest ustawione na "numeric float" lub "numeric unsigned" |
| units | string | Jednostki wartości. Property behavior: - obsługiwane jeśli value_type jest ustawione na "numeric float" lub "numeric unsigned"- tylko do odczytu dla obiektów dziedziczonych |
| username | string | Nazwa użytkownika do uwierzytelniania. Property behavior: - wymagane jeśli type jest ustawione na "SSH agent" lub "TELNET agent", albo jeśli type jest ustawione na "JMX agent" i password jest ustawione- obsługiwane jeśli type jest ustawione na "Simple check", "Database monitor" lub "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych (jeśli type jest ustawione na "HTTP agent") |
| uuid | string | Uniwersalny unikalny identyfikator, używany do powiązania importowanych prototypów pozycji z już istniejącymi. Generowany automatycznie, jeśli nie zostanie podany. Property behavior: - obsługiwane jeśli prototyp pozycji należy do szablonu |
| valuemapid | ID | ID powiązanej mapy wartości. Property behavior: - obsługiwane jeśli value_type jest ustawione na "numeric float", "character" lub "numeric unsigned"- tylko do odczytu dla obiektów dziedziczonych |
| verify_host | integer | Czy należy sprawdzać, czy nazwa hosta dla połączenia zgadza się z nazwą w certyfikacie hosta. Możliwe wartości: 0 - (domyślnie) Nie sprawdzaj; 1 - Sprawdzaj. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| verify_peer | integer | Czy należy sprawdzać, czy certyfikat hosta jest autentyczny. Możliwe wartości: 0 - (domyślnie) Nie sprawdzaj; 1 - Sprawdzaj. Property behavior: - obsługiwane jeśli type jest ustawione na "HTTP agent"- tylko do odczytu dla obiektów dziedziczonych |
| discover | integer | Status wykrywania prototypu pozycji. Możliwe wartości: 0 - (domyślnie) nowe pozycje będą wykrywane; 1 - nowe pozycje nie będą wykrywane, a istniejące pozycje zostaną oznaczone jako utracone. |
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 szablonu pozycji
Obiekt tagu szablonu pozycji ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| tag | string | Nazwa tagu szablonu pozycji. Property behavior: - required |
| value | string | Wartość tagu szablonu pozycji. |
Preprocessing prototypu pozycji
Obiekt preprocessing prototypu pozycji ma następujące właściwości.
| Property | Type | Description |
|---|---|---|
| type | integer | Typ opcji preprocessing. Możliwe wartości: 1 - Niestandardowy mnożnik; 2 - Przycinanie z prawej; 3 - Przycinanie z lewej; 4 - Przycinanie; 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 - Sprawdzenie błędu w JSON; 17 - Sprawdzenie błędu w XML; 18 - Sprawdzenie błędu 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 - Zastąp; 26 - Sprawdź jako nieobsługiwane; 27 - XML do JSON; 28 - Wartość z przebiegu SNMP walk; 29 - SNMP walk do JSON; 30 - Wartość SNMP get. Property behavior: - required |
| params | string | Dodatkowe parametry używane przez opcję preprocessing. Wiele parametrów jest oddzielonych znakiem nowej linii (\n). Jeśli type ma wartość "Check unsupported", parametry mają składnię <scope>[\n<pattern>], gdzie pattern jest wyrażeniem regularnym, a scope jest jedną z wartości:-1 - dopasuj dowolny błąd; \ 0 - sprawdź, czy komunikat błędu pasuje do pattern; \ 1 - sprawdź, czy komunikat błędu nie pasuje do pattern. Property behavior: - required jeśli type ma wartość "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), "Check unsupported" (26), "SNMP walk value" (28), "SNMP walk to JSON" (29) lub "SNMP get value" (30) |
| error_handler | integer | Typ akcji używany w przypadku niepowodzenia kroku preprocessing. Możliwe wartości: 0 - Komunikat błędu jest ustawiany przez serwer Zabbix; 1 - Odrzuć wartość; 2 - Ustaw wartość niestandardową; 3 - Ustaw niestandardowy komunikat błędu. Możliwe wartości, jeśli type ma wartość "Check unsupported":1 - Odrzuć wartość; 2 - Ustaw wartość niestandardową; 3 - Ustaw niestandardowy komunikat błędu. Property behavior: - required jeśli type ma wartość "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29) lub "SNMP get value" (30) |
| error_handler_params | string | Parametry obsługi błędów. Property behavior: - required jeśli error_handler ma wartość "Set custom value" lub "Set custom error message" |
Następujące parametry i obsługi błędów są obsługiwane dla każdego typu preprocessing.
| 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 | value, label, function |
output8, 9 | 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 | ||
| 26 | Check unsupported | scope1 | pattern3, 6 | 1, 2, 3 | |
| 27 | XML to JSON | 0, 1, 2, 3 | |||
| 28 | SNMP walk value | OID2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Integer z BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk to JSON10 | Field name2 | OID prefix2 | Format: 0 - Bez zmian 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Integer z BITS |
0, 1, 2, 3 |
| 30 | SNMP get value | Format: 1 - UTF-8 z Hex-STRING 2 - MAC z Hex-STRING 3 - Integer 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
element 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 label jest wybrane jako
drugi parametr.
9 jedna z funkcji agregujących: sum, min, max, avg, count, jeśli function jest wybrane jako drugi
parametr.
10 obsługuje wiele rekordów "Field name,OID prefix,Format records" rozdzielonych znakiem nowej linii.