Documentation
Table of Contents
> Element objecte
Els següents objectes tenen relació directa amb l'API item.
Element
Els elements web no es poden crear, actualitzar o esborrar directament mitjançant l'API de Zabbix.
L'objecte element té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| itemid | string | ID de l'element. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| delay | string | Interval d'actualització de l'element. Accepta segons o una unitat de temps amb sufix (30s, 1m, 2h, 1d). Opcionalment, un o més intervals personalitzats es poden especificar com a intervals flexibles o com una programació. Múltiples intervals estan separats per un punt i coma. Es poden emprar macros d'usuari. Una sola macro hauria d'omplir tot el camp. No s'admeten pas diverses macros en un camp o macros barrejades amb text. Els intervals flexibles es poden escriure com dues macros separades per una barra inclinada (p. ex., {$FLEX_INTERVAL}/ {$FLEX_PERIOD}).Comportament de la propietat: - obligatori si type s'ha establert a "Agent Zabbix" (0), "Verificacions simples" (3), "Intern Zabbix" (5), "Verificacions externes" (10), "Monitoratge de base de dades" (11), "Agent IPMI" (12), "Agent SSH" (13), "Agent TELNET" (14), "Calculat" (15), "Agent JMX (16), "Agent HTTP" (19), "Agent SNMP" (20), "Script" (21), o si type s'ha establert a "Agent actiu de Zabbix" (7) i key_ no conté pas "mqtt.get" |
| hostid | string | ID de l'equip o del model al qual pertany l'element. Comportament de la propietat: - constant - obligatori per operacions de creació. |
| interfaceid | string | Id de la interfície d'equip de l'element. Comportament de la propietat: - obligatori si l'element pertany a l'equip i type és "Agent Zabbix", "Agent IPMI", "Agent JMX", "Traça SNMP", o "Agent SNMP"- admès si l'element pertant a l'equip i type és "Validació simple", "Validació externa", "Agent SSH", "Agent TELNET", o "Agent HTTP"- només lectura per objectes descoberts |
| key_ | string | Clau d'element. Comportament de la propietat: - només lectura - obligatori per operacions de creació - només lectura per objectes heretats o descoberts |
| name | string | Nom de l'element. Comportament de la propietat: - només lectura - obligatori per operacions de creació - només lectura per objectes heretats o descoberts |
| type | integer | Tipus d'element Valors possibles: 0 - Agent Zabbix; 2 - Trapper Zabbix; 3 - Verificació simple; 5 - Zabbix intern; 7 - Agent Zabbix (actiu); 9 - Element web; 10 - Verificació externa; 11 - Monitor de base de dades;< 12 - Agent IPMI;< br>13 - Agent SSH; 14 - Agent Telnet; 15 - Calculat; 16 - Agent JMX; 17 - Trampa SNMP; 18 - Element dependent; 19 - Agent HTTP; 20 - Agent SNMP; 21 - Script. Comportament de la propietat: - obligatori si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| url | string | cadena d'URL, necessària només per al tipus d'element d'agent HTTP. Admet macros d'usuari, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. Comportament de la propietat: - obligatori per operacions de creació - només lectura per objectes heretats o descoberts |
| value_type | integer | Tipus d'informació de l'element. Valors possibles: 0 - nombre flotant; 1 - caràcter; 2 - diari; 3 - digital sense signe; 4 - text. Comportament de la propietat: - només lectura - obligatori per operacions de creació - només lectura per objectes heretats o descoberts |
| allow_traps | integer | camp d'element 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. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes descoberts |
| authtype | integer | Només l'empren els elements de l'agent SSH o els elements de l'agent HTTP. Valors possibles per al mètode d'autenticació de l'agent SSH: 0 - mot de pas (per defecte); 1 - clau pública. Valors possibles del mètode d'autenticació de l'agent HTTP: 0 - (per defecte) cap 1 - Bàsic 2 - NTLM 3 - Kerberos Comportament de la propietat: - admès si type és "Agent SSH" o "Agent HTTP"- només lectura per objectes heretats (si type és "Agent HTTP") o objectes descoberts |
| description | string | Descripció de l'element. Comportament de la propietat: - només lectura per objectes descoberts |
| error | string | Text d'error si hi ha problemes per actualitzar el valor de l'element. Comportament de la propietat: - només lectura |
| flags | integer | Origen de l'objecte. Valors possibles: 0 - Objecte normal; 4 - Objecte descobert. Comportament de la propietat: - només lectura |
| follow_redirects | integer | Camp d'element de l'agent HTTP. Seguiu les redireccions de respostes mentre afegiu dades. 0 - No seguiu les redireccions. 1 - (per defecte) Seguiu les redireccions. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| headers | object | Camp d'element de l'agent HTTP. Objecte amb capçaleres de petició 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" } Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| history | string | Unitat de temps que indica quant de temps s'han d'emmagatzemar les dades de l'històric. També accepta macros d'usuari. Per defecte: 90d. Comportament de la propietat: - només lectura per objectes descoberts |
| http_proxy | string | camp d'element de l'agent HTTP. Cadena de connexió del proxy HTTP(S). Comportament de la propietat: - admès si type és "Agent SSH" - només lectura per objectes heretats o descoberts |
| inventory_link | integer | ID del camp d'inventari de l'equip emplenat per l'element. Consulteu la pàgina d'inventari d'equip per obtindre una llista de camps d'inventari d'equip admesos i els seus identificadors. Per defecte: 0. Comportament de la propietat: - admès si value_type és "numèric flotant", "caràcter", "numèric sense signe" o "text"- només lectura per objectes descoberts |
| ipmi_sensor | string | sensor IPMI. Emprat només per elements IPMI. Comportament de la propietat: - obligatori si type és "Agent IPMI" i key_ no és "ipmi.get"- admès si type és "Agent IPMI"- només lectura per objectes heretats o descoberts |
| jmx_endpoint | string | Cadena de connexió de l'agent JMX personalitzada. Per defecte: service:jmx:rmi:///jndi/rmi://{HOST.CONN} :{HOST.PORT} /jmxrmi Comportament de la propietat: - admès si type és "Agent JMX"- només lectura per objectes descoberts |
| lastclock | timestamp | Hora en què l'element es va actualitzar per darrer cop. Per defecte, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. Comportament de la propietat: - només lectura |
| lastns | integer | (només lectura) Nanosegons de la darrera actualització de l'element. De manera predeterminada, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. Comportament de la propietat: - només lectura |
| lastvalue | string | (només lectura) Darrer valor de l'element. Per defecte, només es mostren els valors de les darreres 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. Comportament de la propietat: - només lectura |
| logtimefmt | string | Format d'hora a les entrades de registre. Comportament de la propietat: - admès si value_type és "log"- només lectura per objectes heretats o descoberts |
| master_itemid | integer | Identificador d'element principal. Es permet la recurrència de fins a 3 elements dependents i el nombre màxim d'elements dependents de 29.999. Comportament de la propietat: - obligatori si type és "Element dependent"- només lectura per objectes heretats o descoberts |
| output_format | integer | Camp d'element de l'agent HTTP. En cas de convertir la resposta a JSON. 0 - (per defecte) Emmagatzema en brut. 1 - Converteix a JSON. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| params | string | Paràmetres addicionals en funció del tipus d'element: - script executat per a elements SSH i Telnet; - consulta SQL per a elements de supervisió de la base de dades; - fórmula per als elements calculats; - l'script per a un element d'script. Comportament de la propietat: - obligatori si type és "Agent SSH", "Agent TELNET", "Calculat" o "Script"- només lectura per objectes heretats (si type és "Script") o objectes descoberts |
| parameters | array | Paràmetres addicionals per als elements de l'script. Matriu d'objectes amb propietats "nom" i "valor", on el nom ha d'ésser únic. Comportament de la propietat: - admès si type és "Script"- només lectura per objectes heretats o descoberts |
| password | string | Mot de pas per a l'autenticació. S'empra per simple comprovació, SSH, Telnet, monitor de base de dades, elements de l'agent JMX i HTTP. Quan s'empra per JMX, el nom d'usuari també s'ha d'especificar amb mot de pas o ambdues propietats s'han de deixar buides. Comportament de la propietat: - admès si type és "Verificació simple", "Agent SSH", "Agent TELNET", "Monitoratge de base de dades" o "Agent HTTP"- només lectura per objectes heretats (si type és "Agent HTTP") o objectes descoberts |
| post_type | integer | camp d'element 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. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| posts | string | camp d'element de l'agent HTTP. HTTP(S) demana dades del cos. S'empra amb post_type. Comportament de la propietat: - obligatori si type és "Agent HTTP" i post_type és "Dades JSON" o "Dades XML"- admès si type és "Agent HTTP" i post_type és "Dades en brut"- només lectura per objectes heretats o descoberts |
| prevvalue | string | Valor anterior de l'element. Per defecte, només es veuen els valors de les últimes 24 hores. Podeu ampliar aquest període canviant el valor del paràmetre Període màxim de visualització de l'historial a la secció del menú Administració → General. Comportament de la propietat: - només lectura |
| privatekey | string | Nom del fitxer de clau privada. Comportament de la propietat: - obligatori si type és "Agent SSH" i authtype és "clau pública"- només lectura per objectes descoberts |
| publickey | string | Nom del fitxer de clau pública. Comportament de la propietat: - obligatori si type és "Agent SSH" i authtype és "clau pública"- només lectura per objectes descoberts |
| query_camps | array | Camp d'element de l'agent HTTP. Paràmetres de consulta. Matriu d'objectes amb parells 'clau':'valor', on el valor pot ésser una cadena buida. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| request_method | integer | Camp d'element de l'agent HTTP. Tipus de mètode de petició. 0 - (per defecte) GET 1 - POST 2 - PUT 3 - HEAD Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| retrieve_mode | integer | camp d'element 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 only 1 és el valor permès. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| snmp_oid | string | SNMP OID. Comportament de la propietat: - obligatori si type és "Agent SNMP"- només lectura per objectes heretats o descoberts |
| ssl_cert_file | string | Camp d'element de l'agent HTTP. Camí al fitxer de clau SSL pública. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| ssl_key_file | string | Camp d'element de l'agent HTTP. Camí al fitxer de clau SSL privada. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| ssl_key_password | string | Camp d'element de l'agent HTTP. Mot de pas per al fitxer de clau SSL. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| state | integer | Estat de l'element. Valors possibles: 0 - (per defecte) normal; 1 - no compatible. Comportament de la propietat: - només lectura |
| status | integer | Estat de l'element. Valors possibles: 0 - element activat (per defecte); 1 - element desactivat. |
| status_codes | string | camp d'element 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 Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| templateid | string | (només lectura) ID de l'element de la plantilla principal. Consell: Empreu la propietat hostid per especificar la plantilla a la qual pertany l'element.Comportament de la propietat: - només lectura |
| timeout | string | Temps d'espera de la petició de consulta de dades d'element. S'empra per a agents HTTP i elements d'script. Admet macros d'usuari. valor per defecte: 3s valor màxim: 60s Comportament de la propietat: - admès si type és "Agent HTTP" o "Script"- només lectura per objectes heretats o descoberts |
| trapper_hosts | string | Equips permesos. Emprat per elements trapper o elements d'agent HTTP. Comportament de la propietat: - només lectura per objectes descoberta - admès si type és "Agent HTTP" i allow_traps és "Permetre acceptar dades entrants" |
| trends | string | Unitat de temps de quant de temps s'han d'emmagatzemar les dades de tendències. També accepta macros d'usuari. Per defecte: 365d. Comportament de la propietat: - admès si value_type és "numèric flotant" o "numèric sense signe"- només lectura per objectes descoberts |
| units | string | Unitats de valor. Comportament de la propietat: - admès si value_type és "numèric flotant" o "numèric sense signe"- només lectura per objectes heretats o descoberts |
| username | string | Nom d'usuari per a l'autenticació. Comportament de la propietat: - obligatori si type és "Agent SSH", "Agent TELNET", o si type és "Agent JMX" i password s'ha definit- admès si type és "Verificació simple", "Monitoratge de base de dades" o "Agent HTTP"- només lectura per objectes heretats (si type és "Agent HTTP") o descoberts |
| uuid | string | Identificador únic universal, emprat per enllaçar un element importat amb elements ja existents. Es genera automàticament, si no es proporciona. Comportament de la propietat: - admès si l'element pertany a una plantilla |
| valuemapid | string | ID del mapa de valor associat. Comportament de la propietat: - admès si value_type és "numèric flotant", "caràcter" o "numèric sense signe"- només lectura per objectes heretats o descoberts |
| verify_host | integer | camp d'element d'agent HTTP. Valideu que el nom d'equip a l'URL estigui al camp Nom comú o Nom alternatiu del subjecte del certificat d'equip. 0 - (per defecte) No valida. 1 - Valida. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
| verify_peer | integer | camp d'element de l'agent HTTP. Valida si el certificat de l'equip és autèntic. 0 - (per defecte) No valida. 1 - Valida. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats o descoberts |
Etiqueta d'element
L'objecte d'etiqueta d'element té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| tag | string | Nom de l'etiqueta de l'element. Comportament de la propietat: - obligatori |
| value | string | Valor de l'etiqueta de l'element. |
### Preprocessament de l'element
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| type | integer | El tipus d'opció de preprocessament. Valors possibles: 1 - Multiplicador personalitzat; 2 - Retalla a la dreta;< br>3 - Retalla a l'esquerra; 4 - Retalla; 5 - Coincidència d'expressió regular; 6 - Booleà a decimal; 7 - Octal a decimal; 8 - Hexadecimal a decimal; 9 - Canvi únic; 10 - Canvi per segon; 11 - XML XPath; 12 - JSONPath; 13 - Dins l'interval; 14 - Coincideix amb l'expressió regular;< br>15 - No coincideix amb l'expressió regular; 16 - Comprova si hi ha errors en JSON; 17 - Comprova si hi ha errors en XML; 18 - Comprova si hi ha errors mitjançant una expressió regular; 19 - Descartar sense canvis; 20 - Descartar sense canvis amb un heartbeat; 21 - JavaScript; 22 - Patró de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Substituïu; >26 - No s'admet la verificació; 27 - XML a JSON; 28 - Valor SNMP walk; 29 - SNMP walk a JSON. Comportament de la propietat: - obligatori |
| params | string | Paràmetres addicionals emprats per l'opció de preprocessament. Diversos paràmetres són separats pel caràcter LF (\n). |
| error_handler | integer | Tipus d'acció que s'empra quan falla el pas de preprocessament. Valors possibles: 0 - Zabbix defineix el missatge d'error del missatge;< br>1 - Elimina el valor; 2 - Estableix un valor personalitzat; 3 - Estableix un missatge d'error personalitzat. Valors possibles si type és "Validar no suportat":1 - Descartar el valor; 2 - Establir valor personalitzat; 3 - Establir missatge d'error personalitzat. Comportament de la propietat: - obligatori si type és "Multiplicador personalitzat" (1), "Coincidència d'expressió regular" (5), "Booleà a decimal" (6), "Octal a decimal" (7), "Hexadecimal a decimal" (8), "Canvi simple" (9), "Canvi per segon" (10), "XML XPath" (11), "JSONPath" (12), "En rang" (13), "Coincideix amb expressió regular" (14), "No coincideix amb expressió regular" (15), "Verificar errors a JSON" (16), "Verificar errors a XML" (17), "Verificar errors emprant una expressió regular" (18), "Patró Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Verificació no admesa" (26), "XML a JSON" (27), "Valor SNMP walk" (28), or "SNMP walk a JSON" (29) |
| error_handler_params | string | Paràmetres del gestor d'errors. Comportament de la propietat: - obligatori si error_handler és "Establir valor personalitzat" o "Establir missatge d'error personalitzat" |
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| |------------------|----|------------|-----------|-- ---------|---------| |1|Multiplicador personalitzat|nombre1,\6|<|<|0, 1, 2, 3| |2|Retalla a la dreta|llista de caràcters2|<|<|<| |3|Retalla a l'esquerra|llista de caràcters2|<|<|<| |4|Retalla|llista de caràcters2|<|<|<| |5|Expressió regular|patró3|sortida2|<|0, 1, 2, 3| |6|Booleà a decimal|<|<|<|0, 1, 2, 3| |7|Octal a decimal|<|<|<|0, 1, 2, 3| |8|Hexadecimal a decimal|<|<|<|0, 1, 2, 3| |9|Canvi únic|<|<|<|0, 1, 2, 3| |10|Canvi per segon|<|<|<|0, 1, 2, 3| |11|XML XPath|camí4|<|<|0, 1, 2, 3| |12|JSONPath|camí4|<|<|0, 1, 2, 3| |13|Dins de l'interval|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Coincideix amb l'expressió regular|patró3|<|<|0, 1, 2, 3| |15|No coincideix amb l'expressió regular|patró3|<|<|0, 1, 2, 3| |16|Comprova l'error a JSON|camí4|<|<|0, 1, 2, 3| |17|Comprova l'error en XML|camí4|<|<|0, 1, 2, 3| |18|Comprova si hi ha errors emprant l'expressió regular|patró3|sortida2|<|0, 1, 2, 3| |19|Descarta el que no ha canviat|<|<|<|<| |20|Descarta el no canviat amb un heartbeat|segons5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Patró de Prometheus|patró6,\7|valor, etiqueta, funció|sortida8,\9|0, 1, 2, 3| |23|Prometheus a JSON|patró6,\7|<|<|0, 1, 2, 3| |24|CSV a JSON|char2|char2|0,1|0, 1, 2, 3| |25|Substitueix|cadena de cerca2|substitueix2|<|<| |26|La verificació no és compatible|<|<|<|1, 2, 3| |27|XML a JSON|<|<|<|0, 1, 2, 3| |28|Valor SNMP walk|OID2|Format:
0 - No canviat
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Enter de BITS|<|0, 1, 2, 3| |29|SNMP walk a JSON10|Field name2|OID prefix2|Format:
0 - No canviat
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Enter de BITS|0, 1, 2, 3|
1 nombre enter o coma flotant
2 cadena
3 expressió regular
4 JSONPath o XML XPath
5 enter positiu (amb suport per a sufixos de temps, per exemple, 30s, 1m, 2h, 1d)
6 macro d'usuari
7 El model de Prometheus segueix 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. 8 Prometheus mostra la següent sintaxi: <nom de l'etiqueta> (pot ser una macro d'usuari) si etiqueta està seleccionada com a segon paràmetre.
9 Una de les funcions agregades: sum, min, max, avg, count si function està seleccionat com a segon paràmetre. 10 Admet diversos "Nom de camp,prefix OID,Registre de format" registres separtas per un caràcter de nova línia.