Documentation
Table of Contents
> Objeto prototipo de item
Los siguientes objetos están directamente relacionados con la API itemprototype.
Prototip d'element
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| itemid | string | (només lectura) ID del prototip d'element. |
| delay (obligatori) |
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}).<br >Opcional per a Zabbix trapper, elements dependents i per a agent Zabbix (actiu) amb la clau mqtt.get. |
| hostid (obligatori) |
string | Id de l'equip o de la plantilla a la qual pertany el prototip d'element. Per a les operacions d'actualització, aquest camp és de només lectura. |
| ruleid (obligatori) |
string | ID de la regla LLD a la qual pertany l'element. Per a les operacions d'actualització, aquest camp és de només lectura. |
| interfaceid (obligatori) |
string | Identificador d'interfície equip del prototip d'element. Només s'empra per als prototips d'element equip. No és necessari per a l'agent Zabbix (actiu), Zabbix intern, Zabbix trapper, calculat, dependent, monitor de base de dades i prototips d'elements d'script. Opcional per als elements de prototip d'agent HTTP. |
| key_ (obligatori) |
string | Clau del prototip d'element. |
| name (obligatori) |
string | Nom del prototip de l'element. |
| type (obligatori) |
entier | 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 |
| url (obligatori) |
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}. |
| valor_tipus (obligatori) |
entier | Tipus d'informació del prototip d'element. Valors possibles: 0 - nombre flotant; 1 - caràcter ;<br >2 - diari; 3 - digital sense signar; 4 - text. |
| 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. |
| 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 del mètode d'autenticació de l'agent HTTP: 0 - (per defecte) cap 1 - Bàsic 2 - NTLM 3 - Kerberos |
| 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. |
| 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" } |
| 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 | Camp de prototip d'element d'agent HTTP. Cadena de connexió del proxy HTTP(S). |
| ipmi_sensor | string | sensor IPMI. Emprat només pels prototips d'elements IPMI. |
| jmx_endpoint | string | Cadena de connexió de l'agent JMX personalitzada. Per defecte: service:jmx:rmi:///jndi/rmi://{HOST.CONN} :{HOST.PORT} /jmxrmi |
| logtimefmt | string | Format d'hora a les entrades de registre. S'empren només per prototips d'elements de diari. |
| 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. < br>Requerit per elements dependents. |
| 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. |
| 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. |
| 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. |
| password | string | Mot de pas per a l'autenticació. Emprat per Simple Check, SSH, Telnet, Database Monitor, JMX i HTTP Agent Item Prototypes. |
| 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. |
| posts | string | Camp de prototip d'element d'agent HTTP. HTTP(S) demana 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 prototip d'element d'agent HTTP. Paràmetres de consulta. Matriu d'objectes amb parells 'clau':'valor', on el valor pot ésser una cadena buida. |
| 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 |
| retrieve_mode | integer | Camp de prototip d'element d'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 s'admet el valor 1. |
| snmp_oid | string | SNMP OID. |
| ssl_cert_file | string | Camp de prototip d'element d'agent HTTP. Camí al fitxer de clau SSL pública. |
| ssl_key_file | string | Camp de prototip d'element d'agent HTTP. Camí al fitxer de clau SSL privada. |
| ssl_key_password | string | Camp de prototip d'element d'agent HTTP. Mot de pas per al fitxer de clau SSL. |
| 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 |
| templateid | string | (només lectura) ID del prototip d'element de plantilla principal. |
| 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 |
| trapper_hosts | string | Equips permesos. Emprat per prototips d'elements trapper o prototips d'elements d'agent HTTP. |
| 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. |
| units | string | Unitats de valor. |
| username | string | Nom d'usuari per a l'autenticació. S'empra per simple verificació, SSH, Telnet, monitor de base de dades, prototips d'elements d'agent JMX i HTTP. Requerit pels prototips d'elements SSH i Telnet. |
| 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. Per a les operacions d'actualització, aquest camp és només lectura. |
| valuemapid | string | ID de la taula. coincidència de valors associats. |
| verify_host | integer | Camp de prototip d'element d'agent HTTP. Valida que el nom d'equip a l'URL sigui al camp Nom comú o Nom alternatiu del subjecte del certificat d'equip. 0 - (per defecte) No valideu. 1 - Valida. |
| verify_peer | integer | Camp de prototip d'element d'agent HTTP. Valideu si el certificat d'equip és autèntic. 0 - (per defecte) No validar. 1 - Validar. |
| 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. |
Tingueu en compte que per a alguns mètodes (actualitzar, esborrar) la combinació de paràmetres obligatoris/opcionals és diferent.
Etiqueta de prototipo de métrica
El objeto de etiqueta del prototipo de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag (obligatorio) |
cadena | Nombre de etiqueta del prototipo de métrica. |
| value | cadena | Valor de etiqueta del prototipo de métrica. |
Preprocessament del prototip d'element
L'objecte té les propietats següents.
| Propietat | Tipus | Descripció |
|---|---|---|
| type (obligatori) |
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. |
| params (obligatori) |
string | Paràmetres addicionals emprats per l'opció de preprocessament. Diversos paràmetres són separats pel caràcter LF (\n). |
| error_handler (obligatori) |
integer | Tipus d'acció emprat en cas d'error del pas de preprocessament: 0 - El servidor Zabbix ha establert el missatge d'error ; 1 - Elimina el valor;< br>2 - Estableix un valor personalitzat; 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 pas é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| |-------------------|----|-----------|------------|- ----------|----------| |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|
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.