Table of Contents
Objeto prototipo de métrica
Los siguientes objetos están directamente relacionados con la API itemprototype.
Prototipo de métrica
El objeto prototipo de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| itemid | ID | ID del prototipo de métrica. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| delay | string | Intervalo de actualización del prototipo de métrica. Acepta segundos o unidad de tiempo con sufijo (por ejemplo, 30s, 1m, 2h, 1d) y, opcionalmente, uno o más intervalos personalizados, todos separados por punto y coma. Los intervalos personalizados pueden ser una mezcla de intervalos flexibles y de programación. Acepta macros de usuario y macros LLD. Si se usan, el valor debe ser una sola macro. No se admiten varias macros o macros mezcladas con texto. Los intervalos flexibles pueden escribirse como dos macros separadas por una barra inclinada (por ejemplo, {$FLEX_INTERVAL}/{$FLEX_PERIOD}).Ejemplo: 1h;wd1-5h9-18;{$Macro1}/1-7,00:00-24:00;0/6-7,12:00-24:00;{$Macro2}/{$Macro3}Comportamiento de la propiedad: - requerido si type está establecido en "Agente Zabbix" (0), "Comprobación simple" (3), "Zabbix interno" (5), "Comprobación externa" (10), "Monitor de base de datos" (11), "Agente IPMI" (12), "Agente SSH" (13), "Agente TELNET" (14), "Calculada" (15), "Agente JMX" (16), "Agente HTTP" (19), "Agente SNMP" (20), "Script" (21), "Navegador" (22), o si type está establecido en "Agente Zabbix (activo)" (7) y key_ no contiene "mqtt.get" |
| hostid | ID | ID del equipo al que pertenece el prototipo de métrica. Comportamiento de la propiedad: - constante - requerido para operaciones de creación |
| interfaceid | ID | ID de la interfaz de equipo del prototipo de métrica. Comportamiento de la propiedad: - requerido si el prototipo de métrica pertenece a un equipo y type está establecido en "Agente Zabbix", "Agente IPMI", "Agente JMX", "Trampa SNMP" o "Agente SNMP"- soportado si el prototipo de métrica pertenece a un equipo y type está establecido en "Comprobación simple", "Comprobación externa", "Agente SSH", "Agente TELNET" o "Agente HTTP" |
| key_ | string | Clave del prototipo de métrica. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
| name | string | Nombre del prototipo de métrica. Soporta macros de usuario. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
| type | integer | Tipo del prototipo de métrica. Valores posibles: 0 - Agente Zabbix; 2 - Trapper Zabbix; 3 - Comprobación simple; 5 - Zabbix interno; 7 - Agente Zabbix (activo); 10 - Comprobación externa; 11 - Monitor de base de datos; 12 - Agente IPMI; 13 - Agente SSH; 14 - Agente TELNET; 15 - Calculada; 16 - Agente JMX; 17 - Trampa SNMP; 18 - Métrica dependiente; 19 - Agente HTTP; 20 - Agente SNMP; 21 - Script; 22 - Navegador. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
| url | string | Cadena de URL. Soporta macros LLD, macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {HOST.PORT}, {ITEM.ID}, {ITEM.KEY}. Comportamiento de la propiedad: - requerido si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| value_type | integer | Tipo de información del prototipo de métrica. Valores posibles: 0 - numérico flotante; 1 - carácter; 2 - registro; 3 - numérico sin signo; 4 - texto; 5 - binario. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
| allow_traps | integer | Permitir poblar el valor de manera similar a la métrica trapper. 0 - (por defecto) No permitir aceptar datos entrantes; 1 - Permitir aceptar datos entrantes. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP" |
| authtype | integer | Método de autenticación. Valores posibles si type está establecido en "Agente SSH":0 - (por defecto) contraseña; 1 - clave pública. Valores posibles si type está establecido en "Agente HTTP":0 - (por defecto) ninguno; 1 - básico; 2 - NTLM; 3 - Kerberos. Comportamiento de la propiedad: - soportado si type está establecido en "Agente SSH" o "Agente HTTP"- solo lectura para objetos heredados (si type está establecido en "Agente HTTP") |
| description | string | Descripción del prototipo de métrica. |
| flags | integer | Origen del prototipo de métrica. Valores posibles: 2 - un prototipo de métrica; 6 - un prototipo de métrica descubierto Comportamiento de la propiedad: - solo lectura |
| follow_redirects | integer | Seguir redirecciones de respuesta al sondear datos. Valores posibles: 0 - No seguir redirecciones; 1 - (por defecto) Seguir redirecciones. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| headers | array | Array de cabeceras que se enviarán al realizar una solicitud HTTP. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| history | string | Unidad de tiempo de cuánto tiempo deben almacenarse los datos históricos. También acepta macro de usuario y macro LLD. Por defecto: 31d. |
| http_proxy | string | Cadena de conexión proxy HTTP(S). Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| ipmi_sensor | string | Sensor IPMI. Comportamiento de la propiedad: - requerido si type está establecido en "Agente IPMI" y key_ no está establecido en "ipmi.get"- soportado si type está establecido en "Agente IPMI"- solo lectura para objetos heredados |
| jmx_endpoint | string | Cadena de conexión personalizada del agente JMX. Por defecto: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi Comportamiento de la propiedad: - soportado si type está establecido en "Agente JMX" |
| logtimefmt | string | Formato de la hora en las entradas de registro. Comportamiento de la propiedad: - soportado si value_type está establecido en "registro"- solo lectura para objetos heredados |
| master_itemid | ID | ID de la métrica principal. Comportamiento de la propiedad: - requerido si type está establecido en "Métrica dependiente"- solo lectura para objetos heredados |
| output_format | integer | Si la respuesta debe convertirse a JSON. Valores posibles: 0 - (por defecto) Almacenar sin procesar; 1 - Convertir a JSON. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| params | string | Parámetros adicionales dependiendo del tipo de prototipo de métrica: - script ejecutado para prototipos de métrica de agente SSH y agente TELNET; - consulta SQL para prototipos de métrica de monitor de base de datos; - fórmula para prototipos de métrica calculada; - el script para prototipos de métrica de script y navegador. Comportamiento de la propiedad: - requerido si type está establecido en "Monitor de base de datos", "Agente SSH", "Agente TELNET", "Calculada", "Script" o "Navegador"- solo lectura para objetos heredados (si type está establecido en "Script" o "Navegador") |
| parameters | object/array | Parámetros adicionales si type está establecido en "Script" o "Navegador". Array de objetos con propiedades name y value, donde name debe ser único.Comportamiento de la propiedad: - soportado si type está establecido en "Script" o "Navegador"- solo lectura para objetos heredados |
| password | string | Contraseña para autenticación. Comportamiento de la propiedad: - requerido si type está establecido en "Agente JMX" y username está establecido- soportado si type está establecido en "Comprobación simple", "Agente SSH", "Agente TELNET", "Monitor de base de datos" o "Agente HTTP"- solo lectura para objetos heredados (si type está establecido en "Agente HTTP") |
| post_type | integer | Tipo de cuerpo de datos POST almacenado en la propiedad posts.Valores posibles: 0 - (por defecto) Datos sin procesar. 2 - Datos JSON. 3 - Datos XML. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| posts | string | Datos del cuerpo de la solicitud HTTP(S). Comportamiento de la propiedad: - requerido si type está establecido en "Agente HTTP" y post_type está establecido en "Datos JSON" o "Datos XML"- soportado si type está establecido en "Agente HTTP" y post_type está establecido en "Datos sin procesar"- solo lectura para objetos heredados |
| privatekey | string | Nombre del archivo de clave privada. Comportamiento de la propiedad: - requerido si type está establecido en "Agente SSH" y authtype está establecido en "clave pública" |
| publickey | string | Nombre del archivo de clave pública. Comportamiento de la propiedad: - requerido si type está establecido en "Agente SSH" y authtype está establecido en "clave pública" |
| query_fields | array | Array de campos de consulta que se enviarán al realizar una solicitud HTTP. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| request_method | integer | Tipo de método de solicitud. Valores posibles: 0 - (por defecto) GET; 1 - POST; 2 - PUT; 3 - HEAD. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| retrieve_mode | integer | Qué parte de la respuesta debe almacenarse. Valores posibles si request_method está establecido en "GET", "POST" o "PUT":0 - (por defecto) Cuerpo; 1 - Cabeceras; 2 - Se almacenarán tanto el cuerpo como las cabeceras. Valores posibles si request_method está establecido en "HEAD":1 - Cabeceras. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| snmp_oid | string | OID SNMP. Comportamiento de la propiedad: - requerido si type está establecido en "Agente SNMP"- solo lectura para objetos heredados |
| ssl_cert_file | string | Ruta del archivo de clave pública SSL. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| ssl_key_file | string | Ruta del archivo de clave privada SSL. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| ssl_key_password | string | Contraseña para el archivo de clave SSL. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| status | integer | Estado del prototipo de métrica. Valores posibles: 0 - (por defecto) prototipo de métrica habilitado; 1 - prototipo de métrica deshabilitado; 3 - prototipo de métrica no soportado. |
| status_codes | string | Rangos de códigos de estado HTTP requeridos, separados por comas. También admite macros de usuario o macros LLD como parte de la lista separada por comas. Ejemplo: 200,200-{$M},{$M},200-400 Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| templateid | ID | ID del prototipo de métrica de la plantilla principal. Comportamiento de la propiedad: - solo lectura |
| timeout | string | Tiempo de espera de la solicitud de sondeo de datos de la métrica. Acepta segundos o unidad de tiempo con sufijo (por ejemplo, 30s, 1m). También acepta macros de usuario y macros LLD. Rango de valores posibles: 1-600s. Por defecto: "" - usar configuración de proxy/global. Comportamiento de la propiedad: - soportado si type está establecido en "Agente Zabbix" (0), "Comprobación simple" (3) y key_ no comienza con "vmware." y "icmpping", "Agente Zabbix (activo)" (7), "Comprobación externa" (10), "Monitor de base de datos" (11), "Agente SSH" (13), "Agente TELNET" (14), "Agente HTTP" (19), "Agente SNMP" (20) y snmp_oid comienza con "walk[" o "get[", "Script" (21), "Navegador" (22)- solo lectura para objetos heredados |
| trapper_hosts | string | Equipos permitidos. Comportamiento de la propiedad: - soportado si type está establecido en "Trapper Zabbix", o si type está establecido en "Agente HTTP" y allow_traps está establecido en "Permitir aceptar datos entrantes" |
| trends | string | Unidad de tiempo de cuánto tiempo deben almacenarse los datos de tendencias. También acepta macro de usuario y macro LLD. Por defecto: 365d. Comportamiento de la propiedad: - soportado si value_type está establecido en "numérico flotante" o "numérico sin signo" |
| units | string | Unidades del valor. Comportamiento de la propiedad: - soportado si value_type está establecido en "numérico flotante" o "numérico sin signo"- solo lectura para objetos heredados |
| username | string | Nombre de usuario para autenticación. Comportamiento de la propiedad: - requerido si type está establecido en "Agente SSH" o "Agente TELNET", o si type está establecido en "Agente JMX" y password está establecido- soportado si type está establecido en "Comprobación simple", "Monitor de base de datos" o "Agente HTTP"- solo lectura para objetos heredados (si type está establecido en "Agente HTTP") |
| uuid | string | Identificador único universal, utilizado para vincular prototipos de métrica importados con los ya existentes. Se genera automáticamente si no se proporciona. Comportamiento de la propiedad: - soportado si el prototipo de métrica pertenece a una plantilla |
| valuemapid | ID | ID del mapa de valores asociado. Comportamiento de la propiedad: - soportado si value_type está establecido en "numérico flotante", "carácter" o "numérico sin signo"- solo lectura para objetos heredados |
| verify_host | integer | Si se debe validar que el nombre del equipo para la conexión coincide con el del certificado del equipo. Valores posibles: 0 - (por defecto) No validar; 1 - Validar. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| verify_peer | integer | Si se debe validar que el certificado del equipo es auténtico. Valores posibles: 0 - (por defecto) No validar; 1 - Validar. Comportamiento de la propiedad: - soportado si type está establecido en "Agente HTTP"- solo lectura para objetos heredados |
| discover | integer | Estado de descubrimiento del prototipo de métrica. Valores posibles: 0 - (por defecto) se descubrirán nuevas métricas; 1 - no se descubrirán nuevas métricas y las métricas existentes se marcarán como perdidas. |
Encabezado HTTP
El objeto encabezado tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del encabezado HTTP. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del encabezado. Comportamiento de la propiedad: - obligatorio |
Campo de consulta HTTP
El objeto de campo de consulta define un nombre y un valor que se utilizan para especificar un parámetro de URL. Tiene las siguientes propiedades:
| Propiedad | Tipo | Descripción |
|---|---|---|
| name | string | Nombre del parámetro. Comportamiento de la propiedad: - obligatorio |
| value | string | Valor del parámetro. Comportamiento de la propiedad: - obligatorio |
Etiqueta de prototipo de métrica
El objeto de etiqueta de prototipo de métrica tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| tag | string | Nombre de la etiqueta del prototipo de métrica. Comportamiento de la propiedad: - requerido |
| value | string | Valor de la etiqueta del prototipo de métrica. |
Preprocesamiento de prototipo de métrica
El objeto de preprocesamiento de 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 - En rango; 14 - Coincide con expresión regular; 15 - No coincide con expresión regular; 16 - Comprobar error en JSON; 17 - Comprobar error en XML; 18 - Comprobar error usando expresión regular; 19 - Descartar sin cambios; 20 - Descartar sin cambios con latido; 21 - JavaScript; 22 - Patrón Prometheus; 23 - Prometheus a JSON; 24 - CSV a JSON; 25 - Reemplazar; 26 - Comprobar no soportado; 27 - XML a JSON; 28 - Valor SNMP walk; 29 - SNMP walk a JSON; 30 - Valor SNMP get. Comportamiento de la propiedad: - requerido |
| params | string | Parámetros adicionales utilizados por la opción de preprocesamiento. Múltiples parámetros se separan por el carácter de nueva línea (\n). Si type se establece en "Comprobar no soportado", los parámetros siguen una sintaxis <scope>[\n<pattern>], donde pattern es una expresión regular y scope es uno de:-1 - coincide con cualquier error; 0 - comprobar si el mensaje de error coincide con pattern; 1 - comprobar si el mensaje de error no coincide con pattern. Comportamiento de la propiedad: - requerido si type se establece en "Multiplicador personalizado" (1), "Recorte derecho" (2), "Recorte izquierdo" (3), "Recorte" (4), "Expresión regular" (5), "XML XPath" (11), "JSONPath" (12), "En rango" (13), "Coincide con expresión regular" (14), "No coincide con expresión regular" (15), "Comprobar error en JSON" (16), "Comprobar error en XML" (17), "Comprobar error usando expresión regular" (18), "Descartar sin cambios con latido" (20), "JavaScript" (21), "Patrón Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Reemplazar" (25), "Comprobar no soportado" (26), "Valor SNMP walk" (28), "SNMP walk a JSON" (29), o "Valor SNMP get" (30) |
| error_handler | integer | Tipo de acción utilizada en caso de fallo en el paso de preprocesamiento. Valores posibles: 0 - El mensaje de error es establecido por el servidor Zabbix; 1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Valores posibles si type se establece en "Comprobar no soportado":1 - Descartar valor; 2 - Establecer valor personalizado; 3 - Establecer mensaje de error personalizado. Comportamiento de la propiedad: - requerido si type se establece 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), "En rango" (13), "Coincide con expresión regular" (14), "No coincide con expresión regular" (15), "Comprobar error en JSON" (16), "Comprobar error en XML" (17), "Comprobar error usando expresión regular" (18), "Patrón Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Comprobar no soportado" (26), "XML a JSON" (27), "Valor SNMP walk" (28), "SNMP walk a JSON" (29), o "Valor SNMP get" (30) |
| error_handler_params | string | Parámetros del gestor de errores. Comportamiento de la propiedad: - requerido si error_handler se establece en "Establecer valor personalizado" o "Establecer mensaje de error personalizado" |
Los siguientes parámetros y gestores de errores son compatibles para cada tipo de preprocesamiento.
| Tipo de preprocesamiento | Nombre | Parámetro 1 | Parámetro 2 | Parámetro 3 | Gestores de errores soportados |
|---|---|---|---|---|---|
| 1 | Multiplicador personalizado | número1, 6 | 0, 1, 2, 3 | ||
| 2 | Recorte derecho | lista de caracteres2 | |||
| 3 | Recorte izquierdo | lista de caracteres2 | |||
| 4 | Recorte | 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 rango | min1, 6 | max1, 6 | 0, 1, 2, 3 | |
| 14 | Coincide con expresión regular | patrón3 | 0, 1, 2, 3 | ||
| 15 | No coincide con expresión regular | patrón3 | 0, 1, 2, 3 | ||
| 16 | Comprobar error en JSON | ruta4 | 0, 1, 2, 3 | ||
| 17 | Comprobar error en XML | ruta4 | 0, 1, 2, 3 | ||
| 18 | Comprobar error usando expresión regular | patrón3 | salida2 | 0, 1, 2, 3 | |
| 19 | Descartar sin cambios | ||||
| 20 | Descartar sin cambios con latido | segundos5, 6 | |||
| 21 | JavaScript | script2 | |||
| 22 | Patrón Prometheus | patrón6, 7 | value, label, function |
salida8, 9 | 0, 1, 2, 3 |
| 23 | Prometheus 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 | Comprobar no soportado | scope1 | patrón3, 6 | 1, 2, 3 | |
| 27 | XML a JSON | 0, 1, 2, 3 | |||
| 28 | Valor SNMP walk | OID2 | Formato: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | |
| 29 | SNMP walk a JSON10 | Nombre de campo2 | Prefijo OID2 | Formato: 0 - Sin cambios 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 |
| 30 | Valor SNMP get | Formato: 1 - UTF-8 desde Hex-STRING 2 - MAC desde Hex-STRING 3 - Entero desde BITS |
0, 1, 2, 3 | ||
1 número entero o de punto flotante
2 cadena
3 expresión regular
4 JSONPath o XML XPath
5 número entero positivo (con soporte de sufijos de tiempo, por ejemplo, 30s, 1m, 2h, 1d)
6 macro de usuario, macro LLD
7 Patrón 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 valor de métrica) puede ser macro de usuario o macro LLD.
8 Salida Prometheus siguiendo la sintaxis: <nombre de etiqueta> (puede ser una macro de usuario o una macro LLD) si se selecciona label como segundo parámetro.
9 Una de las funciones de agregación: sum, min, max, avg, count si se selecciona function como segundo parámetro.
10 Soporta múltiples registros "Nombre de campo,Prefijo OID,Formato" delimitados por un carácter de nueva línea.