Los siguientes objetos están directamente relacionados con la API itemprototype
.
El objeto prototipo de elemento tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
itemid | ID | ID del prototipo de elemento. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
delay | string | Intervalo de actualización del prototipo de elemento. 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), "Interno de Zabbix" (5), "Comprobació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), "Navegador" (22), o si type está establecido en "Agente Zabbix (activo)" (7) y key_ no contiene "mqtt.get" |
hostid | ID | ID del host al que pertenece el prototipo de elemento. Comportamiento de la propiedad: - constante - requerido para operaciones de creación |
interfaceid | ID | ID de la interfaz de host del prototipo de elemento. Comportamiento de la propiedad: - requerido si el prototipo de elemento pertenece a un host y type está establecido en "Agente Zabbix", "Agente IPMI", "Agente JMX", "Trampa SNMP" o "Agente SNMP"- soportado si el prototipo de elemento pertenece a un host y type está establecido en "Comprobación simple", "Comprobación externa", "Agente SSH", "Agente TELNET" o "Agente HTTP" |
key_ | string | Clave del prototipo de elemento. Comportamiento de la propiedad: - requerido para operaciones de creación - solo lectura para objetos heredados |
name | string | Nombre del prototipo de elemento. 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 elemento. Valores posibles: 0 - Agente Zabbix; 2 - Trapper de Zabbix; 3 - Comprobación simple; 5 - Interno de Zabbix; 7 - Agente Zabbix (activo); 10 - Comprobación externa; 11 - Monitor de base de datos; 12 - Agente IPMI; 13 - Agente SSH; 14 - Agente TELNET; 15 - Calculado; 16 - Agente JMX; 17 - Trampa SNMP; 18 - Elemento 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 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 elemento. 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 al elemento 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 elemento. |
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 durante la cual se deben almacenar 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 del elemento maestro. Comportamiento de la propiedad: - requerido si type está establecido en "Elemento 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 elemento: - script ejecutado para prototipos de elemento de agente SSH y agente TELNET; - consulta SQL para prototipos de elemento de monitor de base de datos; - fórmula para prototipos de elemento calculado; - el script para prototipos de elemento de script y navegador. Comportamiento de la propiedad: - requerido si type está establecido en "Monitor de base de datos", "Agente SSH", "Agente TELNET", "Calculado", "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 elemento. Valores posibles: 0 - (por defecto) prototipo de elemento habilitado; 1 - prototipo de elemento deshabilitado; 3 - prototipo de elemento 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 elemento de la plantilla principal. Comportamiento de la propiedad: - solo lectura |
timeout | string | Tiempo de espera de la solicitud de sondeo de datos del elemento. 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. " ni "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 | Hosts permitidos. Comportamiento de la propiedad: - soportado si type está establecido en "Trapper de Zabbix", o si type está establecido en "Agente HTTP" y allow_traps está establecido en "Permitir aceptar datos entrantes" |
trends | string | Unidad de tiempo durante la cual se deben almacenar 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 elementos importados a los ya existentes. Se genera automáticamente si no se proporciona. Comportamiento de la propiedad: - soportado si el prototipo de elemento 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 host para la conexión coincide con el del certificado del host. 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 host 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 elemento. Valores posibles: 0 - (por defecto) se descubrirán nuevos elementos; 1 - no se descubrirán nuevos elementos y los elementos existentes se marcarán como perdidos. |
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 |
El objeto 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 |
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 | entero | 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; 30 - Obtener valor SNMP. Comportamiento de la propiedad: - obligatorio |
params | cadena | 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), "SNMP walk a JSON" (29 ), o "Obtener valor SNMP" (30) |
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 type 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), "SNMP walk a JSON" (29), o "Obtener valor SNMP" (30) |
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 type está configurado en "Comprobación no admitida":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 Prometheus" (22), "Prometheus a JSON" (23), "CSV a JSON" (24), "Verificar no compatible" (26), "XML a JSON" (27), "Valor de recorrido SNMP" (28), "Recorrido SNMP a JSON" (29), o "obtener valor SNMP" (30) |
error_handler_params | cadena | Parámetros del controlador de errores. Comportamiento de la propiedad: - * requerido* 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| |30|Obtener valor SNMP|Formato:
1 - UTF-8 from Hex-STRING
2 - MAC from Hex-STRING
3 - Integer from 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.