Objeto prototipo de métrica

Los siguientes objetos están directamente relacionados con la API itemprototype.

Prototipo de item

El objeto prototipo de item tiene las siguientes propiedades.

Property Type Description
itemid ID ID del prototipo de item.

Property behavior:
- solo lectura
- obligatorio para operaciones de actualización
delay string Intervalo de actualización del prototipo de item.

Acepta segundos o una 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 combinación de intervalos flexibles y de programación.

Acepta macros de usuario y macros LLD. Si se usa, el valor debe ser una sola macro. No se admiten varias macros ni macros mezcladas con texto. Los intervalos flexibles pueden escribirse como dos macros separadas por una barra diagonal (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}

Property behavior:
- obligatorio si type está establecido en "Zabbix agent" (0), "Simple check" (3), "Zabbix internal" (5), "External check" (10), "Database monitor" (11), "IPMI agent" (12), "SSH agent" (13), "TELNET agent" (14), "Calculated" (15), "JMX agent" (16), "HTTP agent" (19), "SNMP agent" (20), "Script" (21), "Browser" (22), o si type está establecido en "Zabbix agent (active)" (7) y key_ no contiene "mqtt.get"
hostid ID ID del host al que pertenece el prototipo de item.

Property behavior:
- constante
- obligatorio para operaciones de creación
interfaceid ID ID de la interfaz de host del prototipo de item.

Property behavior:
- obligatorio si el prototipo de item pertenece a un host y type está establecido en "Zabbix agent", "IPMI agent", "JMX agent", "SNMP trap", o "SNMP agent"
- compatible si el prototipo de item pertenece a un host y type está establecido en "Simple check", "External check", "SSH agent", "TELNET agent", o "HTTP agent"
key_ string Clave del prototipo de item.

Property behavior:
- obligatorio para operaciones de creación
- solo lectura para objetos heredados
name string Nombre del prototipo de item.
Admite macros de usuario.

Property behavior:
- obligatorio para operaciones de creación
- solo lectura para objetos heredados
type integer Tipo del prototipo de item.

Valores posibles:
0 - Zabbix agent;
2 - Zabbix trapper;
3 - Simple check;
5 - Zabbix internal;
7 - Zabbix agent (active);
10 - External check;
11 - Database monitor;
12 - IPMI agent;
13 - SSH agent;
14 - TELNET agent;
15 - Calculated;
16 - JMX agent;
17 - SNMP trap;
18 - Dependent item;
19 - HTTP agent;
20 - SNMP agent;
21 - Script;
22 - Browser.

Property behavior:
- obligatorio para operaciones de creación
- solo lectura para objetos heredados
url string Cadena de URL.
Admite macros LLD, macros de usuario, {HOST.IP}, {HOST.CONN}, {HOST.DNS}, {HOST.HOST}, {HOST.NAME}, {ITEM.ID}, {ITEM.KEY}.

Property behavior:
- obligatorio si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
value_type integer Tipo de información del prototipo de item.

Valores posibles:
0 - numérico flotante;
1 - carácter;
2 - log;
3 - numérico sin signo;
4 - texto;
5 - binario.

Property behavior:
- obligatorio para operaciones de creación
- solo lectura para objetos heredados
allow_traps integer Permite poblar el valor de forma similar al item trapper.

0 - (predeterminado) No permitir aceptar datos entrantes;
1 - Permitir aceptar datos entrantes.

Property behavior:
- compatible si type está establecido en "HTTP agent"
authtype integer Método de autenticación.

Valores posibles si type está establecido en "SSH agent":
0 - (predeterminado) contraseña;
1 - clave pública.

Valores posibles si type está establecido en "HTTP agent":
0 - (predeterminado) ninguno;
1 - basic;
2 - NTLM;
3 - Kerberos;
4 - Digest.

Property behavior:
- compatible si type está establecido en "SSH agent" o "HTTP agent"
- solo lectura para objetos heredados (si type está establecido en "HTTP agent")
description string Descripción del prototipo de item.
follow_redirects integer Seguir redirecciones de la respuesta mientras se consultan los datos.

Valores posibles:
0 - No seguir redirecciones;
1 - (predeterminado) Seguir redirecciones.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
headers array Matriz de headers que se enviarán al realizar una solicitud HTTP.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
history string Unidad de tiempo durante la cual deben almacenarse los datos históricos.
También acepta macro de usuario y macro LLD.

Predeterminado: 31d.
http_proxy string Cadena de conexión del proxy HTTP(S).

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
ipmi_sensor string Sensor IPMI.

Property behavior:
- obligatorio si type está establecido en "IPMI agent" y key_ no está establecido en "ipmi.get"
- compatible si type está establecido en "IPMI agent"
- solo lectura para objetos heredados
jmx_endpoint string Cadena de conexión personalizada del agent JMX.

Predeterminado: service:jmx:rmi:///jndi/rmi://{HOST.CONN}:{HOST.PORT}/jmxrmi

Property behavior:
- compatible si type está establecido en "JMX agent"
logtimefmt string Formato de la hora en las entradas de log.

Property behavior:
- compatible si value_type está establecido en "log"
- solo lectura para objetos heredados
master_itemid ID ID del item maestro.
Se permite recursión de hasta 3 items dependientes y prototipos de item, y un número máximo de items dependientes y prototipos de item igual a 29999.

Property behavior:
- obligatorio si type está establecido en "Dependent item"
- solo lectura para objetos heredados
output_format integer Indica si la respuesta debe convertirse a JSON.

Valores posibles:
0 - (predeterminado) Almacenar sin procesar;
1 - Convertir a JSON.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
params string Parámetros adicionales según el tipo del prototipo de item:
- script ejecutado para prototipos de item SSH agent y TELNET agent;
- consulta SQL para prototipos de item database monitor;
- fórmula para prototipos de item calculados;
- el script para prototipos de item script y browser.

Property behavior:
- obligatorio si type está establecido en "Database monitor", "SSH agent", "TELNET agent", "Calculated", "Script", o "Browser"
- solo lectura para objetos heredados (si type está establecido en "Script" o "Browser")
parameters object/array Parámetros adicionales si type está establecido en "Script" o "Browser". Matriz de objetos con propiedades name y value, donde name debe ser único.

Property behavior:
- compatible si type está establecido en "Script" o "Browser"
- solo lectura para objetos heredados
password string Contraseña para la autenticación.

Property behavior:
- obligatorio si type está establecido en "JMX agent" y username está establecido
- compatible si type está establecido en "Simple check", "SSH agent", "TELNET agent", "Database monitor", o "HTTP agent"
- solo lectura para objetos heredados (si type está establecido en "HTTP agent")
post_type integer Tipo del cuerpo de datos de post almacenado en la propiedad posts.

Valores posibles:
0 - (predeterminado) Datos sin procesar.
2 - Datos JSON.
3 - Datos XML.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
posts string Datos del cuerpo de la solicitud HTTP(S).

Property behavior:
- obligatorio si type está establecido en "HTTP agent" y post_type está establecido en "JSON data" o "XML data"
- compatible si type está establecido en "HTTP agent" y post_type está establecido en "Raw data"
- solo lectura para objetos heredados
privatekey string Nombre del archivo de clave privada.

Property behavior:
- obligatorio si type está establecido en "SSH agent" y authtype está establecido en "public key"
publickey string Nombre del archivo de clave pública.

Property behavior:
- obligatorio si type está establecido en "SSH agent" y authtype está establecido en "public key"
query_fields array Matriz de query fields que se enviarán al realizar una solicitud HTTP.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
request_method integer Tipo de método de solicitud.

Valores posibles:
0 - (predeterminado) GET;
1 - POST;
2 - PUT;
3 - HEAD.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- 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 - (predeterminado) Cuerpo;
1 - Headers;
2 - Se almacenarán tanto el cuerpo como los headers.

Valores posibles si request_method está establecido en "HEAD":
1 - Headers.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
snmp_oid string OID SNMP.

Property behavior:
- obligatorio si type está establecido en "SNMP agent"
- solo lectura para objetos heredados
ssl_cert_file string Ruta del archivo de clave SSL pública.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
ssl_key_file string Ruta del archivo de clave SSL privada.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
ssl_key_password string Contraseña para el archivo de clave SSL.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
status integer Estado del prototipo de item.

Valores posibles:
0 - (predeterminado) prototipo de item habilitado;
1 - prototipo de item deshabilitado;
3 - prototipo de item no compatible.
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 una lista separada por comas.

Ejemplo: 200,200-{$M},{$M},200-400

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
templateid ID ID del prototipo de item de la template principal.

Property behavior:
- solo lectura
timeout string Tiempo de espera de la solicitud de sondeo de datos del item.
Acepta segundos o una unidad de tiempo con sufijo (por ejemplo, 30s, 1m). También acepta macros de usuario y macros LLD.

Rango de valores posibles: 1-600s.

Predeterminado: "" - usar configuración de proxy/global.

Property behavior:
- compatible si type está establecido en "Zabbix agent" (0), "Simple check" (3) y key_ no comienza con "vmware." ni "icmpping", "Zabbix agent (active)" (7), "External check" (10), "Database monitor" (11), "SSH agent" (13), "TELNET agent" (14), "HTTP agent" (19), "SNMP agent" (20) y snmp_oid comienza con "walk[" o "get[", "Script" (21), "Browser" (22)
- solo lectura para objetos heredados
trapper_hosts string Hosts permitidos.

Property behavior:
- compatible si type está establecido en "Zabbix trapper", o si type está establecido en "HTTP agent" y allow_traps está establecido en "Permitir aceptar datos entrantes"
trends string Unidad de tiempo durante la cual deben almacenarse los datos de tendencias.
También acepta macro de usuario y macro LLD.

Predeterminado: 365d.

Property behavior:
- compatible si value_type está establecido en "numeric float" o "numeric unsigned"
units string Unidades del valor.

Property behavior:
- compatible si value_type está establecido en "numeric float" o "numeric unsigned"
- solo lectura para objetos heredados
username string Nombre de usuario para la autenticación.

Property behavior:
- obligatorio si type está establecido en "SSH agent" o "TELNET agent", o si type está establecido en "JMX agent" y password está establecido
- compatible si type está establecido en "Simple check", "Database monitor", o "HTTP agent"
- solo lectura para objetos heredados (si type está establecido en "HTTP agent")
uuid string Identificador único universal, usado para vincular prototipos de item importados con los ya existentes. Se genera automáticamente si no se proporciona.

Property behavior:
- compatible si el prototipo de item pertenece a una template
valuemapid ID ID del mapa de valores asociado.

Property behavior:
- compatible si value_type está establecido en "numeric float", "character", o "numeric unsigned"
- solo lectura para objetos heredados
verify_host integer Si se debe validar que el nombre de host de la conexión coincida con el del certificado del host.

Valores posibles:
0 - (predeterminado) No validar;
1 - Validar.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
verify_peer integer Si se debe validar que el certificado del host sea auténtico.

Valores posibles:
0 - (predeterminado) No validar;
1 - Validar.

Property behavior:
- compatible si type está establecido en "HTTP agent"
- solo lectura para objetos heredados
discover integer Estado de descubrimiento del prototipo de item.

Valores posibles:
0 - (predeterminado) se descubrirán nuevos items;
1 - no se descubrirán nuevos items y los items existentes se marcarán como perdidos.

Encabezado HTTP

El objeto header 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 del prototipo de item

El objeto de etiqueta del prototipo de item tiene las siguientes propiedades.

Property Type Description
tag string Nombre de la etiqueta del prototipo de item.

Property behavior:
- required
value string Valor de la etiqueta del prototipo de item.

Preprocesamiento del prototipo de item

El objeto de preprocesamiento del prototipo de item tiene las siguientes propiedades.

Property Type Description
type integer El tipo de opción de preprocesamiento.

Valores posibles:
1 - Multiplicador personalizado;
2 - Recorte por la derecha;
3 - Recorte por la izquierda;
4 - Recortar;
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 mediante expresión regular;
19 - Descartar sin cambios;
20 - Descartar sin cambios con heartbeat;
21 - JavaScript;
22 - Patrón de Prometheus;
23 - Prometheus a JSON;
24 - CSV a JSON;
25 - Reemplazar;
26 - Comprobar no compatible;
27 - XML a JSON;
28 - Valor de recorrido SNMP;
29 - Recorrido SNMP a JSON;
30 - Obtener valor SNMP.

Property behavior:
- required
params string Parámetros adicionales usados por la opción de preprocesamiento.
Los múltiples parámetros se separan mediante el carácter de nueva línea (\n).

Si type está establecido en "Check unsupported", los parámetros siguen la sintaxis <scope>[\n<pattern>], donde pattern es una expresión regular y scope es uno de los siguientes:
-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.

Property behavior:
- required si type está establecido en "Custom multiplier" (1), "Right trim" (2), "Left trim" (3), "Trim" (4), "Regular expression" (5), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Discard unchanged with heartbeat" (20), "JavaScript" (21), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Replace" (25), "Check unsupported" (26), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)
error_handler integer Tipo de acción usado en caso de fallo del paso de preprocesamiento.

Valores posibles:
0 - El mensaje de error lo establece Zabbix server;
1 - Descartar valor;
2 - Establecer valor personalizado;
3 - Establecer mensaje de error personalizado.

Valores posibles si type está establecido en "Check unsupported":
1 - Descartar valor;
2 - Establecer valor personalizado;
3 - Establecer mensaje de error personalizado.

Property behavior:
- required si type está establecido en "Custom multiplier" (1), "Regular expression" (5), "Boolean to decimal" (6), "Octal to decimal" (7), "Hexadecimal to decimal" (8), "Simple change" (9), "Change per second" (10), "XML XPath" (11), "JSONPath" (12), "In range" (13), "Matches regular expression" (14), "Does not match regular expression" (15), "Check for error in JSON" (16), "Check for error in XML" (17), "Check for error using regular expression" (18), "Prometheus pattern" (22), "Prometheus to JSON" (23), "CSV to JSON" (24), "Check unsupported" (26), "XML to JSON" (27), "SNMP walk value" (28), "SNMP walk to JSON" (29), or "SNMP get value" (30)
error_handler_params string Parámetros del controlador de errores.

Property behavior:
- required si error_handler está establecido en "Set custom value" o "Set custom error message"

Se admiten los siguientes parámetros y controladores de errores para cada tipo de preprocesamiento.

Preprocessing type Name Parameter 1 Parameter 2 Parameter 3 Supported error handlers
1 Multiplicador personalizado number1, 6 0, 1, 2, 3
2 Recorte por la derecha list of characters2
3 Recorte por la izquierda list of characters2
4 Recortar list of characters2
5 Expresión regular pattern3 output2 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 path4 0, 1, 2, 3
12 JSONPath path4 0, 1, 2, 3
13 En rango min1, 6 max1, 6 0, 1, 2, 3
14 Coincide con expresión regular pattern3 0, 1, 2, 3
15 No coincide con expresión regular pattern3 0, 1, 2, 3
16 Comprobar error en JSON path4 0, 1, 2, 3
17 Comprobar error en XML path4 0, 1, 2, 3
18 Comprobar error mediante expresión regular pattern3 output2 0, 1, 2, 3
19 Descartar sin cambios
20 Descartar sin cambios con heartbeat seconds5, 6
21 JavaScript script2
22 Patrón de Prometheus pattern6, 7 value, label, function output8, 9 0, 1, 2, 3
23 Prometheus a JSON pattern6, 7 0, 1, 2, 3
24 CSV a JSON character2 character2 0,1 0, 1, 2, 3
25 Reemplazar search string2 replacement2
26 Comprobar no compatible scope1 pattern3, 6 1, 2, 3
27 XML a JSON 0, 1, 2, 3
28 Valor de recorrido SNMP OID2 Format:
0 - Sin cambios
1 - UTF-8 desde Hex-STRING
2 - MAC desde Hex-STRING
3 - Entero desde BITS		 0, 1, 2, 3
29 Recorrido SNMP a JSON10 Field name2 OID prefix2 Format:
0 - Sin cambios
1 - UTF-8 desde Hex-STRING
2 - MAC desde Hex-STRING
3 - Entero desde BITS		 0, 1, 2, 3
30 Obtener valor SNMP Format:
1 - UTF-8 desde Hex-STRING
2 - MAC desde Hex-STRING
3 - Entero desde BITS		 0, 1, 2, 3

1 integer or floating-point number
2 string
3 regular expression
4 JSONPath or XML XPath
5 positive integer (with support of time suffixes, e.g. 30s, 1m, 2h, 1d)
6 user macro, LLD macro
7 Prometheus pattern following the syntax: <metric name>{<label name>="<label value>", ...} == <value>. Each Prometheus pattern component (metric, label name, label value and metric value) can be user macro or LLD macro.
8 Prometheus output following the syntax: <label name> (can be a user macro or an LLD macro) if label is selected as the second parameter.
9 One of the aggregation functions: sum, min, max, avg, count if function is selected as the second parameter.
10 Supports multiple "Field name,OID prefix,Format records" records delimited by a new line character.