Documentation
Table of Contents
> Item prototype object
Następujące obiekty są bezpośrednio związane z API itemprototype.
Item prototype
Obiekt item prototype ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| itemid | string | (tylko do odczytu) ID prototypu pozycji. |
| delay (wymagane) |
string | Interwał aktualizacji prototypu pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (30s,1m,2h,1d). Opcjonalnie można określić jedną lub więcej okresów użytkownika, zarówno jako interwały elastyczne, jak i harmonogramowanie. Wiele interwałów jest oddzielonych średnikiem. Można używać makr użytkownika i makr LLD. Jedno makro musi wypełnić całe pole. Wiele makr w polu lub makra mieszane z tekstem nie są obsługiwane. Elastyczne interwały można zapisać jako dwa makra oddzielone ukośnikiem (np. {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Opcjonalne dla trappera Zabbix, pozycji zależnych i dla aktywnego agenta Zabbix z kluczem mqtt.get. |
| hostid (wymagane) |
string | ID hosta, do którego należy prototyp pozycji. Dla operacji aktualizacji to pole jest tylko do odczytu. |
| ruleid (wymagane) |
string | ID reguły LLD, do której należy pozycja. Dla operacji aktualizacji to pole jest tylko do odczytu. |
| interfaceid (wymagane) |
string | ID interfejsu hosta prototypu pozycji. Używane tylko dla prototypów pozycji hosta. Nie jest wymagane dla aktywnego agenta Zabbix, sprawdzenia wewnętrznego Zabbix, trappera Zabbix, wartości obliczonej, zależnej, monitora bazy danych i prototypów pozycji typu skrypt. Opcjonalne dla prototypów pozycji agenta HTTP. |
| key_ (wymagane) |
string | Klucz prototypu pozycji. |
| name (wymagane) |
string | Nazwa prototypu pozycji. |
| type (wymagane) |
integer | Typ prototypu pozycji. Możliwe wartości: 0 - agent Zabbix; 2 - trapper Zabbix; 3 - proste sprawdzenie; 5 - wewnętrzny Zabbix; 7 - aktywny agent Zabbix; 10 - test zewnętrzny; 11 - monitor bazy danych; 12 - agent IPMI; 13 - agent SSH; 14 - agent TELNET; 15 - obliczona; 16 - agent JMX; 17 - pułapka SNMP; 18 - pozycja zależna; 19 - agent HTTP; 20 - agent SNMP; 21 - skrypt. |
| url (wymagane) |
string | Ciąg URL wymagany tylko dla prototypów pozycji agenta HTTP. Obsługuje makra LLD, makra użytkownika, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
| typ_wartości (wymagane) |
integer | Typ informacji o prototypie pozycji. Możliwe wartości: 0 - liczba zmiennoprzecinkowa; 1 - znak; 2 - log; 3 - liczba całkowita bez znaku; 4 - tekst. |
| allow_traps | integer | Pole prototypu pozycji agenta HTTP. PPozwala na wypełnienie wartości jak w przypadku typu pozycji trapper. 0 - (domyślnie) Nie zezwalaj na przyjmowanie przychodzących danych. 1 - Zezwalaj na przyjmowanie przychodzących danych. |
| authtype | integer | Używane tylko przez prototypy pozycji agenta SSH lub agenta HTTP. Możliwe wartości metody uwierzytelniania agenta SSH: 0 - (domyślnie) hasło; 1 - klucz publiczny. Możliwe wartości metody uwierzytelniania agenta HTTP: 0 - (domyślnie) brak 1 - podstawowy 2 - NTLM 3 - Kerberos |
| description | string | Opis prototypu pozycji. |
| follow_redirects | integer | Pole prototypu pozycji agenta HTTP. Podążaj za przekierowaniami odpowiedzi podczas pobierania danych. 0 - Nie podążaj za przekierowaniami. 1 - (domyślne) podążaj za przekierowaniami. |
| headers | object | Pole prototypu pozycji agenta HTTP. Obiekt z nagłówkami żądania HTTP(S), gdzie nazwa nagłówka jest używana jako klucz, a wartość nagłówka jako wartość. Przykład: { "User-Agent": "Zabbix" } |
| history | string | Jednostka czasu, przez ile dane historyczne mają być przechowywane. Akceptuje także makro użytkownika i makro LLD. Domyślnie: 90d. |
| http_proxy | string | Pole prototypu pozycji agenta HTTP. Ciąg połączenia z serwerem proxy HTTP(S). |
| ipmi_sensor | string | Czujnik IPMI. Używane tylko przez prototypy pozycji IPMI. |
| jmx_endpoint | string | Niestandardowy ciąg połączenia agenta JMX. Domyślna wartość: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
| logtimefmt | string | Format czasu w wpisach dziennika. Używane tylko przez prototypy pozycji typu log. |
| master_itemid | integer | ID pozycji nadrzędnej. Rekursja do 3 zależnych pozycji i prototypów pozycji oraz maksymalna liczba zależnych pozycji i prototypów pozycji równa 29999 są dozwolone. Wymagane przez pozycje zależne. |
| output_format | integer | Pole prototypu pozycji agenta HTTP. Czy odpowiedź powinna być konwertowana na JSON. 0 - (domyślnie) Przechowuj niezmienione. 1 - Konwertuj na JSON. |
| params | string | Dodatkowe parametry w zależności od typu prototypu pozycji: - wykonany skrypt dla prototypów pozycji SSH i Telnet; - zapytanie SQL dla prototypów monitora bazy danych; - wzór dla prototypów pozycji obliczonych. |
| parameters | array | Dodatkowe parametry dla prototypów pozycji typu skrypt. Tablica obiektów z właściwościami 'nazwa' i 'wartość', gdzie nazwa musi być unikalna. |
| password | string | Hasło do uwierzytelnienia. Używane przez prototypy pozycji prostego sprawdzenia, SSH, Telnet, monitora bazy danych, JMX i agenta HTTP. Wymagane przez prototypy pozycji SSH i Telnet. |
| post_type | integer | Pole prototypu pozycji agenta HTTP. Typ treści danych żądania przechowywanych w polu postów. 0 - (domyślnie) Dane nieprzetworzone. 2 - Dane JSON. 3 - Dane XML. |
| posts | string | Pole prototypu pozycji agenta HTTP. Dane treści żądania HTTP(S). Używane z post_type. |
| privatekey | string | Nazwa pliku klucza prywatnego. |
| publickey | string | Nazwa pliku klucza publicznego. |
| query_fields | array | Pole prototypu pozycji agenta HTTP. Parametry zapytania. Tablica obiektów z parami 'klucz':'wartość', gdzie wartość może być pustym ciągiem znaków. |
| request_method | integer | Pole prototypu pozycji agenta HTTP. Typ metody żądania. 0 - (domyślnie) GET 1 - POST 2 - PUT 3 - HEAD |
| retrieve_mode | integer | Pole prototypu pozycji agenta HTTP. Która część odpowiedzi powinna być przechowywana. 0 - (domyślnie) Treść. 1 - Nagłówki. 2 - Zarówno treść, jak i nagłówki będą przechowywane. Dla metody HEAD dozwolona jest tylko wartość 1. |
| snmp_oid | string | OID SNMP. |
| ssl_cert_file | string | Pole prototypu pozycji agenta HTTP. Ścieżka pliku klucza publicznego SSL. |
| ssl_key_file | string | Pole prototypu pozycji agenta HTTP. Ścieżka pliku klucza prywatnego SSL. |
| ssl_key_password | string | Pole prototypu pozycji agenta HTTP. Hasło do pliku klucza SSL. |
| 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 | Pole prototypu pozycji agenta HTTP. Zakresy wymaganych kodów stanu HTTP oddzielone przecinkami. Obsługuje również makra użytkownika lub makra LLD jako część listy oddzielonej przecinkami. Przykład: 200,200-{$M},{$M},200-400 |
| templateid | string | (tylko do odczytu) ID nadrzędnego szablonu prototypu pozycji. |
| timeout | string | Limit czasu żądania pobierania danych pozycji. Używane dla prototypów pozycji agenta HTTP i skryptu. Obsługuje makra użytkownika i makra LLD. domyślnie: 3s maksymalna wartość: 60s |
| trapper_hosts | string | Dozwolone hosty. Używane przez prototypy pozycji typu trapper lub prototypy pozycji HTTP. |
| trends | string | Jednostka czasu, przez ile dane trendów mają być przechowywane. Akceptuje także makro użytkownika i makro LLD. Domyślnie: 365d. |
| units | string | Jednostki wartości. |
| username | string | Nazwa użytkownika do uwierzytelnienia. Używane przez prototypy pozycji prostego sprawdzenia, SSH, Telnet, monitora bazy danych, JMX i agenta HTTP. Wymagane przez prototypy pozycji SSH i Telnet. |
| uuid | string | Uniwersalny unikalny identyfikator, używany do łączenia zaimportowanych prototypów pozycji z już istniejącymi. Używane tylko dla prototypów pozycji na szablonach. Automatycznie generowany, jeśli nie podano. |
| valuemapid | string | ID powiązanej mapy wartości. |
| verify_host | integer | Pole prototypu pozycji agenta HTTP. Czy należy zweryfikować, że nazwa hosta dla połączenia odpowiada tej w certyfikacie hosta. 0 - (domyślnie) Nie weryfikuj. 1 - Zweryfikuj. |
| verify_peer | integer | Pole prototypu pozycji agenta HTTP. Czy należy zweryfikować, że certyfikat hosta jest autentyczny. 0 - (domyślnie) Nie weryfikuj. 1 - Zweryfikuj. |
| discover | integer | Status wykrywania prototypu pozycji. Możliwe wartości: 0 - (domyślnie) nowe pozycje zostaną wykryte; 1 - nowe pozycje nie zostaną wykryte, a istniejące zostaną oznaczone jako utracone. |
Należy zauważyć, że dla niektórych metod (aktualizacja, usuwanie) kombinacja parametrów wymaganych/opcjonalnych jest inna.
Item prototype tag
Obiekt item prototype tag ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| tag (wymagane) |
string | Nazwa znacznika prototypu pozycji. |
| value | string | Wartość znacznika prototypu pozycji. |
Item prototype preprocessing
Obiekt item prototype preprocessing ma następujące właściwości.
| Właściwość | Typ | Opis |
|---|---|---|
| type (wymagane) |
integer | Typ opcji przetwarzania wstępnego. Możliwe wartości: 1 - Własny mnożnik; 2 - Przytnij z prawej; 3 - Przytnij z lewej; 4 - Przytnij; 5 - Wyrażenie regularne; 6 - Boolowski na dziesiętny; 7 - Ósemkowy na dziesiętny; 8 - Szesnastkowy na dziesiętny; 9 - Prosta zmiana; 10 - Zmiana na sekundę; 11 - XML XPath; 12 - Ścieżka JSONPath; 13 - W przedziale; 14 - Pasuje wyrażenie regularne; 15 - Brak dopasowania wyrażenia regularnego; 16 - Sprawdź błąd w JSON; 17 - Sprawdź błąd w XML; 18 - Sprawdź błąd przy użyciu wyrażenia regularnego; 19 - Odrzuć niezmienione; 20 - Odrzuć niezmienione z heartbeat; 21 - JavaScript; 22 - Wzorzec Prometheus; 23 - Prometheus na JSON; 24 - CSV na JSON; 25 - Zastąp; 26 - Sprawdź wartości nieobsługiwane; 27 - XML na JSON. |
| params (wymagane) |
string | Dodatkowe parametry używane przez opcję przetwarzania wstępnego. Wiele parametrów jest oddzielonych znakiem nowej linii (LF \n). |
| error_handler (wymagane) |
integer | Typ działania używany w przypadku niepowodzenia kroku przetwarzania wstępnego. Możliwe wartości: 0 - Komunikat o błędzie jest ustawiany przez serwer Zabbix; 1 - Odrzuć wartość; 2 - Ustaw niestandardową wartość; 3 - Ustaw niestandardowy komunikat o błędzie. |
| error_handler_params (wymagane) |
string | Parametry obsługi błędów. Używane z error_handler.Musi być puste, jeśli error_handler ma wartość 0 lub 1.Może być puste, jeśli error_handler ma wartość 2.Nie może być puste, jeśli error_handler ma wartość 3. |
Dla każdego typu przetwarzania wstępnego są obsługiwane następujące parametry i obsługa błędów.
| Typ przetwarzania wstępnego | Nazwa | Parametr 1 | Parametr 2 | Parametr 3 | Obsługiwane obsługi błędów |
|---|---|---|---|---|---|
| 1 | Własny mnożnik | 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 | wyjście2 | 0, 1, 2, 3 | |
| 6 | Boolowski na dziesiętny | 0, 1, 2, 3 | |||
| 7 | Ósemkowy na dziesiętny | 0, 1, 2, 3 | |||
| 8 | Szesnastkowy na dziesiętny | 0, 1, 2, 3 | |||
| 9 | Prosta zmiana | 0, 1, 2, 3 | |||
| 10 | Zmiana na sekundę | 0, 1, 2, 3 | |||
| 11 | XPath XML | ścieżka4 | 0, 1, 2, 3 | ||
| 12 | JSONPath | ścieżka4 | 0, 1, 2, 3 | ||
| 13 | W przedziale | min1, 6 | maks1, 6 | 0, 1, 2, 3 | |
| 14 | Pasuje wyrażenie regularne | wzorzec3 | 0, 1, 2, 3 | ||
| 15 | Brak dopasowania 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 | wyjście2 | 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 |
wyjście8, 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 | Zastąp | ciąg wyszukiwania2 | zastąpienie2 | ||
| 26 | Sprawdź wartości nieobsługiwane | 1, 2, 3 | |||
| 27 | XML do JSON | 0, 1, 2, 3 | |||
1 liczba całkowita bez znaku lub zmiennoprzecinkowa
2 ciąg znaków
3 wyrażenie regularne
4 JSONPath lub XPath XML
5 dodatnia liczba całkowita (z obsługą przyrostków czasu, np. 30s, 1m, 2h, 1d)
6 makro użytkownika
7 Wzorzec Prometheus zgodnie ze składnią: <nazwa metryki>{<nazwa etykiety>="<wartość etykiety>", ...} == <wartość>. Każda składowa wzorca Prometheus (metryka, nazwa etykiety, wartość etykiety i wartość metryki) może być makrem użytkownika lub makro LLD.
8 Wyjście Prometheus zgodnie ze składnią: <nazwa etykiety> (może być makrem użytkownika), jeśli jako drugi parametr jest wybrana opcja label.
9 Jedna z funkcji agregujących: sum, min, max, avg, count, jeśli jako drugi parametr jest wybrana opcja function