Objecte de regla LLD

Els següents objectes són relacionats amb l'API discoveryrule.

Regla LLD

L'objecte de regla de descobriment de baix nivell té les propietats següents.

Propietat Tipus Descripció
itemid cadena (només de lectura) ID de regla LLD.
delay
(obligatori)		 cadena Interval d'actualització de regles LLD. Accepta segons o unitat de temps amb sufix i amb o sense un o més intervals personalitzats que consisteixen en intervals flexibles i intervals de programació com a cadenes serialitzades. També accepta macros d'usuari. Els intervals flexibles es poden escriure com dues macros separades per una barra inclinada. Els intervals són separats per un punt i coma.

Opcional per a Zabbix trapper, elements dependents i per a l'agent Zabbix (actiu) amb la clau mqtt.get.
hostid
(obligatori)		 cadena ID de l'equip al que pertany la regla LLD.
interfaceid
(obligatori)		 cadena ID de la interfície de l'equip de la regla LLD. S'empra només per a les regles de LLD de l'equip.

No es calen per a les regles de LLD de l'agent Zabbix (actiu), Zabbix intern, trapper de Zabbix, dependent, monitor de base de dades i scripts. Opcional per a les regles LLD de l'agent HTTP.
clau_
(obligatori)		 cadena clau de regla LLD.
nom
(obligatori)		 cadena Nom de la regla LLD.
tipus
(obligatori)		 enter Tipus de regla LLD..

Valors possibles:
0 - Agent Zabbix;
2 - Trapper Zabbix;
3 - comprovació simple;
5 - Zabbix intern;
7 - Agent Zabbix (actiu);
10 - comprovació externa;
11 - Monitor de base de dades;
12 - Agent IPMI ;
13 - Agent SSH;
14 - Agent TELNET;
16 - Agent JMX;
18 - Element dependent;< br>19 - Agent HTTP;
20 - Agent SNMP;< br>21 - Guió.
url
(obligatori)		 cadena cadena d'URL, necessària per a la regla LLD de l'agent HTTP. Admet macros d'usuari, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.
allow_traps enteger Camp de regla LLD de l'agent HTTP. També permet l'ampliació de valors com en el tipus d'element trapper.

0 - (per defecte) No permet acceptar dades entrants.
1 - Permet acceptar dades entrants.
authtype enteger Només l'empren l'agent SSH o les regles LLD de l'agent HTTP.

Valors possibles per al mètode d'autenticació de l'agent SSH:
0 - passa mot de pas (per defecte);
1 - clau pública.

Valors possibles del mètode d'autenticació de l'agent HTTP:
0 - (per defecte) cap<br >1 - bàsic
2 - NTLM
descripció cadena Descripció de la regla LLD.
error cadena (només de lectura) Text d'error si hi ha problemes per actualitzar el valor de la regla LLD.
follow_redirects enteger Camp de regla LLD de l'agent HTTP. Seguiu les redireccions de resposta en afegir dades.

0: No seguiu les redireccions.
1: (per defecte) Seguiu les redireccions.
capçaleres objecte Camp de política LLD de l'agent HTTP. Objecte amb capçaleres de sol·licitud HTTP(S), on el nom de la capçalera s'empra com a clau i el valor de la capçalera com a valor.

Exemple:
{ " User-Agent": "Zabbix" }
http_proxy string Camp de regla LLD de l'agent HTTP. Cadena de connexió del proxy HTTP(S).
ipmi_sensor string sensor IPMI. S'empra només per les regles IPMI LLD.
jmx_endpoint cadena Cadena de connexió de l'agent JMX personalitzada.

Per defecte:
service:jmx:rmi:///jndi/rmi://{HOST.CONN} :{HOST.PORT} /jmxrmi
lifetime string Període després del qual s'eliminaran els elements que ja no es descobreixen. Accepta segons, unitat de temps amb sufix i macro d'usuari.

Per defecte: 30d.
master_itemid enteger Identificador de l'element principal.
Es permet la recursivitat fins a 3 elements dependents i un nombre màxim d'elements dependents igual a 999.
La regla de descobriment no pot ser l'element principal d'una altra regla de descobriment.<br >
Obligatori per a l'element dependent.
output_format enteger Camp de regla LLD de l'agent HTTP. la resposta s'ha de convertir a JSON.

0 - (per defecte) Emmagatzema en brut.
1 - Converteix a JSON.
params string Paràmetres addicionals en funció del tipus de regla LLD:
- script executat per a regles LLD SSH i Telnet;
- Consulta SQL per a regles de supervisió de bases de dades LLD;
- fórmula per a regles LLD calculades.
parameters array Paràmetres addicionals per a la regla LLD semblant a un script. Matriu d'objectes amb propietats "nom" i "valor", on el nom ha de ser únic.
password cadena Mot de pas per a l'autenticació. S'empra per a Simple Check, SSH, Telnet, Database Monitor, JMX LLD Rules i HTTP Agent.
post_type enteger Camp de regla LLD de l'agent HTTP. Tipus de cos de dades de publicació emmagatzemat a la propietat de publicacions.

0 - (per defecte) Dades en brut.
2 - Dades JSON.
3 - Dades XML.
posts cadena Camp de política LLD de l'agent HTTP. HTTP(S) sol·licita dades del cos. S'empra amb post_type.
privatekey string Nom del fitxer de clau privada.
publickey string Nom del fitxer de clau pública.
query_fields array Camp de regla LLD de l'agent HTTP. Paràmetres de consulta. Matriu d'objectes amb parells 'clau':'valor', on el valor pot ser una cadena buida.
request_method enteger Camp de regla LLD de l'agent HTTP. Tipus de mètode de sol·licitud.

0 - (per defecte) GET
1 - POST
2 - PUT
3 - HEAD
retrieve_mode enteger Camp de regla LLD de l'agent HTTP. Quina part de la resposta s'ha d'emmagatzemar.

0 - (per defecte) Cos.
1 - Capçaleres.
2 - S'emmagatzemaran el cos i les capçaleres.< br>
Per request_method HEAD només es permet el valor 1.
snmp_oid cadena SNMP OID.
ssl_cert_file string camp de política LLD de l'agent HTTP. Camí al fitxer de clau SSL pública.
ssl_key_file string camp de política LLD de l'agent HTTP. Camí al fitxer de clau SSL privada.
ssl_key_password string camp de política LLD de l'agent HTTP. Contrasenya per al fitxer de clau SSL.
state entier (només de lectura) Estat de la regla LLD.

Valors possibles:
0 - (per defecte) normal;
1 - no compatible.
state entier Estat de la regla LLD.

Valors possibles:
0 - (per defecte) Regla LLD activada;
1 - Regla LLD desactivada.
state_codis cadena Camp de regla LLD de l'agent HTTP. Intervals de codis d'estat HTTP obligatoris separats per comes. També admet macros d'usuari com a part d'una llista separada per comes.

Exemple: 200.200-{$M},{$M},200-400
templateid string (només de lectura) ID de regla LLD de la plantilla principal.
timeout string Temps d'espera de la sol·licitud de consulta de dades d'element. S'empra per a l'agent HTTP i les regles d'script LLD. Admet macros d'usuari.

valor per defecte: 3s
valor màxim: 60s
trapper_hosts string Equips permesos. Emprat per les regles Trapper LLD o les regles LLD de l'agent HTTP.
username cadena Nom d'usuari per a l'autenticació. S'empra per les regles LLD de Simple Check, SSH, Telnet, Database Monitor, JMX i HTTP Agent LLD.

Requerit per les regles SSH i Telnet LLD.
uuid string Identificador únic universal, emprat per enllaçar les regles LLD importades amb les existents. S'empra només per a regles LLD en models. Es genera automàticament, si no es proporciona.

Per a les operacions d'actualització, aquest camp és només de lectura.
verify_host enteger Camp de regla LLD de l'agent HTTP. Valida que el nom d'equip a l'URL es troba al camp Nom comú o al camp Nom alternatiu de l'assumpte del certificat d'equip.

0 - (per defecte) No validar.
1 - Validar.
verify_peer enteger Camp de regla LLD de l'agent HTTP. Vàlid si el certificat d'equip és autèntic.

0 - (per defecte) No validar.
1 - Validar.

Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.

Filtre de regla LLD

L'objecte de filtre de regles LLD defineix un conjunt de condicions que es poden emprar per filtrar objectes descoberts. Té les següents propietats:

Propietat Tipus Descripció
conditions
(obligatori)		 matriu Conjunt de condicions de filtre que s'empren per filtrar els resultats.
evaltype
(obligatori)		 integer Mètode d'avaluació de la condició del filtre.

Valors possibles:
0 - i/o;
1 - i;
2 - o ;
3 - expressió personalitzada.
eval_formula string (només de lectura) Expressió generada que s'emprarà per avaluar les condicions del filtre. L'expressió conté identificadors que fan referència a condicions de filtre específiques per la seva "fórmula". El valor de eval_formula és igual al valor de formula per als filtres amb una expressió personalitzada.
formula cadena Expressió definida per l'usuari per avaluar les condicions del filtre amb una expressió personalitzada. L'expressió ha de contindre identificadors que facin referència a condicions de filtre específiques mitjançant la seva "fórmula". Els identificadors emprats a l'expressió han de coincidir exactament amb els definits a les condicions del filtre: no es pot pas deixar ni ometre cap condició.

Necessari per als filtres d'expressió personalitzats.

Condició de filtre de regla LLD

Aquest objecte defineix una comprovació separada per dur a terme el valor d'una macro LLD. Té les següents propietats:

Propietat Tipus Descripció
macro
(obligatori)		 cadena Macro LLD per comprovar-ho.
valor
(obligatori)		 cadena Valor a comparar.
formulaid string ID únic arbitrari emprat per fer referència a la condició d'una expressió personalitzada. Només pot contindre lletres majúscules. L'ID l'ha de configurar l'usuari en modificar les condicions del filtre, però es tornarà a generar quan ho demani més endavant.
operator integer Operador de condició.

Valors possibles:
8 - (per defecte) coincideix amb l'expressió regular;
9 - no coincideix amb l'expressió regular;
12 - existeix;< br>13 - no existeix.

::: consell de notes Per entendre millor com emprar filtres amb diferents tipus d'expressions, consulteu els exemples a les pàgines del mètode discoveryrule.get i discoveryrule.create. :::

Ruta de macro LLD

La ruta de la macro LLD té les propietats següents:

Propietat Tipus Descripció
lld_macro
(obligatori)		 string Macro LLD.
path
(obligatori)		 string Selector de valor que serà assignat a la macro corresponent.

Preprocessament de regla LLD

L'objecte de preprocessament de regles LLD té les propietats següents.

Propietat Tipus Descripció
tipus
(obligatori)		 enter El tipus d'opció de preprocessament.

Valors possibles:
5 - Coincidència d'expressió regular;
11 - XML ​​​​​​XPath ;
12 - JSONPath;
15 - No coincideix amb l'expressió regular;< br>16 - Comprovar si hi ha errors JSON;
17 - Comprovar si hi ha errors XML;
20 - Descartar sense canvis amb el heartbeat;
23 - Prometheus a JSON;
24 - CSV a JSON;< br>25 - Substituïu;
27 - XML ​​​​a JSON.
params
(obligatori)		 string Paràmetres addicionals emprats per l'opció de preprocessament. Múltiples paràmetres separats per caràcter LF (\n).
error_handler
(obligatori)		 entier Tipus d'acció que s'empra si el pas de preprocessament falla.

Valors possibles:
0 - El servidor Zabbix ha establert el missatge d'error del missatge. ;
1 - Elimina el valor;
2 - Estableix un valor personalitzat;< br>3 - Estableix un missatge d'error personalitzat.
error_handler_params
(obligatori)		 string Paràmetres del gestor d'errors. S'empra amb error_handler.

Ha d'ésser buit, si error_handler és 0 o 1.
Pot ésser buit si error_handler és 2.
No pot ésser buit, si error_handler és 3.

Els següents paràmetres i gestors d'errors són compatibles per a cada tipus de preprocessament.

Tipus de preprocessament Nom Paràmetre 1 Paràmetre 2 Paràmetre 3 Gestors d'errors admesos
5 Expressió regular patró1 sortida2 0, 1, 2, 3
11 XML XPath camí3 0, 1, 2, 3
12 JSONPath camí3 0, 1, 2, 3
15 No coincideix amb l'expressió regular patró1 0, 1, 2, 3
16 Cerca un error en JSON camí3 0, 1, 2, 3
17 Cerca un error a XML camí3 0, 1, 2, 3
20 Descartar sense canvis amb el batec del cor segons4, 5
21 JavaScript script2
23 Prometeu a JSON patró5, 6 0, 1, 2, 3
24 CSV a JSON caràcter2 caràcter2 0,1 0, 1, 2, 3
25 Substitueix cadena de cerca2 substitueix2
27 XML a JSON 0, 1, 2, 3

1 expressió regular
2 cadena
3 JSONPath o XML XPath
4 nombre enter positiu (amb suport per a sufixos de temps, per exemple, 30s, 1m, 2h, 1d)
5 macro d'usuari
6 Patró de Prometheus seguint la sintaxi: <nom mètric>{<nom de l'etiqueta>="<valor de l'etiqueta>", ...} == <valor>. Cada component del patró de Prometheus (mètrica, nom d'etiqueta, valor d'etiqueta i valor de mètrica) pot ser una macro d'usuari.
:::

Sobrecàrrega de regles LLD

L'objecte de sobrecàrrega de regles LLD defineix un conjunt de regles (filtres, condicions i operacions) que s'empren per anul·lar les propietats de diversos objectes prototip. Té les següents propietats:

Propietat Tipus Descripció
nom
(obligatori)		 cadena Nom únic de sobrecàrrega.
pas
(obligatori)		 nombre enter Nombre de seqüència únic de la sobrecàrrega.
stop enter Atura el processament de les sobrecàrregues futures si coincideix.

Valors possibles:
0 - (per defecte) no atura el processament de les sobrecàrregues;
1: atura el processament de les sobrecàrregues del procés si el filtre coincideix .
filtre objecte Filtre de sobrecàrrega.
operacions matriu Operacions de sobrecàrrega.

:::

Filtre de sobrecàrrega de la regla LLD

L'objecte defineix un conjunt de condicions que, si coincideixen amb l'objecte descobert, s'aplica la sobrecàrrega. Té les següents propietats:

Propietat Tipus Descripció
evaltype
(obligatori)		 integer Substitueix el mètode d'avaluació de la condició de filtre.

Valors possibles:
0 - i/o;
1 - i ;< br>2 - o ;
3 - expressió personalitzada.
conditions
(obligatori)		 matriu Conjunt de condicions de filtre de sobrecàrrega que s'empren per fer coincidir els objectes descoberts.
eval_formula string (només de lectura) Expressió generada que s'emprarà per avaluar les condicions del filtre de sobrecàrrega. L'expressió conté identificadors que fan referència a condicions específiques de filtre de sobrecàrrega mitjançant la seva "fórmula". El valor de eval_formula és igual al valor de formula per als filtres amb una expressió personalitzada.
formula cadena Expressió definida per l'usuari per avaluar les condicions del filtre de sobrecàrrega amb una expressió personalitzada. L'expressió ha de contindre identificadors que facin referència a condicions específiques del filtre de sobrecàrrega mitjançant la seva "fórmula". Els ID emprats a l'expressió han de coincidir exactament amb els definits a les condicions del filtre de sobrecàrrega: cap condició no es pot deixar sense emprar ni ometre.

Necessari per als filtres de sobrecàrrega d'expressions personalitzats.

:::

Condició del filtre de sobrecàrrega de la regla LLD

L'objecte defineix una comprovació independent per dur a terme el valor d'una macro LLD. Té les següents propietats:

Propietat Tipus Descripció
macro
(obligatori)		 cadena Macro LLD per realitzar la comprovació.
valor
(obligatori)		 cadena Valor a comparar.
formulaid string ID únic arbitrari emprat per fer referència a la condició d'una expressió personalitzada. Només pot contindre lletres majúscules. L'ID l'ha de configurar l'usuari en modificar les condicions del filtre, però es tornarà a generar quan ho sol·liciti més endavant.
operador enter Operador de condició.

Valors possibles:
8 - (per defecte) coincideix amb l'expressió regular;
9 - no coincideix amb l'expressió regular;
12 - existeix;< br>13 - no existeix.

Operació de sobrecàrrega de regles LLD

L'operació és una combinació d'accions i condicions que s'han de realitzar a l'objecte prototip. Té les següents propietats:

Propietat Tipus Descripció
operationobject
(obligatori)		 entier Tipus d'objecte descobert per dur a terme l'acció.

Valors possibles:
0 - Prototip d'element;
1 - Prototip de trigger;< br>2 - Prototip de gràfics;
3 - Prototip d'equip.
operador nter Operador de condició de sobrecàrrega.

Valors possibles:
0 - (per defecte) és igual;
1 - no és igual;
2 - conté;
3 - no conté;
8 - coincideix;
9 - no coincideix.
valor cadena Patró per fer coincidir l'element, el trigger, el gràfic o el nom del prototip d'equip basat en l'objecte triat.
opstatus objecte Objecte d'estat de l'operació de sobrecàrrega per a objectes d'element, trigger i prototip d'equip.
opdiscover objecte Objecte d'estat de l'operació de sobrecàrrega de descobriment (qualsevol tipus d'objecte).
opperiod objecte Objecte de període d'operació de sobrecàrrega (interval d'actualització) per a l'objecte prototip d'element.
ohistory object Objecte de l'històric d'operacions de sobrecàrrega per a l'objecte prototip d'element.
optrends objecte Objecte de tendències d'operació de sobrecàrrega per a l'objecte prototip d'element.
opseverity objecte Objecte de gravetat de l'operació de sobrecàrrega per a l'objecte prototip del trigger.
optag array Objecte d'etiqueta d'operació de sobrecàrrega per a l'objecte prototip de l'equip.
optemplate array Objecte de plantilla d'operació de sobrecàrrega per a l'objecte prototip de l'equip.
opinventory objecte Objecte d'inventari d'operacions de sobrecàrrega per a l'objecte prototip de l'equip.
Estat de l'operació de sobrecàrrega de la regla LLD

Estat de l'operació de sobrecàrrega de la regla LLD que s'estableix com a objecte descobert. Té les següents propietats:

Propietat Tipus Descripció
status
(obligatori)		 integer Anul·la l'estat de l'objecte seleccionat.

Valors possibles:
0 - Creació activada;
1 - Creació desactivada.
Operació de sobrecàrrega de descobriment de regles LLD

Estat de l'operació de sobrecàrrega de descobriment de la regla LLD que s'estableix a l'objecte descobert. Té les següents propietats:

Propietat Tipus Descripció
discover
(obligatori)		 integer Anul·la l'estat de descoberta de l'objecte triat.

Valors possibles:
0 - Sí, continuar descobrint objectes;< br>1 - No , els elements nous no es descobriran i els elements existents es marcaran com a perduts.
Període d'operació de sobrecàrrega de la regla LLD

El període d'operació de sobrecàrrega de la regla LLD és un valor d'interval d'actualització (admet intervals personalitzats) que s'estableix a l'element descobert. Té les següents propietats:

Propietat Tipus Descripció
retard
(obligatori)		 cadena Anul·la l'interval d'actualització del prototip d'element. Accepta segons o una unitat de temps amb sufix (30s,1m,2h,1d), així com intervals flexibles i de programació i macros d'usuari o LLD. Els intervals múltiples són separats per un punt i coma.
Operació de sobrecàrrega de l'historial de regles LLD

Operació de sobrecàrrega de l'historial de regles LLD establerta a l'element descobert. Té les següents propietats:

Propietat Tipus Descripció
history
(obligatori)		 cadena Substitueix l'històtic del prototip d'element, que és una unitat de temps de quant de temps s'han d'emmagatzemar les dades de l'històric. També accepta macro d'usuari i macro LLD.
Operació de sobrecàrrega de tendència de la regla LLD

Operació establerta a l'element descobert. Té les següents propietats:

Propietat Tipus Descripció
trends
(obligatori)		 cadena Substitueix les tendències del prototip d'element, que és una unitat de temps de quant de temps s'han d'emmagatzemar les dades de tendència. També admet macro d'usuari i macro LLD.
Operació de sobrecàrrega de gravetat de la regla LLD

L'operació s'ha establert al trigger descobert. Té les següents propietats:

Propietat Tipus Descripció
severity
(obligatori)		 integer Anul·la la gravetat del prototip de trigger.

Els valors possibles són: 0 - (per defecte) sense classificar;
1 - informació ;
2 - avís;
3 - mitjana;
4 - alta;
5 - desastre.
Operació de sobrecàrrega d'etiquetes de regla LLD

L'operació conté el nom i el valor de l'etiqueta definit a l'objecte descobert. Té les següents propietats:

Propietat Tipus Descripció
tag
(obligatori)		 string Nom d'etiqueta nou.
value string Valor d'etiqueta nou.
Operació de sobrecàrrega del model de regles LLD

Objecte d'operació de sobrecàrrega del model vinculat a l'equip descobert. Té les següents propietats:

Propietat Tipus Descripció
templateid
(obligatori)		 string Substitueix la plantilla de les plantilles vinculades al prototip de l'equip.
LLD Rule Operació de sobrecàrrega d'inventari

Operació per anul·lar el valor del mode d'inventari de la regla LLD que s'estableix a l'equip descobert. Té les següents propietats:

Propietat Tipus Descripció
inventory_mode
(obligatori)		 integer Ignora el mode d'inventari del prototip de l'equip.

Els valors possibles són:
-1 - desactivat;< br>0 - ( per defecte) manual;
1 - automàtic.