De volgende objecten zijn direct gerelateerd aan de discoveryrule
API.
The low-level discovery rule object has the following properties.
Property | Type | Description |
---|---|---|
itemid | string | (readonly) ID of the LLD rule. |
delay (required) |
string | Update interval of the LLD rule. Accepts seconds or time unit with suffix and with or without one or more custom intervals that consist of either flexible intervals and scheduling intervals as serialized strings. Also accepts user macros. Flexible intervals could be written as two macros separated by a forward slash. Intervals are separated by a semicolon. Optional for Zabbix trapper, dependent items and for Zabbix agent (active) with mqtt.get key. |
hostid (required) |
string | ID of the host that the LLD rule belongs to. |
interfaceid (required) |
string | ID of the LLD rule's host interface. Used only for host LLD rules. Optional for Zabbix agent (active), Zabbix internal, Zabbix trapper and database monitor LLD rules. |
key_ (required) |
string | LLD rule key. |
name (required) |
string | Name of the LLD rule. |
type (required) |
integer | Type of the LLD rule. 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; 16 - JMX agent; 18 - Dependent item; 19 - HTTP agent; 20 - SNMP agent; 21 - Script. |
url (required) |
string | URL string, required for HTTP agent LLD rule. Supports user macros, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. |
allow_traps | integer | HTTP agent LLD rule field. Allow to populate value as in trapper item type also. 0 - (default) Do not allow to accept incoming data. 1 - Allow to accept incoming data. |
authtype | integer | Used only by SSH agent or HTTP agent LLD rules. SSH agent authentication method possible values: 0 - (default) password; 1 - public key. HTTP agent authentication method possible values: 0 - (default) none 1 - basic 2 - NTLM |
description | string | Description of the LLD rule. |
error | string | (readonly) Error text if there are problems updating the LLD rule. |
follow_redirects | integer | HTTP agent LLD rule field. Follow response redirects while pooling data. 0 - Do not follow redirects. 1 - (default) Follow redirects. |
headers | object | HTTP agent LLD rule field. Object with HTTP(S) request headers, where header name is used as key and header value as value. Example: { "User-Agent": "Zabbix" } |
http_proxy | string | HTTP agent LLD rule field. HTTP(S) proxy connection string. |
ipmi_sensor | string | IPMI sensor. Used only by IPMI LLD rules. |
jmx_endpoint | string | JMX agent custom connection string. Default value: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi |
lifetime | string | Time period after which items that are no longer discovered will be deleted. Accepts seconds, time unit with suffix and user macro. Default: 30d . |
master_itemid | integer | Master item ID. Recursion up to 3 dependent items and maximum count of dependent items equal to 999 are allowed. Discovery rule cannot be master item for another discovery rule. Required for Dependent item. |
output_format | integer | HTTP agent LLD rule field. Should response be converted to JSON. 0 - (default) Store raw. 1 - Convert to JSON. |
params | string | Additional parameters depending on the type of the LLD rule: - executed script for SSH and Telnet LLD rules; - SQL query for database monitor LLD rules; - formula for calculated LLD rules. |
parameters | array | Additional parameters for script type LLD rule. Array of objects with 'name' and 'value' properties, where name must be unique. |
password | string | Password for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent LLD rules. |
post_type | integer | HTTP agent LLD rule field. Type of post data body stored in posts property. 0 - (default) Raw data. 2 - JSON data. 3 - XML data. |
posts | string | HTTP agent LLD rule field. HTTP(S) request body data. Used with post_type. |
privatekey | string | Name of the private key file. |
publickey | string | Name of the public key file. |
query_fields | array | HTTP agent LLD rule field. Query parameters. Array of objects with 'key':'value' pairs, where value can be empty string. |
request_method | integer | HTTP agent LLD rule field. Type of request method. 0 - (default) GET 1 - POST 2 - PUT 3 - HEAD |
retrieve_mode | integer | HTTP agent LLD rule field. What part of response should be stored. 0 - (default) Body. 1 - Headers. 2 - Both body and headers will be stored. For request_method HEAD only 1 is allowed value. |
snmp_oid | string | SNMP OID. |
ssl_cert_file | string | HTTP agent LLD rule field. Public SSL Key file path. |
ssl_key_file | string | HTTP agent LLD rule field. Private SSL Key file path. |
ssl_key_password | string | HTTP agent LLD rule field. Password for SSL Key file. |
state | integer | (readonly) State of the LLD rule. Possible values: 0 - (default) normal; 1 - not supported. |
status | integer | Status of the LLD rule. Possible values: 0 - (default) enabled LLD rule; 1 - disabled LLD rule. |
status_codes | string | HTTP agent LLD rule field. Ranges of required HTTP status codes separated by commas. Also supports user macros as part of comma separated list. Example: 200,200-{$M},{$M},200-400 |
templateid | string | (readonly) ID of the parent template LLD rule. |
timeout | string | Item data polling request timeout. Used for HTTP agent and script LLD rules. Supports user macros. default: 3s maximum value: 60s |
trapper_hosts | string | Allowed hosts. Used by trapper LLD rules or HTTP agent LLD rules. |
username | string | Username for authentication. Used by simple check, SSH, Telnet, database monitor, JMX and HTTP agent LLD rules. Required by SSH and Telnet LLD rules. |
uuid | string | Universal unique identifier, used for linking imported LLD rules to already existing ones. Used only for LLD rules on templates. Auto-generated, if not given. For update operations this field is readonly. |
verify_host | integer | HTTP agent LLD rule field. Validate host name in URL is in Common Name field or a Subject Alternate Name field of host certificate. 0 - (default) Do not validate. 1 - Validate. |
verify_peer | integer | HTTP agent LLD rule field. Validate is host certificate authentic. 0 - (default) Do not validate. 1 - Validate. |
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 voorverwerking van de LLD-regel heeft de volgende eigenschappen.
Property | Type | Beschrijving |
---|---|---|
type (vereist) |
geheel getal | Het type voorbewerkingsoptie. Mogelijke waarden: 5 - Overeenstemming met reguliere expressies; 11 - XML XPath; 12 - JSONPath; 15 - Komt niet overeen met reguliere expressie; 16 - Controleer op fouten in JSON; 17 - Controleer op fouten in XML; 20 - Verwijder ongewijzigd met hartslag; 23 - Prometheus naar JSON; 24 - CSV naar JSON; 25 - Vervang; 27 - XML naar JSON. |
params (verplicht) |
string | Aanvullende parameters gebruikt door voorbewerkingsoptie. Meerdere parameters worden gescheiden door een LF-teken (\n). |
error_handler (vereist) |
integer | Actietype gebruikt in geval van mislukte voorverwerkingsstap. Mogelijke waarden: 0 - Foutbericht is ingesteld door Zabbix-server;< br>1 - Waarde negeren; 2 - Aangepaste waarde instellen; 3 - Aangepaste foutmelding instellen. |
error_handler_params (vereist) |
string | Fouthandler parameters. Gebruikt met error_handler .Moet leeg zijn als error_handler 0 of 1 is.Kan leeg zijn als error_handler 2 is.Kan niet leeg zijn als error_handler is 3. |
De volgende parameters en fout afhandelaars worden voor elk ondersteund: soort voorbewerking.
|Preprocessing type|Naam|Parameter 1|Parameter 2|Parameter 3|Ondersteunde fout-handlers| |------------------|----|-----------|-----------|- ----------|------------------------| |5|Reguliere uitdrukking|patroon1|output2|<|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|Controleer op fouten in JSON|pad3|<|<|0, 1, 2, 3| |17|Controleer op fouten in XML|pad3|<|<|0, 1, 2, 3| |20|Gooi ongewijzigd weg met hartslag|seconden4, 5, 6|<|<|<| |23|Prometheus naar JSON|patroon5, 7|<|<|0, 1, 2, 3| |24|CSV naar JSON|karakter2|karakter2|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 tijdsuffixen, bijv. 30s, 1m, 2h, 1d)
5 gebruikersmacro
6 LLD-macro
7 Prometheus-patroon volgens de syntaxis: <metrische naam>{<labelnaam>="<labelwaarde>", ...} == <waarde>
. Elk Prometheus-patrooncomponent (metrisch, labelnaam, labelwaarde en metriek waarde) kan een gebruikersmacro zijn.
8 Prometheus-uitvoer volgens de syntaxis: <labelnaam>
.
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. |