Następujące obiekty są bezpośrednio związane z API discoveryrule
.
Obiekt reguły wykrywania niskiego poziomu ma następujące właściwości.
Właściwość | Typ | Opis |
---|---|---|
itemid | string | (tylko do odczytu) Identyfikator ID reguły LLD. |
delay (wymagane) |
string | Interwał aktualizacji reguły LLD. Akceptuje sekundy lub jednostkę czasu z sufiksem oraz z jednym lub więcej okresami użytkownika lub bez nich, które składają się z interwałów elastycznych i interwałów harmonogramowania jako szeregowane ciągi.Akceptuje również makra użytkownika. Elastyczne interwały można zapisać jako dwa makra oddzielone ukośnikiem. Odstępy są oddzielone średnikiem. Opcjonalne dla trapera Zabbix, pozycji zależnych i dla agenta Zabbix (aktywnego) z kluczem mqtt.get . |
hostid (wymagane) |
string | Identyfikator hosta, do którego należy reguła LLD. |
interfaceid (wymagane) |
string | ID interfejsu hosta dla reguły LLD. Używane tylko dla reguł LLD hosta. <brNiewymagane dla agenta Zabbix (aktywnego), wewnętrznego Zabbix, trapera Zabbix, zależnego, monitora bazy danych i reguł LLD skryptów. Opcjonalne dla reguł LLD agenta HTTP. |
key_ (wymagane) |
string | Klucz reguły LLD. |
name (wymagane) |
string | Nazwa reguły LLD. |
type (wymagane) |
integer | Typ reguły LLD. Możliwe wartości: 0 - Agent Zabbix; 2 - Trapper Zabbix; 3 - Proste sprawdzenie; 5 - Wewnętrzny Zabbix; 7 - Agent Zabbix (aktywny); 10 - Test zewnętrzny; 11 - Monitor bazy danych; 12 - Agent IPMI; 13 - Agent SSH; 14 - Agent TELNET; 16 - Agent JMX; 18 - Pozycja zależna; 19 - Agent HTTP; 20 - Agent SNMP; 21 - Skrypt. |
url (wymagane) |
string | Ciąg adresu URL, wymagany dla reguły LLD agenta HTTP. Obsługuje makra użytkownika, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
allow_traps | integer | Pole reguły LLD typu Agent HTTP. Zezwalaj również na odbieranie wartości jak w pozycji typu traper. 0 - (domyślnie) Nie zezwalaj na przyjmowanie danych przychodzących. 1 - Zezwalaj na akceptowanie danych przychodzących. |
authtype | integer | Używane tylko przez reguły LLD typu Agent SSH lub Agent HTTP. Możliwe wartości metody uwierzytelniania agenta SSH: 0 - (domyślnie) hasło; 1 - klucz publiczny.< br> Metoda autoryzacji agenta HTTP możliwe wartości: 0 - (domyślnie) brak 1 - podstawowy 2 - NTLM |
description | string | Opis reguły LLD. |
error | string | (tylko do odczytu) Tekst błędu, jeśli występują problemy z aktualizacją reguły LLD. |
follow_redirects | integer | Pole reguły LLD typu Agent HTTP. Podążaj za przekierowaniami odpowiedzi podczas pobierania danych. 0 - Nie podążaj za przekierowaniami. 1 - (domyślnie) Podążaj za przekierowaniami. |
headers | object | Pole reguły LLD typu Agent 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" } |
http_proxy | string | Pole reguły LLD typu Agent HTTP. Parametry połączenia proxy HTTP(S). |
ipmi_sensor | string | Sensor IPMI. Używane tylko przez reguły LLD typu Agent IPMI. |
jmx_endpoint | string | Niestandardowe parametry połączenia agenta JMX. Wartość domyślna: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
lifetime | string | Czas, po którym elementy, które nie są już wykrywane, zostaną usunięte. Akceptuje sekundy, jednostkę czasu z sufiksem i makro użytkownika. Domyślnie: 30d . |
master_itemid | integer | ID pozycji głównej. Identyfikator elementu głównego. Dozwolona jest rekurencja do 3 elementów zależnych i maksymalna liczba elementów zależnych równa 999. Reguła wykrywania niskopoziomowego nie może być elementem głównym dla innej reguły LLD. < br>Wymagane dla pozycji zależnej. |
output_format | integer | Pole reguły LLD typu Agent HTTP. Czy odpowiedź powinna zostać przekonwertowana na JSON. 0 - (domyślnie) Dane nieprzetworzone. 1 - Konwertuj na JSON. |
params | string | Dodatkowe parametry w zależności od typu reguły LLD: - wykonywany skrypt dla reguł LLD typu SSH i Telnet; - zapytanie SQL dla reguł LLD typu monitor bazy danych; - formuła dla obliczonych reguł LLD . |
parameters | array | Dodatkowe parametry dla reguły LLD typu skrypt. Tablica obiektów z właściwościami „name” i „value”, gdzie nazwa musi być unikalna. |
password | string | Hasło do uwierzytelnienia. Używany przez reguły LLD typu proste sprawdzanie, monitor bazy danych, i agenta SSH, Telnet, JMX i HTTP. |
post_type | integer | Pole reguły LLD typu Agent HTTP. Typ żądanych treści przechowywanych we właściwości posts. 0 - (domyślnie) Dane nieprzetworzone. 2 - Dane JSON. 3 - Dane XML. |
posts | string | Pole reguły LLD typu Agent HTTP. Dane treści żądania HTTP(S). Używany z post_type. |
privatekey | string | Nazwa pliku klucza prywatnego. |
publickey | string | Nazwa pliku klucza publicznego. |
query_fields | array | Pole reguły LLD typu Agent HTTP. Parametry zapytania. Tablica obiektów z parami „klucz”: „wartość”, gdzie wartość może być pustym łańcuchem. |
request_method | integer | Pole reguły LLD typu Agent HTTP. Typ metody żądania. 0 - (domyślnie) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | Pole reguły LLD typu Agent HTTP.Jaka część odpowiedzi ma być przechowywana. 0 - (domyślnie) Treść. 1 - Nagłówki. 2 - Zarówno treść, jak i nagłówki będą przechowywane. Dla request_method HEAD tylko 1 jest dozwoloną wartością. |
snmp_oid | string | OID SNMP. |
ssl_cert_file | string | Pole reguły LLD typu Agent HTTP. Ścieżka pliku do publicznego klucza SSL. |
ssl_key_file | string | Pole reguły LLD typu Agent HTTP. Ścieżka pliku do prywatnego klucza SSL. |
ssl_key_password | string | Pole reguły LLD typu Agent HTTP. Hasło do pliku klucza SSL. |
state | integer | (tylko do odczytu) Stan reguły LLD. Możliwe wartości: 0 - (domyślnie) normalny; 1 - niewspierany. |
status | integer | Status reguły LLD. Możliwe wartości: 0 - (domyślnie) włączona reguła LLD; 1 - wyłączona reguła LLD. |
status_codes | string | Pole reguły LLD typu Agent HTTP.Zakresy wymaganych kodów stanu HTTP oddzielone przecinkami. Obsługuje również makra użytkownika jako część listy oddzielonej przecinkami. Przykład: 200,200-{$M},{$M},200-400 |
templateid | string | (tylko do odczytu)ID nadrzędnej reguły szablonu LLD. |
timeout | string | Limit czasu żądania pobrania danych pozycji. Używany dla reguł LLD typu agent HTTP i skrypt. Obsługuje makra użytkownika. domyślnie: 3s maksymalna wartość: 60s |
trapper_hosts | string | Dozwolone hosty. Używany przez reguły LLD typu traper lub agent HTTP. |
username | string | Username for authentication. żywany przez reguły LLD typu proste sprawdzanie, monitor bazy danych i agenta SSH, Telnet, JMX i HTTP. Wymagany dla reguł LLD typu agent SSH i Telnet. |
uuid | string | Uniwersalny unikalny identyfikator, używany do łączenia importowanych reguł LLD z już istniejącymi. Używane tylko w przypadku reguł LLD w szablonach. Wygenerowane automatycznie, jeśli nie podano. |
verify_host | integer | Pole reguły LLD typu Agent HTTP. Sprawdź poprawność nazwy URL w polu Nazwa pospolita lub Alternatywna nazwa podmiotu w certyfikacie hosta. 0 - (domyślnie) Nie sprawdzaj. 1 - Sprawdź. |
verify_peer | integer | Pole reguły LLD typu Agent HTTP. Sprawdź czy certyfikat hosta jest autentyczny. 0 - (domyślnie) Nie sprawdzaj. 1 - Sprawdź. |
Należy zauważyć, że dla niektórych metod (aktualizacja, usuwanie) kombinacja parametrów wymaganych/opcjonalnych jest inna.
Obiekt filtra reguły LLD definiuje zestaw warunków, które mogą być użyte do filtrowania wykrytych obiektów. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
conditions (wymagane) |
array | Zestaw warunków filtrowania używanych do filtrowania wyników. |
evaltype (wymagane) |
liczba całkowita | Metoda oceny stanu filtra. Możliwe wartości: 0 - i/lub; 1 - i; 2 - lub; 3 - wyrażenie użytkownika. |
eval_formula | string | (tylko do odczytu) Wygenerowane wyrażenie, które zostanie użyte do oceny warunków filtru. Wyrażenie zawiera identyfikatory, które odwołują się do określonych warunków filtru za pomocą „formulaid”. Wartość eval_formula jest równa wartości formula dla filtrów z wyrażeniem użytkownika. |
formula | string | Zdefiniowane przez użytkownika wyrażenie do oceny warunków filtrów za pomocą wyrażenia użytkownika. Wyrażenie musi zawierać identyfikatory, które odwołują się do określonych warunków filtru za pomocą „formulaid”. Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać identyfikatorom zdefiniowanym w warunkach filtra: żaden warunek nie może pozostać nieużywany ani pominięty. Wymagany w przypadku filtrów wyrażeń użytkownika. |
Obiekt warunku filtru reguły LLD definiuje oddzielne sprawdzenie wartości makra LLD. Ma następujące właściwości:
Właściwości | Typ | Opis |
---|---|---|
macro (wymagane) |
string | Makro LLD do sprawdzenia. |
value (wymagane) |
string | Wartość do porównania. |
formulaid | string | Dowolny unikalny identyfikator używany do odniesienia się do warunku z wyrażenia niestandardowego. Może zawierać tylko wielkie litery. Identyfikator musi być zdefiniowany przez użytkownika podczas modyfikacji warunków filtrowania, ale zostanie wygenerowany na nowo podczas późniejszego żądania. |
operator | integer | Operator warunku. Możliwe wartości: 8 - (domyślnie) pasuje do wyrażenia regularnego; 9 - nie pasuje do wyrażenia regularnego; 12 - istnieje;< br>13 - nie istnieje. |
To better understand how to use filters with various types of expressions, see examples on the discoveryrule.get and discoveryrule.create method pages. Aby lepiej zrozumieć, jak używać filtrów z różnymi typami wyrażeń, zobacz przykłady na stronach metod discoveryrule.get i discoveryrule.create.
Ścieżka makra LLD ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
lld_macro (wymagane) |
string | Makro LLD. |
path (wymagane) |
string | Selektor wartości, która zostanie przypisana do odpowiedniego makra. |
Obiekt przetwarzania wstępnego reguły LLD 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: 5 - Wyrażenie regularne; 11 - XML Xpath; 12 - Ścieżka JSON; 15 - Nie dopasowano regularnego wyrażenia; 16 - Sprawdź, czy nie ma błędu w JSON; 17 - Sprawdź, czy nie ma błędu w XML; 20 - Odrzuć niezmienione z heartbeat; 21 - JavaScript; 23 - Prometeusz na JSON; 24 - CSV do JSON; 25 - Zastąp; 27 - XML do JSON. |
params (wymagane) |
string | Dodatkowe parametry używane przez opcję przetwarzania wstępnego. Wiele parametrów jest oddzielonych znakiem LF (\n). |
error_handler (wymagane) |
integer | Typ akcji używany w przypadku niepowodzenia kroku przetwarzania wstępnego. Możliwe wartości: 0 - Komunikat o błędzie jest ustawiany przez serwer Zabbix;< br>1 - Odrzuć wartość; 2 - Ustaw wartość na; 3 - Ustaw błąd na. |
error_handler_params (wymagane) |
string | Parametry obsługi błędów. Używane z error_handler .Musi być puste, jeśli error_handler wynosi 0 lub 1.Może być puste, jeśli error_handler wynosi 2.Nie może być puste, jeśli error_handler wynosi 3. |
Następujące parametry i procedury obsługi błędów są obsługiwane dla każdego typu przetwarzania wstępnego.
Typ przetwarzania wstępnego | Nazwa | Parametr 1 | Parametr 2 | Parametr 3 | Obsługiwane typy obsługi błędów |
---|---|---|---|---|---|
5 | Wyrażenie regularne | wzór1 | dane wyjściowe2 | 0, 1, 2, 3 | |
11 | XML XPath | ścieżka3 | 0, 1, 2, 3 | ||
12 | Ścieżka JSON | ścieżka3 | 0, 1, 2, 3 | ||
15 | Nie dopasowano regularnego wyrażenia | wzór1 | 0, 1, 2, 3 | ||
16 | Sprawdź, czy nie ma błędu w JSON | ścieżka3 | 0, 1, 2, 3 | ||
17 | Sprawdź, czy nie ma błędu w XML | ścieżka3 | 0, 1, 2, 3 | ||
20 | Odrzuć niezmienione z heartbeat | sekundy4, 5 | |||
21 | JavaScript | script2 | |||
23 | Prometeusz na JSON | wzór5, 6 | 0, 1, 2, 3 | ||
24 | CSV do JSON | znak2 | znak2 | 0,1 | 0, 1, 2, 3 |
25 | Zastąp | szukany ciąg znaków2 | wymiana2 | ||
27 | XML do JSON | 0, 1, 2, 3 |
1 wyrażenie regularne
2ciąg znaków
3 JSONPath lub XML XPath
4 dodatnia liczba całkowita (z obsługą sufiksów czasu, np. 30s, 1m, 2h, 1d)
5 makro użytkownika
^ 6 ^ Wzór Prometeusza zgodny ze składnią: <nazwa metryki>{<nazwa etykiety>="<wartość etykiety>", ...} == <wartość>
. Każdy składnik wzorca Prometheus (metryka, nazwa etykiety, wartość etykiety i wartość metryki) może być makrem użytkownika.
8 Dane wyjściowe Prometeusza zgodne ze składnią: <label name>
.
Obiekt nadpisania reguły LLD definiuje zestaw reguł (filtry, warunki i operacje) które są używane do nadpisywania właściwości różnych obiektów prototypowych. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
name (wymagane) |
string | Unikatowa nazwa nadpisania. |
step (wymagane) |
integer | Unikalny numer porządkowy nadpisania. |
stop | integer | Zatrzymaj przetwarzanie nadpisania, jeżeli wykryto dopasowanie. Możliwe wartości: 0 - (domyślnie) nie zatrzymuj przetwarzania nadpisania; 1 - zatrzymaj przetwarzanie nadpisania, jeżeli filtr pasuje. |
filter | object | Filtr nadpisania. |
operations | array | Operacje nadpisania. |
Obiekt filtra nadpisywania reguły LLD definiuje zestaw warunków, które są stosowane, jeśli pasują do wykrytego obiektu. Posiada następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
evaltype (wymagane) |
integer | Zastąp metodę oceny warunku filtra. Możliwe wartości: 0 - i/lub; 1 - i; 2 - lub; 3 - wyrażenie użytkownika. |
conditions (wymagane) |
array | Zestaw nadpisywanych warunków filtra, które mają być używane do dopasowywania wykrytych obiektów. |
eval_formula | string | (tylko do odczytu) Wygenerowane wyrażenie, które będzie używane do oceny warunków filtru nadpisywania. Wyrażenie zawiera identyfikatory, które odwołują się do określonych warunków filtru zastępowania za pomocą jego formulaid . Wartość eval_formula jest równa wartości formuła dla filtrów z wyrażeniem użytkownika. |
formula | string | Zdefiniowane przez użytkownika wyrażenie, które ma być użyte do oceny warunków nadpisania filtrów za pomocą wyrażenia użytkownika. Wyrażenie musi zawierać identyfikatory, które odwołują się do określonych warunków filtru nadpisania za pomocą formulaid . Identyfikatory użyte w wyrażeniu muszą dokładnie odpowiadać identyfikatorom zdefiniowanym w warunkach filtra nadpisania: żaden warunek nie może pozostać niewykorzystany ani pominięty.Wymagany w przypadku filtrów nadpisania wyrażenia użytkownika. |
Obiekt warunku operacji nadpisania reguły LLD definiuje osobne sprawdzenie wartości makra LLD.. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
macro (wymagane) |
string | Makro LLD do wykonania sprawdzenia. |
value (wymagane) |
string | Wartość do porównania. |
formulaid | string | Dowolny unikalny identyfikator używany do odniesienia się do warunku z wyrażenia niestandardowego. Może zawierać tylko wielkie litery. Identyfikator musi być zdefiniowany przez użytkownika podczas modyfikowania warunków filtrowania, ale zostanie wygenerowany na nowo podczas późniejszego żądania. |
operator | integer | Operator warunku. Możliwe wartości: 8 - (domyślnie) pasuje do wyrażenia regularnego; 9 - nie pasuje do wyrażenia regularnego; 12 - istnieje;< br>13 - nie istnieje. |
Operacja zastąpienia reguły LLD jest kombinacją warunków i akcji do wykonania na obiekcie prototypowym. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
operationobject (wymagane) |
integer | Typ wykrytego obiektu do wykonania akcji. Możliwe wartości: 0 - Prototyp pozycji; 1 - Prototyp wyzwalacza;< br>2 — Prototyp wykresu; 3 — Prototyp hosta. |
operator | integer | Zastąp operator warunku. Możliwe wartości: 0 - (domyślnie) równa się; 1 - nie równa się; 2 - zawiera; 3 - nie zawiera; 8 - pasuje; 9 - nie pasuje. |
value | string | Wzorzec dopasowujący nazwę pozycji, wyzwalacza, wykresu lub prototypu hosta w zależności od wybranego obiektu. |
opstatus | object | Nadpisz status operacji obiektu nadpisania dla obiektów prototypów pozycji, wyzwalacza i hostów. |
opdiscover | object | Nadpisz status operacji wykrywania obiektów (wszystkie typy obiektów). |
opperiod | object | Nadpisz interwał operacji obiektu (interwał aktualizacji) dla obiektu prototypów pozycji. |
ophistory | object | Nadpisz historię operacji obiektu dla obiektu prototypów pozycji. |
optrends | object | Nadpisz trend operacji obiektu dla obiektu prototypów pozycji. |
opseverity | object | Nadpisz poziom operacji obiektu dla obiektu prototypów wyzwalaczy. |
optag | array | Nadpisz znaczniki operacji obiektu dla obiektów prototypów wyzwalaczy i hostów. |
optemplate | array | Nadpisz szablon operacji obiektów dla obiektów prototypów hosta. |
opinventory | object | Nadpisz inwentarz obiektów operacji dla obiektów prototyków hosta. |
Status operacji nadpisania reguły LLD, który jest ustawiony na wykryty obiekt. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
status (wymagane) |
integer | Zastąp stan wybranego obiektu. Możliwe wartości: 0 — tworzenie włączone; 1 — tworzenie wyłączone. |
Status wykrycia operacji nadpisania reguły LLD, który jest ustawiony na wykryty obiekt. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
discover (wymagane) |
integer | Zastąp stan wykrywania dla wybranego obiektu. Możliwe wartości: 0 - Tak, kontynuuj odkrywanie obiektów; 1 - Nie , nowe obiekty nie zostaną odkryte, a istniejące zostaną oznaczone jako utracone. |
Interwał operacji nadpisania reguły LLD to wartość interwału aktualizacji (wspiera interwały użytkownika) która jest ustawiona na wykrytą pozycję. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
delay (wymagane) |
string | Zastąp interwał aktualizacji prototypu pozycji. Akceptuje sekundy lub jednostkę czasu z sufiksem (30s,1m,2h,1d), a także elastyczne i harmonogramowane interwały oraz makra użytkownika lub makra LLD. Wiele interwałów powinno być oddzielone średnikiem. |
Wartość historii operacji nadpisania reguły LLD, która jest ustawiona na wykryty element. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
history (wymagane) |
string | Zastąp historię prototypu pozycji, która jest jednostką czasu określającą, jak długo dane historii powinny być przechowywane. Akceptuje również makro użytkownika i makro LLD. |
Wartość trendu operacji nadpisania reguły LLD, która jest ustawiona na wykryty element. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
trends (wymagane) |
string | Zastąp trend prototypu pozycji, która jest jednostką czasu określającą, jak długo dane trendu powinny być przechowywane. Akceptuje również makro użytkownika i makro LLD. |
Wartość poziomu operacji nadpisania reguły LLD, która jest ustawiona na wykryty wyzwalacz. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
severity (wymagane) |
integer | Zastąp poziom prototypu wyzwalacza. Możliwe wartości to: 0 - (domyślnie) niesklasyfikowany; 1 - informacja;< br>2 - ostrzeżenie; 3 - średni; 4 - wysoki; 5 - katastrofa. |
Obiekt znacznika operacji zastąpienia reguły LLD zawiera nazwę znacznika i wartość, które są ustawione na wykryty obiekt. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
tag (wymagane) |
string | Nowa nazwa znacznika. |
value | string | Nowa wartość znacznika. |
Obiekt szablonu operacji nadpisania reguły LLD, który jest połączony z wykrytym hostem. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
templateid (wymagane) |
string | Zastąp szablon połączonych szablonów prototypu hosta. |
Nadpisanie trybu inwentarza operacji reguły LLD, która jest ustawiona na wykryty host. Ma następujące właściwości:
Właściwość | Typ | Opis |
---|---|---|
inventory_mode (wymagane) |
integer | Zastąp tryb inwantarza prototypu hosta. Możliwe wartości to: -1 - wyłączony; 0 - (domyślnie ) ręczny; 1 - automatycznie. |