Los siguientes objetos están directamente relacionados con la API itemprototype
.
El objeto prototipo de métrica tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
itemid | cadena | ID del prototipo de métrica. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
delay | cadena | Intervalo de actualización del prototipo de la métrica. Acepta segundos o una unidad de tiempo con sufijo (30s,1m,2h,1d). Opcionalmente uno o más intervalos personalizados se pueden especificar como intervalos flexibles o programación. Varios intervalos están separados por un punto y coma. Se pueden utilizar macros de usuario y macros LLD. Una sola macro tiene que llenar todo el campo. No se admiten varias macros en un campo ni macros mezcladas con texto. Los intervalos flexibles se pueden escribir como dos macros separadas por una barra diagonal (por ejemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD} ).<br >Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Agente Zabbix" (0), "Comprobación simple" (3), "Zabbix interno" (5), "Verificación externa" (10), "Monitor de base de datos" (11), "Agente IPMI" (12), "Agente SSH" (13), "Agente TELNET" (14), "Calculado" ( 15), "agente JMX" (16), "agente HTTP" (19), "agente SNMP" (20), "Script" (21), o si "tipo" está configurado en "agente Zabbix (activo)" ( 7) y key_ no contiene "mqtt.get" |
hostid | cadena | ID del equipo al que pertenece el prototipo de la métrica. Comportamiento de la propiedad: - constante - obligatorio para las operaciones de creación |
interfaceid | cadena | ID de la interfaz de equipo del prototipo de métrica. Comportamiento de la propiedad: - obligatorio si el prototipo del elemento pertenece al host y el tipo está configurado en "agente Zabbix", "agente IPMI", "agente JMX", "Captura SNMP" o " Agente SNMP"- compatible si el prototipo del elemento pertenece al host y el tipo está configurado en "Verificación simple", "Verificación externa", "Agente SSH", "Agente TELNET" o "Agente HTTP" |
key_ | cadena | Clave de prototipo de métrica. Comportamiento de la propiedad: - requerido para operaciones de creación - leer- solo para objetos heredados |
name | cadena | Nombre del prototipo del elemento. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
type | entero | Tipo de prototipo del artículo. Valores posibles: 0 - Agente Zabbix; 2 - Captura Zabbix;< br>3 - Verificación simple; 5 - Zabbix interno; 7 - Agente Zabbix (activo); 10 - Verificación externa; 11 - Monitor de base de datos; 12 - Agente IPMI; 13 - Agente SSH; 14 - Agente TELNET; 15 - Calculado; 16 - Agente JMX; 17 - Captura SNMP; 18 - Métrica dependiente; 19 - Agente HTTP; 20 - Agente SNMP; 21 - Script. Comportamiento de la propiedad: - obligatorio para operaciones de creación - solo lectura para objetos heredados |
url | cadena | Cadena URL. Admite macros LLD, macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS }, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}. Comportamiento de la propiedad:< br>- obligatorio si tipo está configurado en "agente HTTP"- solo lectura para objetos heredados |
value_type | entero | Tipo de información del prototipo del artículo. <br >Valores posibles: 0 - flotante numérico; 1 - carácter; 2 - registro; 3 - numérico sin signo; 4 - texto. Comportamiento de la propiedad: - obligatorio para operaciones de creación - solo lectura para objetos heredados |
allow_traps | entero | Permitir completar el valor de manera similar a la métrica de captura. 0 - (predeterminado) No permitir aceptar datos entrantes; 1 - Permitir aceptar datos entrantes. Comportamiento de la propiedad: - compatible si type está configurado como "agente HTTP" |
authtype | entero | Método de autenticación. Valores posibles si type está configurado a "agente SSH":0 - (predeterminada) contraseña; 1 - clave pública. Valores posibles si tipo está configurado en "agente HTTP":0 - (predeterminado) ninguno; 1 - básico; 2 - NTLM; 3 - Kerberos. Comportamiento de la propiedad: - compatible si tipo está configurado como "agente SSH" o "agente HTTP"- solo lectura para objetos heredados (si tipo está configurado como "agente HTTP") |
description | cadena | Descripción del prototipo de métrica. |
follow_redirects | entero | Seguir redirecciones de respuesta mientras se agrupan datos. Valores posibles: 0 - No seguir redirecciones; 1 - (predeterminado) Seguir redirecciones. Comportamiento de la propiedad: - compatible si tipo está configurado como "agente HTTP" - solo lectura para objetos heredados |
headers | objeto | Objeto con encabezados de solicitud HTTP(S), donde el nombre del encabezado se utiliza como clave y el valor del encabezado como valor. Ejemplo: { "User-Agent": "Zabbix" } < br>Comportamiento de la propiedad: - compatible si tipo está configurado como "agente HTTP"- solo lectura para objetos heredados |
history | cadena | Una unidad de tiempo de cuánto tiempo se deben almacenar los datos del historial. También acepta una macro de usuario o macro LLD. Predeterminado: 90d. |
http_proxy | cadena | HTTP(S ) cadena de conexión de proxy. Comportamiento de la propiedad: - compatible si tipo está configurado como "agente HTTP"- solo lectura para objetos heredados |
ipmi_sensor | cadena | Sensor IPMI. Comportamiento de la propiedad: - obligatorio si type está configurado como "agente IPMI" y key_ no está configurado como "ipmi.get"- compatible si type está configurado como "agente IPMI"- solo lectura para objetos heredados |
jmx_endpoint | cadena | Cadena de conexión personalizada del agente JMX. Predeterminado: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT }/jmxrmi Comportamiento de la propiedad: - compatible si tipo está configurado en "agente JMX" |
logtimefmt | string | Formato de la hora en las entradas del registro. Comportamiento de la propiedad: - compatible si value_type está configurado en "log"<br >- solo lectura para objetos heredados |
master_itemid | entero | ID de la métrica principal. Se permite la recursividad de hasta 3 elementos dependientes y prototipos de elementos y un recuento máximo de elementos dependientes y prototipos de elementos igual a 29999.< br> Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Elemento dependiente"- solo lectura para objetos heredados |
output_format | entero | ¿Debería la respuesta convertirse a JSON? Valores posibles: 0 - (predeterminado) Almacenar sin formato; 1 - Convertir a JSON.< br> Comportamiento de la propiedad: - compatible si tipo está configurado en "Agente HTTP"- solo lectura para objetos heredados |
params | cadena | Parámetros adicionales dependiendo del tipo de prototipo de métrica: - script ejecutado para prototipos de métricas de agente SSH y agente TELNET; - Consulta SQL para prototipos de métricas de monitor de base de datos; - fórmula para prototipos de métricas calculadas. Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Monitor de base de datos", "SSH agent", "agente TELNET", "Calculada" o "Script"- solo lectura para objetos heredados (si type está configurado en "Script") |
parameters | matriz | Parámetros adicionales si type está configurado en "Script". Matriz de objetos con propiedades nombre y valor , donde nombre debe ser único.Comportamiento de la propiedad: - compatible si tipo está configurado en "Script"- solo lectura para objetos heredados |
password | cadena | Contraseña para autenticación. Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Agente JMX" y nombre de usuario está configurado- compatible si tipo está configurado en "Comprobación simple", " Agente SSH", "agente TELNET", "monitor de base de datos" o "agente HTTP"- solo lectura para objetos heredados (si tipo está configurado en "agente HTTP") |
post_type | entero | Tipo de cuerpo de datos de publicación almacenado en la propiedad posts .Valores posibles: 0 - (predeterminado) Datos sin procesar. 2 - Datos JSON. 3 - XML data. Comportamiento de la propiedad: - compatible si tipo está configurado en "Agente HTTP"- leer- solo para objetos heredados |
posts | cadena | Datos del cuerpo de solicitud HTTP(S). Comportamiento de la propiedad: - obligatorio si type está configurado como "agente HTTP" y post_type está configurado como "datos JSON" o "datos XML"- compatible si type está configurado como "agente HTTP" y post_type está configurado a "Datos sin procesar"- solo lectura para objetos heredados |
privatekey | cadena | Nombre del archivo de clave privada. Comportamiento de la propiedad: - obligatorio si type está configurado como "agente SSH" y authtype está configurado como "clave pública" |
publickey | string | Nombre del archivo de clave pública. <br >Comportamiento de la propiedad: - obligatorio si type está configurado como "agente SSH" y authtype está configurado como "clave pública" |
query_fields | matriz | Parámetros de consulta. Matriz de objetos con pares clave :valor , donde valor puede ser una cadena vacía.Comportamiento de la propiedad: - * admitido* si tipo está configurado en "agente HTTP"- solo lectura para objetos heredados |
request_method | entero | Tipo de método de solicitud. Valores posibles: 0 - (predeterminado) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamiento de la propiedad: - compatible si tipo está configurado como "agente HTTP"- * solo lectura* para objetos heredados |
retrieve_mode | entero | Qué parte de la respuesta debe almacenarse. Valores posibles si request_method está configurado en "GET", "POST" o "PUT" :0 - (predeterminado) Cuerpo; 1 - Encabezados; 2 - Se almacenarán tanto el cuerpo como los encabezados. Valores posibles si request_method está configurado en "HEAD ":1 - Encabezados. Comportamiento de la propiedad: - compatible si tipo está configurado en "Agente HTTP" - solo lectura para objetos heredados |
snmp_oid | cadena | SNMP OID. Comportamiento de la propiedad: - obligatorio si type está configurado en "Agente SNMP"- solo lectura para objetos heredados |
ssl_cert_file | cadena | Ruta del archivo de clave SSL pública. Propiedad comportamiento: - compatible si tipo está configurado como "agente HTTP"- solo lectura para objetos heredados |
ssl_key _file | cadena | Ruta del archivo de clave SSL privada. Comportamiento de la propiedad: - compatible si tipo está configurado en "HTTP agente"- solo lectura para objetos heredados |
ssl_key_password | string | Contraseña para el archivo de clave SSL. Comportamiento de la propiedad: - compatible si type está configurado en "agente HTTP"- solo lectura para objetos heredados |
status | entero | Estado del prototipo de métrica. <br >Valores posibles: 0 - (predeterminado) prototipo de artículo habilitado; 1 - prototipo de artículo deshabilitado; 3 - prototipo de artículo no compatible. |
status_codes | cadena | Rangos de códigos de estado HTTP requeridos , separados por comas. También admite macros de usuario o macros LLD como parte de una lista separada por comas. Ejemplo: 200,200-{$M},{$M},200-400 <br >Comportamiento de la propiedad: - compatible si type está configurado como "agente HTTP"- solo lectura para objetos heredados |
templateid | string | ID del prototipo de métrica de la plantilla principal. Comportamiento de la propiedad: - solo lectura |
timeout | cadena | Tiempo de espera de solicitud de sondeo de datos de métricas. Admite macros de usuario y macros LLD. Predeterminado: 3s .Valor máximo: 60s .Comportamiento de la propiedad: - compatible si type está configurado en "agente HTTP" o "Script"- solo lectura para objetos heredados |
trapper_hosts | cadena | Equipos permitidos. Comportamiento de la propiedad: - compatible si tipo está configurado en "Zabbix trapper", o si type está configurado en "Agente HTTP" y allow_traps está configurado en "Permitir aceptar datos entrantes" |
trends | cadena | Una unidad de tiempo de cuánto tiempo se deben almacenar los datos de tendencias. También acepta una macro de usuario o macro LLD. Predeterminado: 365d. Comportamiento de la propiedad: - compatible si se establece value_type a "numérico flotante" o "numérico sin signo" |
units | cadena | Unidades de valor. Comportamiento de la propiedad: - compatible si value_type está establecido en "numérico flotante" o "numérico sin firmar"- solo lectura para objetos heredados |
username | cadena | Nombre de usuario para autenticación. Comportamiento de la propiedad: - obligatorio si "tipo" está configurado como "agente SSH" o "agente TELNET", o si "tipo" está configurado como "agente JMX" y "contraseña" está configurado - compatible si tipo está configurado en "Comprobación simple", "Monitor de base de datos" o "agente HTTP"- solo lectura para objetos heredados (si tipo está configurado a "agente HTTP") |
uuid | cadena | Identificador único universal, utilizado para vincular prototipos de métricas importados con los ya existentes. Generado automáticamente, si no se proporciona. Comportamiento de la propiedad: - compatible si el prototipo del artículo pertenece a una plantilla |
valuemapid | cadena | ID del mapa de valores asociado. Comportamiento de la propiedad: - compatible si value_type está establecido en "flotante numérico" , "carácter" o "numérico sin firmar"- solo lectura para objetos heredados |
verify_host | entero | Validar que el nombre de host en la URL esté en el campo Nombre común o en el campo Nombre alternativo del sujeto del certificado de equipo. Valores posibles: 0 - (predeterminado) No validar; 1 - Validar. Comportamiento de la propiedad: - compatible si type está configurado en "HTTP agente"- solo lectura para objetos heredados |
verify_peer | entero | Validar es el certificado de equipo auténtico. Valores posibles: 0 - (predeterminado) No validar ; 1 - Validar. Comportamiento de la propiedad: - compatible si type está configurado en "agente HTTP"< br>- solo lectura para objetos heredados |
discover | entero | Estado de descubrimiento del prototipo de métrica. Valores posibles: 0 - (predeterminado) se descubrirán nuevas métricas; 1: no se descubrirán métricas nuevos y las métricas existentes se marcarán como perdidas. |
The header object has the following properties:
Property | Type | Description |
---|---|---|
name (required) |
string | HTTP header name. |
value (required) |
string | Header value. |
The query field object defines a name and value that is used to specify a URL parameter. It has the following properties:
Property | Type | Description |
---|---|---|
name (required) |
string | Name of the parameter. |
value (required) |
string | Parameter value. |
El objeto de etiqueta de prototipo de métrica tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
tag | cadena | Nombre de etiqueta del prototipo de métrica. Comportamiento de la propiedad: - obligatorio |
value | cadena | Valor de etiqueta de prototipo de métrica. |
El objeto de preprocesamiento del prototipo de métrica tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
type | integer | El tipo de opción de preprocesamiento. Valores posibles: 1 - Multiplicador personalizado; 2 - Recorte derecho; 3 - Recorte izquierdo; 4 - Recorte; 5 - Expresión regular; 6 - Booleano a decimal; 7 - Octal a decimal; 8 - Hexadecimal a decimal; 9 - Cambio simple; 10 - Cambio por segundo; 11 - XML XPath; 12 - JSONPath; 13 - Dentro del rango; 14 - Coincide con la expresión regular; 15 - No coincide con la expresión regular; 16 - Comprobar errores en JSON; 17 - Comprobar errores en XML; 18 - Comprobar errores usando expresiones regulares; 19 - Descartar sin cambios; 20 - Descartar sin cambios con un latido; 21 - JavaScript; 22 - Patrón Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar; 26 - Verificar no compatible; 27 - XML a JSON; 28 - Valor de SNMP walk; 29 - SNMP walk a JSON. Comportamiento de la propiedad: - obligatorio |
params | string | Parámetros adicionales utilizados por la opción de preprocesamiento. Varios parámetros están separados por el carácter de nueva línea (\n). Comportamiento de la propiedad: - obligatorio si tipo está configurado en "Multiplicador personalizado" (1), "Recorte derecho" (2), "Recorte izquierdo" (3), "Recortar" (4), "Expresión regular " (5), "XML XPath" (11), "JSONPath" (12), "Dentro del rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" (15), "Verificar "Buscar errores en JSON" (16), "Verificar errores en XML" (17), "Verificar errores usando expresiones regulares" (18), "Descartar sin cambios con latido" (20), "JavaScript" (21), " Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Reemplazar" (25), "Valor de SNMP walk" (28) o "SNMP walk a JSON" (29 ) |
error_handler | entero | Tipo de acción utilizado en caso de falla en el paso de preprocesamiento. Valores posibles: 0: el servidor Zabbix establece el mensaje de error; 1: descartar valor; 2 - Establecer un valor personalizado; 3 - Establecer un mensaje de error personalizado. Valores posibles si tipo está configurado en "Verificar no admitido":1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Comportamiento de la propiedad: - obligatorio si type está configurado en "Multiplicador personalizado" (1), "Expresión regular" (5), "Booleano a decimal" (6), "Octal a decimal" (7), "Hexadecimal a decimal" (8), "Cambio simple" (9) , "Cambio por segundo" (10), "XML XPath" (11), "JSONPath" (12), "Dentro del rango" (13), "Coincide con la expresión regular" (14), "No coincide con la expresión regular" ( 15), "Verificar errores en JSON" (16), "Verificar errores en XML" (17), "Verificar errores usando expresiones regulares" (18), "Patrón de Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Verificar no compatible" (26), "XML a JSON" (27), "Valor de SNMP walk" (28) o "SNMP walk a JSON" (29) |
error_handler_params | cadena | Parámetros del controlador de errores. Comportamiento de la propiedad: - obligatorio si error_handler está configurado en "Establecer valor personalizado" o "Establecer mensaje de error personalizado" |
Se admiten los siguientes parámetros y controladores de errores para cada tipo de preprocesamiento.
|Tipo de preprocesamiento|Nombre|Parámetro 1|Parámetro 2|Parámetro 3|Manejadores de errores admitidos| |------------------|----|-----------|-----------|- ----------|---------------------------------| |1|Multiplicador personalizado|número1, 6|<|<|0, 1, 2, 3| |2|Recorte derecho|lista de caracteres2|<|<|<| |3|Recorte izquierdo|lista de caracteres2|<|<|<| |4|Recortar|lista de caracteres2|<|<|<| |5|Expresión regular|patrón3|salida2|<|0, 1, 2, 3| |6|Booleano a decimal|<|<|<|0, 1, 2, 3| |7|Octal a decimal|<|<|<|0, 1, 2, 3| |8|Hexadecimal a decimal|<|<|<|0, 1, 2, 3| |9|Cambio simple|<|<|<|0, 1, 2, 3| |10|Cambio por segundo|<|<|<|0, 1, 2, 3| |11|XML XPath|ruta4|<|<|0, 1, 2, 3| |12|JSONPath|ruta4|<|<|0, 1, 2, 3| |13|En el rango|min1, 6|max1, 6|<|0, 1, 2, 3| |14|Coincide con la expresión regular|patrón3|<|<|0, 1, 2, 3| |15|No coincide con la expresión regular|patrón3|<|<|0, 1, 2, 3| |16|Compruebe si hay errores en JSON|ruta4|<|<|0, 1, 2, 3| |17|Compruebe si hay errores en XML|ruta4|<|<|0, 1, 2, 3| |18|Compruebe si hay errores usando la expresión regular|patrón3|salida2|<|0, 1, 2, 3| |19|Descartar sin cambios|<|<|<|<| |20|Descartar sin cambios con latidos|segundos5, 6|<|<|<| |21|JavaScript|script2|<|<|<| |22|Patrón de Prometeo|patrón6, 7|valor
, etiqueta
, función
|salida8, 9|0, 1, 2, 3| |23|Prometeo a JSON|patrón6, 7|<|<|0, 1, 2, 3| |24|CSV a JSON|carácter2|carácter2|0,1|0, 1, 2, 3| |25|Reemplazar|cadena de búsqueda2|reemplazo2|<|<| |26|Comprobación no admitida|<|<|<|1, 2, 3| |27|XML a JSON|<|<|<|0, 1, 2, 3| |28|Valor de SNMP walk|OID2|Formato:
0 - Sin cambios
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Entero de BITS |<|0, 1, 2, 3| |29|SNMP walk a JSON10|Nombre de campo2|Prefijo OID2|Formato:
0 - Sin cambios
1 - UTF-8 de Hex-STRING
2 - MAC de Hex-STRING
3 - Entero de BITS|0, 1, 2, 3|
1 número entero o de coma flotante
2 cadena
3 expresión regular
4 JSONPath o XML XPath
5 entero positivo (con soporte de sufijos de tiempo, por ejemplo, 30s, 1m, 2h, 1d)
6 macro de usuario, macro LLD
7 Patrón de Prometheus siguiendo la sintaxis: <nombre de métrica>{<nombre de etiqueta>="<valor de etiqueta>", ...} == <valor>
. Cada Componente del patrón Prometheus (métrica, nombre de etiqueta, valor de etiqueta y métrica) valor) puede ser una macro de usuario o una macro LLD.
8 Salida de Prometheus siguiendo la sintaxis: <nombre de etiqueta>
(puede ser una macro de usuario o una macro LLD) si se selecciona etiqueta
como segundo parámetro.
9 Una de las funciones de agregación: suma
, min
, max
, avg
, count
si se selecciona function
como segunda parámetro.
10 Admite múltiples registros de "Nombre de campo, prefijo OID, registros de formato" delimitados por un carácter de nueva línea.