De volgende objecten zijn direct gerelateerd aan de discoveryrule
API.
De low-level discovery-regel heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
itemid | string | (alleen-lezen) ID van de LLD-regel. |
delay (verplicht) |
string | Update-interval van de LLD-regel. Accepteert seconden of tijdeenheid met achtervoegsel en met of zonder een of meer aangepaste intervallen die bestaan uit ofwel flexibele intervallen en geplande intervallen als geserialiseerde strings. Accepteert ook gebruikersmacro's. Flexibele intervallen kunnen worden geschreven als twee macro's gescheiden door een schuine streep. Intervallen zijn gescheiden door een puntkomma. Optioneel voor Zabbix trapper, afhankelijke items en voor Zabbix-agent (actief) met de sleutel mqtt.get . |
hostid (verplicht) |
string | ID van de host waartoe de LLD-regel behoort. |
interfaceid (verplicht) |
string | ID van de hostinterface van de LLD-regel. Alleen gebruikt voor host LLD-regels. Niet vereist voor Zabbix-agent (actief), Zabbix intern, Zabbix-trapper, afhankelijke, database monitor en script LLD-regels. Optioneel voor HTTP-agent LLD-regels. |
key_ (verplicht) |
string | Sleutel van de LLD-regel. |
name (verplicht) |
string | Naam van de LLD-regel. |
type (verplicht) |
integer | Type van de LLD-regel. Mogelijke waarden: 0 - Zabbix-agent; 2 - Zabbix-trapper; 3 - eenvoudige controle; 5 - Zabbix intern; 7 - Zabbix-agent (actief); 10 - externe controle; 11 - database monitor; 12 - IPMI-agent; 13 - SSH-agent; 14 - TELNET-agent; 16 - JMX-agent; 18 - Afhankelijk item; 19 - HTTP-agent; 20 - SNMP-agent; 21 - Script. |
url (verplicht) |
string | URL-tekenreeks, vereist voor HTTP-agent LLD-regel. Ondersteunt gebruikersmacro's, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
allow_traps | integer | Veld voor HTTP-agent LLD-regel. Hiermee kan de waarde worden ingevuld zoals bij het trapper-itemtype. 0 - (standaard) Niet toestaan om inkomende gegevens te accepteren. 1 - Toestaan om inkomende gegevens te accepteren. |
authtype | integer | Alleen gebruikt door SSH-agent- of HTTP-agent-LLD-regels. Mogelijke waarden voor SSH-agent authenticatiemethode: 0 - (standaard) wachtwoord; 1 - openbare sleutel. Mogelijke waarden voor HTTP-agent authenticatiemethode: 0 - (standaard) geen 1 - basis 2 - NTLM |
description | string | Beschrijving van de LLD-regel. |
error | string | (alleen-lezen) Fouttekst als er problemen zijn bij het bijwerken van de LLD-regel. |
follow_redirects | integer | Veld voor HTTP-agent LLD-regel. Volg doorverwijzingen in de respons bij het ophalen van gegevens. 0 - Volg geen doorverwijzingen. 1 - (standaard) Volg doorverwijzingen. |
headers | object | Veld voor HTTP-agent LLD-regel. Object met HTTP(S)-verzoekheaders, waarbij de naam van de header wordt gebruikt als sleutel en de waarde van de header als waarde. Voorbeeld: { "User-Agent": "Zabbix" } |
http_proxy | string | Veld voor HTTP-agent LLD-regel. Verbindingsreeks voor HTTP(S)-proxy. |
ipmi_sensor | string | IPMI-sensor. Alleen gebruikt door IPMI LLD-regels. |
jmx_endpoint | string | Aangepaste verbindingsreeks voor JMX-agent. Standaardwaarde: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
lifetime | string | Tijdsperiode waarna items die niet meer ontdekt worden, worden verwijderd. Accepteert seconden, tijdeenheid met achtervoegsel en gebruikersmacro. Standaard: 30d . |
master_itemid | integer | ID van het hoofditem. Herhaling tot 3 afhankelijke items en een maximale telling van afhankelijke items gelijk aan 999 zijn toegestaan. Een ontdekkingsregel kan geen hoofditem zijn voor een andere ontdekkingsregel. Vereist voor Afhankelijk item. |
output_format | integer | Veld voor HTTP-agent LLD-regel. Moet de respons worden geconverteerd naar JSON. 0 - (standaard) Opslaan als onbewerkt. 1 - Converteren naar JSON. |
params | string | Aanvullende parameters afhankelijk van het type LLD-regel: - uitgevoerd script voor SSH- en Telnet LLD-regels; - SQL-query voor database monitor LLD-regels; - formule voor berekende LLD-regels. |
parameters | array | Aanvullende parameters voor LLD-regel van het scripttype. Array van objecten met eigenschappen 'name' en 'value', waarbij de naam uniek moet zijn. |
password | string | Wachtwoord voor authenticatie. Gebruikt door eenvoudige controle, SSH, Telnet, database monitor, JMX en HTTP-agent LLD-regels. |
post_type | integer | Veld voor HTTP-agent LLD-regel. Type van gegevensbody voor verzenden opgeslagen in de eigenschap 'posts'. 0 - (standaard) Onbewerkte gegevens. 2 - JSON-gegevens. 3 - XML-gegevens. |
posts | string | Veld voor HTTP-agent LLD-regel. Gegevensbody voor HTTP(S)-verzoek. Gebruikt met post_type. |
privatekey | string | Naam van het privésleutelbestand. |
publickey | string | Naam van het openbare sleutelbestand. |
query_fields | array | Veld voor HTTP-agent LLD-regel. Queryparameters. Array van objecten met 'key':'value'-paren, waarbij de waarde een lege tekenreeks kan zijn. |
request_method | integer | Veld voor HTTP-agent LLD-regel. Type van verzoekmethode. 0 - (standaard) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | Veld voor HTTP-agent LLD-regel. Welk deel van de respons moet worden opgeslagen. 0 - (standaard) Body. 1 - Headers. 2 - Zowel body als headers worden opgeslagen. Voor verzoek_methode HEAD is alleen de waarde 1 toegestaan. |
snmp_oid | string | SNMP-OID. |
ssl_cert_file | string | Veld voor HTTP-agent LLD-regel. Pad naar openbaar SSL-sleutelbestand. |
ssl_key_file | string | Veld voor HTTP-agent LLD-regel. Pad naar privé SSL-sleutelbestand. |
ssl_key_password | string | Veld voor HTTP-agent LLD-regel. Wachtwoord voor SSL-sleutelbestand. |
state | integer | (alleen-lezen) Status van de LLD-regel. Mogelijke waarden: 0 - (standaard) normaal; 1 - niet ondersteund. |
status | integer | Status van de LLD-regel. Mogelijke waarden: 0 - (standaard) ingeschakelde LLD-regel; 1 - uitgeschakelde LLD-regel. |
status_codes | string | Veld voor HTTP-agent LLD-regel. Bereiken van vereiste HTTP-statuscodes gescheiden door komma's. Ondersteunt ook gebruikersmacro's als onderdeel van de komma-gescheiden lijst. Voorbeeld: 200,200-{$M},{$M},200-400 |
templateid | string | (alleen-lezen) ID van de bovenliggende sjabloon LLD-regel. |
timeout | string | Time-out voor het aanvragen van itemgegevens. Gebruikt voor HTTP-agent- en script LLD-regels. Ondersteunt gebruikersmacro's. Standaard: 3s Maximale waarde: 60s |
trapper_hosts | string | Toegestane hosts. Gebruikt door trapper LLD-regels of HTTP-agent LLD-regels. |
username | string | Gebruikersnaam voor authenticatie. Gebruikt door eenvoudige controle, SSH, Telnet, database monitor, JMX en HTTP-agent LLD-regels. Vereist voor SSH- en Telnet LLD-regels. |
uuid | string | Universeel unieke identifier, gebruikt om geïmporteerde LLD-regels te koppelen aan reeds bestaande regels. Alleen gebruikt voor LLD-regels op sjablonen. Wordt automatisch gegenereerd als niet opgegeven. |
verify_host | integer | Veld voor HTTP-agent LLD-regel. Valideer of de hostnaam in de URL zich bevindt in het Common Name-veld of een Subject Alternate Name-veld van het hostcertificaat. 0 - (standaard) Niet valideren. 1 - Valideren. |
verify_peer | integer | Veld voor HTTP-agent LLD-regel. Valideer of het hostcertificaat authentiek is. 0 - (standaard) Niet valideren. 1 - Valideren. |
Merk op dat voor sommige methoden (update, delete) de vereiste/optie parametercombinatie anders is.
Het LLD-regelfilterobject definieert een set voorwaarden die kunnen worden gebruikt om ontdekte objecten te filteren. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
voorwaarden (vereist) |
array | Set van filtervoorwaarden om te gebruiken voor het filteren van resultaten. |
evaltype (vereist) |
geheel getal | Filterconditie-evaluatiemethode. Mogelijke waarden: 0 - en/of; 1 - en; 2 - of; 3 - aangepaste expressie. |
eval_formula | string | (alleen-lezen) Gegenereerde expressie die zal worden gebruikt voor het evalueren van filtervoorwaarden. De expressie bevat ID's die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid . De waarde van eval_formula is gelijk aan de waarde van formule voor filters met een aangepaste expressie. |
formula | string | Door de gebruiker gedefinieerde expressie die moet worden gebruikt voor het evalueren van voorwaarden van filters met een aangepaste expressie. De expressie moet ID's bevatten die verwijzen naar specifieke filtervoorwaarden door middel van de formulaid . De ID's die in de expressie worden gebruikt, moeten exact overeenkomen met de ID's die zijn gedefinieerd in de filtervoorwaarden: geen enkele voorwaarde mag ongebruikt blijven of worden weggelaten.Vereist voor aangepaste expressiefilters. |
Het LLD-regelfiltervoorwaardeobject definieert een afzonderlijke controle die moet worden uitgevoerd op de waarde van een LLD-macro. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
macro (vereist) |
string | LLD-macro om de controle uit te voeren. |
waarde (verplicht) |
string | Waarde om mee te vergelijken. |
formulaid | string | Willekeurige unieke ID die wordt gebruikt om te verwijzen naar de voorwaarde vanuit een aangepaste expressie. Mag alleen hoofdletters bevatten. De ID moet door de gebruiker worden gedefinieerd bij het wijzigen van filtervoorwaarden, maar wordt opnieuw gegenereerd wanneer ze daarna worden aangevraagd. |
operator | geheel getal | Condition-operator. Mogelijke waarden: 8 - (standaard) komt overeen met reguliere expressie; 9 - komt niet overeen met reguliere expressie; 12 - bestaat;< br>13 - bestaat niet. |
Om beter te begrijpen hoe u filters kunt gebruiken met verschillende soorten uitdrukkingen, zie voorbeelden op de discoveryrule.get en discoveryrule.create methode Pagina's.
Het LLD-macropad heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
lld_macro (vereist) |
string | LLD-macro. |
path (verplicht) |
string | Selector voor waarde die wordt toegewezen aan corresponderende macro. |
Het object voor LLD-regel voorverwerking heeft de volgende eigenschappen.
Eigenschap | Type | Beschrijving |
---|---|---|
type (verplicht) |
integer | Het type voorverwerkingsmogelijkheid. Mogelijke waarden: 5 - Regelmatige expressie-overeenkomst; 11 - XML XPath; 12 - JSONPath; 15 - Komt niet overeen met reguliere expressie; 16 - Controleren op fout in JSON; 17 - Controleren op fout in XML; 20 - Onveranderd verwerpen met heartbeat; 21 - JavaScript; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervangen; 27 - XML naar JSON. |
params (verplicht) |
string | Aanvullende parameters die worden gebruikt door de voorverwerkingsmogelijkheid. Meerdere parameters worden gescheiden door het LF (\n) teken. |
error_handler (verplicht) |
integer | Actietype dat wordt gebruikt in geval van mislukking van de voorverwerkingsstap. Mogelijke waarden: 0 - Foutbericht wordt ingesteld door de Zabbix-server; 1 - Waarde verwerpen; 2 - Aangepaste waarde instellen; 3 - Aangepast foutbericht instellen. |
error_handler_params (verplicht) |
string | Parameters voor foutafhandeling. Gebruikt met error_handler .Moet leeg zijn als error_handler 0 of 1 is.Mag leeg zijn als error_handler 2 is.Kan niet leeg zijn als error_handler 3 is. |
De volgende parameters en foutafhandelingsmethoden worden ondersteund voor elk voorverwerkingstype.
Voorverwerkingstype | Naam | Parameter 1 | Parameter 2 | Parameter 3 | Ondersteunde foutafhandelingen |
---|---|---|---|---|---|
5 | Reguliere expressie | patroon1 | uitvoer2 | 0, 1, 2, 3 | |
11 | XML XPath | pad3 | 0, 1, 2, 3 | ||
12 | JSONPath | pad3 | 0, 1, 2, 3 | ||
15 | Komt niet overeen met reguliere expressie | patroon1 | 0, 1, 2, 3 | ||
16 | Controleren op fout in JSON | pad3 | 0, 1, 2, 3 | ||
17 | Controleren op fout in XML | pad3 | 0, 1, 2, 3 | ||
20 | Onveranderd verwerpen met heartbeat | seconden4, 5 | |||
21 | JavaScript | script2 | |||
23 | Prometheus naar JSON | patroon5, 6 | 0, 1, 2, 3 | ||
24 | CSV naar JSON | tekenreeks2 | tekenreeks2 | 0,1 | 0, 1, 2, 3 |
25 | Vervangen | zoekreeks2 | vervanging2 | ||
27 | XML naar JSON | 0, 1, 2, 3 |
1 reguliere expressie
2 tekenreeks
3 JSONPath of XML XPath
4 positief geheel getal (met ondersteuning van tijdachtervoegsels, bijv. 30s, 1m, 2u, 1d)
5 gebruikersmacro
6 Prometheus-patroon volgens de syntaxis: <metricanaam>{<labelnaam>="<labelwaarde>", ...} == <waarde>
. Elk Prometheus-patrooncomponent (metriek, labelnaam, labelwaarde en metriekwaarde) kan een gebruikersmacro zijn.
De LLD-regel overschrijft object definieert een set regels (filters, voorwaarden en bewerkingen) die worden gebruikt om eigenschappen van verschillende prototype-objecten. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
naam (verplicht) |
string | Unieke overschrijfnaam. |
step (verplicht) |
geheel getal | Uniek volgnummer van de override. |
stop | geheel getal | Stop de verwerking van volgende overschrijvingen als deze overeenkomen. Mogelijke waarden: 0 - (standaard) stop de verwerking van overschrijvingen niet; 1 - stop de verwerking van overschrijvingen als het filter overeenkomt. |
filter | object | Filter overschrijven. |
operaties | array | Bewerkingen overschrijven. |
Het LLD-regel-override-filterobject definieert een set voorwaarden die als ze komen overeen met het gevonden object waarop de overschrijving is toegepast. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
evaltype (vereist) |
geheel getal | Evaluatiemethode filtervoorwaarde overschrijven. Mogelijke waarden: 0 - en/of; 1 - en; 2 - of; 3 - aangepaste uitdrukking. |
voorwaarden (vereist) |
array | Set van filtervoorwaarden voor het negeren van de gevonden objecten. |
eval_formula | string | (alleen-lezen) Gegenereerde expressie die zal worden gebruikt voor het evalueren van override-filtervoorwaarden. De expressie bevat ID's die verwijzen naar specifieke filtervoorwaarden die worden overschreven door de formulaid'. De waarde van eval_formulais gelijk aan de waarde van formule` voor filters met een aangepaste expressie. |
formula | string | Door de gebruiker gedefinieerde expressie die moet worden gebruikt voor het evalueren van voorwaarden van het overschrijven van filters met een aangepaste expressie. De expressie moet ID's bevatten die verwijzen naar specifieke filtervoorwaarden die worden overschreven door de 'formuleid'. De ID's die in de expressie worden gebruikt, moeten exact overeenkomen met de ID's die zijn gedefinieerd in de overschrijffiltervoorwaarden: geen enkele voorwaarde mag ongebruikt blijven of worden weggelaten. Vereist voor aangepaste expressie-overschrijffilters. |
Het LLD-regel override filtervoorwaarde-object definieert een afzonderlijke controle om te presteren op de waarde van een LLD-macro. Het heeft het volgende: eigendommen:
Eigenschap | Type | Beschrijving |
---|---|---|
macro (vereist) |
string | LLD-macro om de controle uit te voeren. |
waarde (verplicht) |
string | Waarde om mee te vergelijken. |
formulaid | string | Willekeurige unieke ID die wordt gebruikt om te verwijzen naar de voorwaarde vanuit een aangepaste expressie. Mag alleen hoofdletters bevatten. De ID moet door de gebruiker worden gedefinieerd bij het wijzigen van filtervoorwaarden, maar wordt opnieuw gegenereerd wanneer ze daarna worden aangevraagd. |
operator | geheel getal | Condition-operator. Mogelijke waarden: 8 - (standaard) komt overeen met reguliere expressie; 9 - komt niet overeen met reguliere expressie; 12 - bestaat;< br>13 - bestaat niet. |
De bewerking voor het negeren van de LLD-regel is een combinatie van voorwaarden en acties uitvoeren op het prototype-object. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
operationobject (vereist) |
integer | Type gevonden object om de actie uit te voeren. Mogelijke waarden: 0 - Itemprototype; 1 - Prototype triggeren;< br>2 - Graph-prototype; 3 - Host-prototype. |
operator | geheel getal | Override condition operator. Mogelijke waarden: 0 - (standaard) is gelijk aan; 1 - is niet gelijk aan; 2 - bevat; 3 - bevat niet; 8 - komt overeen; 9 - komt niet overeen. |
value | string | Patroon dat overeenkomt met de naam van item, trigger, grafiek of hostprototype, afhankelijk van het geselecteerde object. |
opstatus | object | Bewerkingsstatusobject overschrijven voor item-, trigger- en hostprototypeobjecten. |
opdiscover | object | Bewerking opheffen statusobject detecteren (alle objecttypen). |
opperiod | object | Bewerkingsperiode (update-interval) object overschrijven voor item prototype object. |
ohistory | object | Overschrijf bewerkingsgeschiedenisobject voor item prototype object. |
optrends | object | Bewerkingstrends-object voor item prototype-object overschrijven. |
opseverity | object | Severity-object van bewerking overschrijven voor trigger-prototypeobject. |
optag | array | Bewerkingstag-object overschrijven voor trigger- en hostprototype-objecten. |
optemplate | array | Overschrijf het bewerkingssjabloonobject voor het hostprototypeobject. |
opinventory | object | Overschrijven bewerkingsvoorraadobject voor hostprototypeobject. |
LLD-regel overschrijft de bewerkingsstatus die is ingesteld op gedetecteerd object. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
status (vereist) |
geheel getal | Overschrijf de status voor het geselecteerde object. Mogelijke waarden: 0 - Maken ingeschakeld; 1 - Maken uitgeschakeld. |
LLD-regel overschrijven bewerking detectiestatus die is ingesteld op ontdekt object. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
discover (vereist) |
geheel getal | Overschrijf de ontdekkingsstatus voor het geselecteerde object. Mogelijke waarden: 0 - Ja, ga door met het ontdekken van de objecten; 1 - Nee , worden nieuwe objecten niet ontdekt en worden bestaande als verloren gemarkeerd. |
De operatieperiode voor het negeren van de LLD-regel is een update-intervalwaarde (ondersteunt aangepaste intervallen) die is ingesteld op gevonden item. Het heeft het volgende: eigendommen:
Eigenschap | Type | Beschrijving |
---|---|---|
vertraging (vereist) |
string | Overschrijf het update-interval van het prototype van het item. Accepteert seconden of een tijdseenheid met achtervoegsel (30s,1m,2h,1d), evenals flexibele en planningsintervallen en gebruikersmacro's of LLD-macro's. Meerdere intervallen worden gescheiden door een puntkomma. |
LLD-regel overschrijft de waarde van de bewerkingsgeschiedenis die is ingesteld op ontdekt item. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
geschiedenis (verplicht) |
string | Overschrijf de geschiedenis van het prototype van het item, wat een tijdseenheid is van hoe lang de geschiedenisgegevens moeten worden opgeslagen. Accepteert ook gebruikersmacro's en LLD-macro's. |
LLD-regel overschrijft de waarde van bewerkingstrends die is ingesteld op gedetecteerd item. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
trends (verplicht) |
string | Overschrijf de trends van het prototype van het item, wat een tijdseenheid is van hoe lang de trendgegevens moeten worden opgeslagen. Accepteert ook gebruikersmacro's en LLD-macro's. |
LLD-regel overschrijft de ernstwaarde van de bewerking die is ingesteld op ontdekt trekker. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
severity (vereist) |
integer | De ernst van het trigger-prototype overschrijven. Mogelijke waarden zijn: 0 - (standaard) niet geclassificeerd; 1 - informatie;< br>2 - waarschuwing; 3 - gemiddeld; 4 - hoog; 5 - ramp. |
LLD regel overschrijven operatie tag object bevat tag naam en waarde die zijn ingesteld op ontdekt object. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
tag (verplicht) |
string | Nieuwe tagnaam. |
value | string | Nieuwe tagwaarde. |
LLD-regel overschrijft bewerkingssjabloonobject dat is gekoppeld aan ontdekte host. Het heeft de volgende eigenschappen:
Eigenschap | Type | Beschrijving |
---|---|---|
templateid (vereist) |
string | Overschrijf de sjabloon van aan de host-prototype gekoppelde sjablonen. |
LLD-regel overschrijft de waarde van de bewerkings inventory die is ingesteld op gastheer ontdekt. Het heeft de volgende eigenschappen:
Property | Type | Beschrijving |
---|---|---|
inventory_mode (vereist) |
integer | Overschrijf de inventarismodus van het hostprototype. Mogelijke waarden zijn: -1 - uitgeschakeld; 0 - (standaard ) handmatig; 1 - automatisch. |