Documentation
Table of Contents
> Objecte prototip d'elements
Els següents objectes són relacionats amb l'API itemprototype.
Prototip d'element
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| itemid | string | ID del prototip d'element. Comportament de la propietat: - només lectura - obligatori per operacions d'actualització |
| delay | string | Interval d'actualització del prototip d'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 a dues macros separades per una barra inclinada (p. ex., {$FLEX_INTERVAL}/ {$FLEX_PERIOD}).Comportament de la propietat: - obligatori si type és "Agent Zabbix" (0), "Verificació simple" (3), "Zabbix intern" (5), "Verificació externa" (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 "Agent Zabbix (actiu)" (7) i key_ no conté "mqtt.get" |
| hostid | string | Id de l'equip o de la plantilla a la qual pertany el prototip d'element. Comportament de la propietat: - constant - obligatori per operacions de creació |
| interfaceid | string | Identificador d'interfície equip del prototip d'element.< Comportament de la propietat: - obligatori si el prototip d'element pertany a l'equip i type és "Agent Zabbix", "Agent IPMI", "Agent JMX", Traça SNMP" o "Agent SNMP"- admès si el prototip d'element pertany a l'equip i type és "Verificació senzilla", "Verificació externa", "Agent SSH", "Agent Telnet" o "Agent HTTP" |
| key_ | string | Clau del prototip d'element. Comportament de la propietat: - obligatori per operacions de creació - només lectura per objectes heretats |
| name | string | Nom del prototip de l'element. Comportament de la propietat: - obligatori per operacions de creació - només lectura per objectes heretats |
| type | integer | Tipus de prototip 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 - IPMI Agent; 13 - Agent SSH; 14 - Agent Telnet; 15 - Calculat; 16 - Agent JMX; 17 - Trampa SNMP; 18 - Element dependent;< br>19 - Agent HTTP; 20 - Agent SNMP; 21 - Script Comportament de la propietat: - obligatori per operacions de creació - només lectura per objectes heretats |
| url | string | cadena d'URL, necessària només per al tipus de prototip 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 si type és "Agent HTTP"- només lectura per objectes heretats |
| value_type | integer | Tipus d'informació del prototip d'element. Valors possibles: 0 - nombre flotant; 1 - caràcter ;<br >2 - diari; 3 - digital sense signar; 4 - text. Comportament de la propietat: - obligatori per operacions de creació - només lectura per objectes heretats |
| allow_traps | integer | camp de prototip d'element d'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" |
| authtype | integer | Només s'empren per elements d'agent SSH prototip o elements d'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 si type és "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") |
| description | string | Descripció del prototip d'element. |
| follow_redirects | integer | Prototip de camp d'element d'agent HTTP. Seguiu les redireccions de respostes mentre aegiu dades. 0 - No seguir les redireccions. 1 - (per defecte) Seguir les redireccions. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| headers | object | Camp de prototip d'element d'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 |
| history | string | Unitat de temps que indica quant de temps s'han d'emmagatzemar les dades de l'històric. També admet macros d'usuari. Per defecte: 90d. |
| http_proxy | string | Cadena de connexió del proxy HTTP(S). |
| ipmi_sensor | string | sensor IPMI. Emprat només pels prototips d'elements IPMI. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| 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" |
| 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 |
| master_itemid | integer | Identificador d'element principal. Es permet la recursivitat fins a 3 elements dependents i el nombre màxim d'elements i prototips d'elements dependents de 29.999. Comportament de la propietat: - admès si type és "Element dependent"- només lectura per objectes heretats |
| output_format | integer | Camp d'element de prototip d'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 |
| params | string | Paràmetres addicionals en funció del tipus de prototip d'element: - script executat per a prototips d'elements SSH i Telnet; - Consulta SQL per a dades de prototips d'elements de supervisió bàsica; - fórmula per a prototips d'elements calculats. Comportament de la propietat: - admès si type és "Monitoratge de base de dades", "Agent SSH, "Agent TELNET", "Calculat" o "Script"- només lectura per objectes heretats (si type és "Script") |
| parameters | array | Paràmetres addicionals per a prototips d'elements de 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 |
| password | string | Mot de pas per a l'autenticació. Comportament de la propietat: - obligatori si type és "Agent JMX" i username s'ha definit- 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") |
| post_type | integer | Camp de prototip d'element d'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 |
| posts | string | HTTP(S) demana dades del cos. 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 |
| privatekey | string | Nom del fitxer de clau privada. Comportament de la propietat: - obligatori si type és "Agent SSH" i àuth_typeés "clau pública"| |publickey|string|Nom del fitxer de clau pública.typeés "Agent SSH" i àuth_type és "clau pública" |
| query_fields | array | Camp de prototip d'element d'agent HTTP. Paràmetres de consulta. Matriu d'objectes amb parells clau:valor, on valor pot ésser una cadena buida.Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| request_method | integer | Camp de prototip d'element d'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 |
| retrieve_mode | integer | Quina part de la resposta s'ha d'emmagatzemar. Valors possibles si request_method és "GET", "POST" o "PUT":0 - (per defecte) Cos; 1 - Capçaleres. 2 - S'emmagatzemaran el cos i les capçaleres.< br> Valors possibles si request_method és "HEAD":1 - Capçaleres. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| snmp_oid | string | SNMP OID. Comportament de la propietat: - obligatori si type és "Agent SNMP"- només lectura per objectes heretats |
| ssl_cert_file | string | 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 |
| ssl_key_file | string | Camí al fitxer de clau SSL privada Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats. |
| ssl_key_password | string | 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 |
| status | integer | Estat del prototip d'element. Valors possibles: 0 - prototip d'element habilitat (per defecte); 1 - prototip d'element desactivat;< br>2 - prototip d'element no compatible. |
| status_codes | string | Camp de prototip d'element d'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 |
| templateid | string | (només lectura) ID del prototip d'element de plantilla principal. Comportament de la propietat: - només lectura |
| timeout | string | Temps d'espera de la consulta de dades d'element. S'empra per a l'agent HTTP i els prototips d'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 |
| trapper_hosts | string | Equips permesos. Comportament de la propietat: - admès si type és "Traces Zabbix" o si type és "Agent HTTP" i allow_traps és "Permetre acceptar dades d'entrada" |
| trends | string | Unitat de temps de quant de temps s'han d'emmagatzemar les dades de tendències. També admet macros d'usuari. Per defecte: 365d. Comportament de la propietat: - admès si value_type és "numèric flotant" o "numèric sense signe" |
| 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 |
| username | string | Nom d'usuari per a l'autenticació. Comportament de la propietat: - obligatori si type és "Agent SSH" o "Agent TELNET", o si type és "Agent JMX" i password s'ha definit- admès si type és "Verficació simple", "Monitoratge de base de dades" o "Agent HTTP"- només lectura per objectes heretats (si type és "Agent HTTP") |
| uuid | string | Identificador únic universal, que s'empra per enllaçar un prototip d'element importat amb prototips d'element ja existents. S'empra només per a prototips d'elements de model. Es genera automàticament, si no es proporciona. Comportament de la propietat: - admès si el prototip d'element pertany a una plantilla |
| valuemapid | string | ID del mapa de valors associats. 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 |
| verify_host | integer | CValida que el nom d'equip a l'URL sigui al camp Nom comú o Nom alternatiu del subjecte del certificat d'equip. Valors possibles: 0 - (per defecte) No valideu. 1 - Valida. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| verify_peer | integer | Valideu si el certificat d'equip és autèntic. 0 - (per defecte) No validar. 1 - Validar. Comportament de la propietat: - admès si type és "Agent HTTP"- només lectura per objectes heretats |
| discover | integer | Estat de descobriment del prototip d'element. Valors possibles: 0 - (per defecte) es descobriran nous elements; 1 - no es descobriran elements nous i els elements existents es marcaran com a perduts. |
Etiqueta de prototip d'element
L'objecte d'etiqueta de prototip d'element té les propietats següents:
| Propietat | Tipus | Descripció |
|---|---|---|
| tag | string | Nom de l'etiqueta de prototip d'element. Comportament de la propietat: - obligatori |
| value | string | Valor de l'etiqueta del prototip d'element. |
Preprocessament del prototip d'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 - Elimina els espais finals; 3 - Eliminació d'espais inicials; 4 - Eliminació d'espais finals i posteriors; 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; 15 - No coincideix amb l'expressió regular; 16 - Comprova si hi ha un error a JSON; 17 - Comprova si hi ha un error a XML; 18 - Troba un error emprant una expressió regular; 19 - Esborra sense modificacions; 20 - Esborra sense modificacions amb heartbeat; 21 - JavaScript;< 22 - Patró de Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Substitueix; 26 - Comprova si hi ha valors no admesos; 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. Múltiples paràmetres són separats pel caràcter de nova línia (\n). Comportament de la propietat: - obligatori si tipus s'estableix a "Multiplicador personalitzat" (1), "Retall dret" (2), "Retall esquerre" (3), "Retall" (4), "Expressió regular coincident" (5), "XML XPath" (11), "JSONPath" (12), "En l'abast" (13), "Coincideix amb l'expressió regular" (14), "No coincideix amb l'expressió regular" (15), " Comprovar si hi ha errors en JSON" (16), "Comprovar si hi ha errors en XML" (17), "Comprovar si hi ha errors mitjançant l'expressió regular" (18), "Descartar sense canvis amb heartbeat" (20), "JavaScript" (21), "Patró de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Substitueix" (25), "Valor de caminada SNMP" (28) o "Patró SNMP a JSON" ( 29) |
| error_handler | integer | Tipus d'acció emprat en cas d'error de la passa de preprocessament. Valors possibles: 0 - El servidor Zabbix ha establert el missatge d'error; 1 - Descarta el valor; 2 - Establiu un valor personalitzat; 3 - Estableix un missatge d'error personalitzat. Valors possibles si type s'estableix com a "Comprova no compatible":1 - Descarta el valor; 2 - Estableix valor personalitzat; 3 - Establiu un missatge d'error personalitzat. Comportament de la propietat: - obligatori si type s'estableix en "Multiplicador personalitzat" (1), "Concordança d'expressions regulars" (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 l'abast" (13), "Coincideix amb l'expressió regular" (14), "No coincideix amb l'expressió regular" (15), "Comprova si hi ha errors en JSON" (16), "Comprova si hi ha errors en XML" (17), "Comprova si hi ha errors mitjançant l'expressió regular" (18), "Patró Prometheus" (22), "Prometheus a JSON " (23), "CSV a JSON" (24), "Comprova que no s'admet" (26), "XML a JSON" (27), "Valor de caminada SNMP" (28) o "Caminada SNMP a JSON" (29) |
| error_handler_params | string | Paràmetres del gestor d'errors. Comportament de la propietat: - obligatori si error_handler està establert en "Estableix un valor personalitzat" o "Estableix un 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|Eliminació d'espais finals|llista de caràcters2|<|<|<| |3|Eliminació dels espais inicials|llista de caràcters2|<|<|<| |4|Eliminació dels espais inicials i finals|llista de caràcters2|<|<|<| |5|Concordança d'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ó regular3|<|<|0, 1, 2, 3| |16|Cerca un error a JSON|camí4|<|<|0, 1, 2, 3| |17|Cerca un error a XML|camí4|<|<|0, 1, 2, 3| |18|Cerca un error emprant una expressió regular|patró3|sortida2|<|0, 1, 2, 3| |19|Esborra sense modificacions|<|<|<|<| |20|Esborra sense canvis amb el heratbeat|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|Comprova si hi ha valors no admesos|<|<|<|1, 2, 3| |27|XML a JSON|<|<|<|0, 1, 2, 3| |28|Valor SNMP walk|OID2|Format:
0 - Sense canvis
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 - Sense canvis
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, macro LLD
7 Patró Prometheus següent 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 ésser una macro d'usuari o una macro LLD.
8 Prometheus dóna la següent sintaxi: <nom de l'etiqueta> (pot ésser una macro d'usuari o una macro LLD) si label és seleccionada com a segon paràmetre.
9 Una de les funcions d'agregació: sum, min, max, avg, count si function és seleccionada com a segon paràmetre. 10 Admet diversos registrs "Field name,OID prefix,Format records" separats per un caràcter de nova línia.