Documentation
Table of Contents
Objeto de acción
Los siguientes objetos están directamente relacionados con la API action.
Acción
El objeto de acción tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| actionid | ID | ID de la acción. Comportamiento de la propiedad: - solo lectura - obligatorio para operaciones de actualización |
| esc_period | cadena | Duración predeterminada del paso de operación. Debe durar al menos 60 segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario. Comportamiento de la propiedad: - compatible si eventsource está configurado en "evento creado por un iniciador", "evento interno" o "evento creado en la actualización del estado del servicio" |
| eventsource | entero | Tipo de eventos que manejará la acción. Consulte la propiedad source del evento para obtener una lista de eventos admitidos tipos.Comportamiento de la propiedad: - constante - obligatorio para operaciones de creación |
| name | cadena | Nombre de la acción. Comportamiento de la propiedad: - obligatorio para operaciones de creación |
| status | entero | Si la acción está habilitada o deshabilitada. Valores posibles: 0 - (predeterminado) habilitado; 1 - deshabilitado. |
| pause_symptoms | integer | Si se debe pausar la escalada si el evento es un síntoma. Valores posibles: 0 - No pausar la escalada por problemas de síntomas; 1 - (predeterminado) Pausar la escalada para problemas de síntomas. Comportamiento de la propiedad: - compatible si eventsource está configurado en "evento creado por un iniciador " |
| pause_suppressed | entero | Si pausar la escalada durante los períodos de mantenimiento o no. Valores posibles: 0 - No pausar la escalada; 1 - (predeterminado) Pausar la escalada. Comportamiento de la propiedad: - compatible si eventsource está configurado en "evento creado por un iniciador" |
| notify_if_canceled | entero | Si notificar cuando se cancela el escalado. Valores posibles: 0 - No notificar cuando se cancela el escalado; 1 - (predeterminado) Notificar cuando se cancela la escalada. Comportamiento de la propiedad: - compatible si eventsource está configurado en "evento creado por un iniciador" |
Operación de acción
El objeto de operación de acción define una operación que se realizará cuando se ejecuta una acción. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | entero | Tipo de operación. Valores posibles: 0 - enviar mensaje; 1 - script global; 2 - agregar equipo; 3 - eliminar equipo; 4 - agregar al grupo de equipos; 5 - eliminar del grupo de equipos; 6 - vincular a la plantilla; 7 - desvincular de la plantilla; 8 - habilitar el equipo; 9 - deshabilitar el equipo; 10 - configurar el modo de inventario del equipo. 13 - añadir etiquetas de equipo; 14 - eliminar etiquetas de equipo. Valores posibles si eventsource de objeto de acción está configurado en "evento creado por un iniciador" o "evento creado en actualización del estado del servicio":0 - "enviar mensaje"; 1 - "script global". Valores posibles si eventsource de objeto de acción está configurado en " evento interno":0 - "enviar mensaje". Comportamiento de la propiedad: - obligatorio |
| esc_period | cadena | Duración de un paso de escalada en segundos. Debe ser mayor a 60 segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario. Si se establece en 0 o 0s, se utilizará el período de escalada de acciones predeterminado. Predeterminado: 0. Comportamiento de la propiedad:< br>- compatible si eventsource de objeto de acción está configurado en "evento creado por un iniciador", "evento interno" o "evento creado en la actualización del estado del servicio" |
| esc_step_from | entero | Paso desde el que iniciar el escalado. Predeterminado: 1. Comportamiento de la propiedad:<br >- compatible si eventsource de objeto de acción está configurado en "evento creado por un iniciador", "evento interno" o "evento creado en la actualización del estado del servicio" |
| esc_step_to | entero | Paso para finalizar el escalado en. Predeterminado: 1. Comportamiento de la propiedad:<br >- compatible si eventsource de objeto de acción está configurado en "evento creado por un iniciador", "evento interno" o "evento creado en la actualización del estado del servicio" |
| evaltype | entero | Método de evaluación de la condición de operación. Valores posibles: 0 - (predeterminado) AND / OR; 1 - AND; 2 - OR. |
| opcommand | objeto | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad : - obligatorio si tipo de operación está configurado en "script global" |
| opcommand_grp | matriz | Grupos de equipos para ejecutar scripts globales. Los grupos de equipos deben tener la propiedad groupid definida.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "script global" y opcommand_hst no está configurado |
| opcommand_hst | matriz | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "script global" y opcommand_grp no está configurado |
| opconditions | matriz | Condiciones de operación utilizadas para acciones de activación. El objeto de condición de operación se describe en detalle a continuación. |
| opgroup | array | Grupos de equipos a los que agregar equipos. Los grupos de equipos deben tener la propiedad groupid definida.Comportamiento de la propiedad: - obligatorio si tipo de operación está configurado en "agregar al grupo de equipos" o "eliminar del grupo de equipos" |
| opmessage | objeto | Objeto que contiene los datos sobre el mensaje enviado por la operación. El objeto del mensaje de operación se describe en detalle a continuación.< br> Comportamiento de la propiedad: - obligatorio si tipo de operación está configurado en "enviar mensaje" |
| opmessage_grp | matriz | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener la propiedad usrgrpid definida.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_usr no está configurado |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_grp no está configurado |
| optemplate | matriz | Plantillas para vincular los equipos. Las plantillas deben tener definida la propiedad templateid.Comportamiento de la propiedad: - obligatorio si tipo de operación está configurado en "vincular a plantilla" o "desvincular de plantilla" |
| opinventory | objeto | Modo de inventario configurado como equipo. El inventario debe tener definida la propiedad inventory_mode.Comportamiento de la propiedad : - obligatorio si tipo de operación está configurado en "establecer modo de inventario de equipo" |
| optag | matriz | Etiquetas de equipo a añadir o eliminar. Las etiquetas deben tener definida una propiedad tag.La propiedad value es opcional. Comportamiento de la propiedad: - soportada si operationtype está configurada como "add host tags" o "remove host tags". |
Mensaje de operación de acción
El objeto de mensaje de operación contiene datos sobre el mensaje que será enviado por la operación. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| default_msg | entero | Si se debe usar el texto y el asunto del mensaje de acción predeterminado. Valores posibles: 0 - usa los datos de la operación; 1 - (predeterminado) usa los datos del tipo de medio. |
| mediatypeid | ID | ID del tipo de medio que se utilizará para enviar el mensaje. Comportamiento de la propiedad: - compatible si operationtype de Objeto de operación de acción, Objeto de operación de recuperación de acción o Objeto de operación de actualización de acción está configurado en "enviar mensaje", o si operationtype de objeto de operación de actualización de acción está configurado para "notificar a todos los involucrados" |
| message | cadena | Texto del mensaje de operación. Comportamiento de la propiedad: - soportada si default_msg está configurado para "usar los datos de la operación" |
| subject | cadena | Asunto del mensaje de operación. Comportamiento de la propiedad: - soportada si default_msg está configurado para "usar los datos de la operación" |
Condición de operación de acción
El objeto de condición de operación de acción define una condición que debe cumplirse para realizar la operación actual. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| conditiontype | entero | Tipo de condición. Valores posibles: 14 - evento reconocido. Comportamiento de la propiedad:< br>- obligatorio |
| value | cadena | Valor con el que comparar. Comportamiento de la propiedad: - obligatorio |
| operator | entero | Operador de condición. Valores posibles: 0 - (predeterminado) = |
Se admiten los siguientes operadores y valores para cada operación tipo de condición.
| Condición | Nombre de la condición | Operadores admitidos | Valor esperado |
|---|---|---|---|
| 14 | Evento reconocido | = | Si se reconoce el evento. Valores posibles: 0 - no reconocido; 1 - reconocido. |
Operación de recuperación de acción
El objeto de operación de recuperación de acción define una operación que se realizará cuando se resuelva un problema. Las operaciones de recuperación son posibles sólo para acciones de activación, internas y de servicio. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | entero | Tipo de operación. Valores posibles si eventsource de objeto de acción está configurado en "evento creado por un iniciador" o "evento creado en la actualización del estado del servicio": 0 - enviar mensaje; 1 - script global; 11 - notificar a todos los involucrados. Valores posibles si eventsource de objeto de acción está configurado en " evento interno":0 - enviar mensaje; 11 - notificar a todos los involucrados. Comportamiento de la propiedad: - obligatorio |
| opcommand | objeto | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad : - obligatorio si tipo de operación está configurado en "script global" |
| opcommand_grp | array | Grupos de equipos para ejecutar scripts globales. Los grupos de equipos deben tener la propiedad groupid definida.Comportamiento de la propiedad: - obligatorio si eventsource de objeto de acción está configurado en "evento creado por un iniciador" y operationtype está configurado en "script global", y opcommand_hst no está configurado |
| opcommand_hst | array | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - obligatorio si eventsource de objeto de acción está configurado en "evento creado por un iniciador" y operationtype está configurado en "script global" y opcommand_grp no está configurado |
| opmessage | objeto | Objeto que contiene los datos sobre el mensaje enviado por la operación de recuperación. El objeto del mensaje de operación es descrito en detalle arriba. Comportamiento de la propiedad: - obligatorio si tipo de operación está configurado en "enviar mensaje" |
| opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener la propiedad usrgrpid definida.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_usr no está configurado |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_grp no está configurado |
Operación de actualización de acción
El objeto de operación de actualización de la acción define una operación que se realizará cuando se actualice un problema (comentado, reconocido, cambiado de gravedad o cerrado manualmente). Las operaciones de actualización son posibles sólo para acciones de iniciador y servicio. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | entero | Tipo de operación. Valores posibles: 0 - enviar mensaje; 1 - script global; 12 - notificar a todos los involucrados. Comportamiento de la propiedad: - obligatorio |
| opcommand | objeto | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad : - obligatorio si tipo de operación está configurado en "script global" |
| opcommand_grp | array | Grupos de equipos para ejecutar scripts globales. Los grupos de equipos deben tener la propiedad groupid definida.Comportamiento de la propiedad: - obligatorio si eventsource de objeto de acción está configurado en "evento creado por un iniciador" y operationtype está configurado en "script global", y opcommand_hst no está configurado |
| opcommand_hst | array | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - obligatorio si eventsource de objeto de acción está configurado en "evento creado por un desencadenador" y operationtype está configurado en "script global" y opcommand_grp no está configurado |
| opmessage | objeto | Objeto que contiene los datos sobre el mensaje enviado por la operación de actualización. El objeto del mensaje de operación es descrito en detalle arriba. |
| opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener la propiedad usrgrpid definida.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_usr no está configurado |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - obligatorio si operationtype está configurado en "enviar mensaje" y opmessage_grp no está configurado |
Filtro de acción
El objeto de filtro de acción define un conjunto de condiciones que deben cumplirse para realizar las operaciones de acción configuradas. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| conditions | matriz | Conjunto de condiciones de filtro que se usarán para filtrar resultados. Comportamiento de la propiedad: - obligatorio |
| evaltype | entero | Método de evaluación de la condición del filtro. Valores posibles: 0 - y/o; 1 - y; 2 - o; 3 - expresión personalizada. Comportamiento de la propiedad: - obligatorio |
| eval_formula | cadena | Expresión generada que se utilizará para evaluar las condiciones del filtro. La expresión contiene ID que hacen referencia a condiciones de filtro específicas mediante su formulaid. El valor de eval_formula es igual al valor de formula para filtros con una expresión personalizada.Comportamiento de la propiedad: - * sólo lectura* |
| formula | cadena | Expresión definida por el usuario que se utilizará para evaluar las condiciones de los filtros con una expresión personalizada. La expresión debe contener ID que hagan referencia a condiciones de filtro específicas mediante su formulaid. Los ID utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: ninguna condición puede permanecer sin usar u omitir.Comportamiento de la propiedad:<br >- obligatorio si evaltype está configurado en "expresión personalizada" |
Condición de filtro de acción
El objeto de condición de filtro de acción define una condición específica que debe comprobarse antes de ejecutar las operaciones de acción.
| Propiedad | Tipo | Descripción |
|---|---|---|
| conditiontype | entero | Tipo de condición. Valores posibles si eventsource de objeto de acción se establece en "evento creado por un activador":0 - grupo de equipos;< br>1 - equipo; 2 - iniciador; 3 - nombre del evento; 4 - gravedad del iniciador; 6 - período de tiempo; 13 - plantilla de equipos; 16 - el problema se suprime; 25 - etiqueta de evento; 26 - valor de etiqueta de evento. Valores posibles si eventsource de objeto de acción se establece en "evento creado por un regla de descubrimiento":7 - IP del equipo; 8 - tipo de servicio descubierto; 9 - puerto de servicio descubierto; 10 - estado de descubrimiento; 11 - duración del tiempo de actividad o inactividad;<br >12 - valor recibido; 18 - regla de descubrimiento; 19 - verificación de descubrimiento; 20 - proxy; 21 - objeto de descubrimiento. Valores posibles si eventsource de Objeto de acción está configurado en "evento creado por el registro automático del agente activo":20 - proxy; 22 - nombre de host; 24 - metadatos del host. Posible valores si eventsource de Objeto de acción está configurado en "evento interno":0 - grupo de equipos; 1 - equipo; 13 - plantilla de equipo; 23 - tipo de evento; 25 - etiqueta de evento; 26 - valor de etiqueta de evento. Valores posibles si eventsource de objeto de acción está configurado en "evento creado en el estado del servicio update":25 - etiqueta de evento; 26 - valor de etiqueta de evento; 27 - servicio; 28 - nombre del servicio. Comportamiento de la propiedad: - obligatorio |
| value | cadena | Valor con el que comparar. Comportamiento de la propiedad: - obligatorio |
| value2 | cadena | Valor secundario con el que comparar. Comportamiento de la propiedad: - obligatorio si eventsource de objeto de acción (#acción) se establece en "evento creado por un iniciador", conditiontype se establece en cualquier valor posible para las acciones del iniciador, y el tipo de condición (ver más abajo) es "26"- obligatorio si eventsource de Objeto de acción se establece en "evento interno", conditiontype se establece en cualquier valor posible para acciones internas y el tipo de condición (ver más abajo) es "26"- * requerido* si eventsource de Objeto de acción se establece en "evento creado en la actualización del estado del servicio", conditiontype se establece en cualquier valor posible para las acciones del servicio y el tipo de condición (ver más abajo) es "26" |
| formulaid | cadena | ID único arbitrario que se utiliza para hacer referencia a la condición desde una expresión personalizada. Sólo puede contener letras mayúsculas. El ID debe ser definido por el usuario al modificar las condiciones del filtro, pero se generará nuevamente al solicitarlas posteriormente. |
| operator | entero | Operador de condición. Valores posibles: 0 - (predeterminado) es igual; 1 - no es igual; 2 - contiene; 3 - no contiene; 4 - en; 5 - es mayor o igual que; 6 - es menor o igual; 7 - no en; 8 - coincide;<br >9 - no coincide; 10 - Sí; 11 - No. |
Para comprender mejor cómo utilizar filtros con varios tipos de expresiones, vea ejemplos en el método action.get y action.create.
Los siguientes operadores y valores son compatibles con cada tipo de condición.
| Condición | Nombre de la condición | Operadores admitidos | Valor esperado |
|---|---|---|---|
| 0 | Grupo de equipos | es igual, no es igual |
ID del grupo de equipos. |
| 1 | Equipo | es igual, no es igual |
ID de equipo. |
| 2 | Iniciador | es igual, no es igual |
ID del iniciador. |
| 3 | Nombre del evento | contiene, no contiene |
Nombre del evento. |
| 4 | Gravedad del iniciador | es igual, no es igual, es mayor o igual, es menor o igual |
Gravedad del iniciador. Consulte la propiedad severity del iniciador para obtener una lista de las gravedades de iniciador admitidas. |
| 5 | Valor del iniciador | es igual a | Valor del iniciador. Consulte la propiedad valor del iniciador para obtener una lista de los valores deiniciador admitidos. |
| 6 | Período de tiempo | en, no en | Hora en que se activó el evento como un período de tiempo. |
| 7 | IP del equipo | es igual, no es igual |
Uno o varios rangos de IP para verificar, separados por comas. Consulte la sección configuración de descubrimiento de red para obtener más información sobre los formatos admitidos de rangos de IP. |
| 8 | Tipo de servicio descubierto | es igual, no es igual |
Tipo de servicio descubierto. El tipo de servicio coincide con el tipo de verificación de descubrimiento utilizada para detectar el servicio. Consulte la propiedad type de verificación de descubrimiento para obtener una lista de los tipos admitidos. |
| 9 | Puerto de servicio descubierto | es igual, no es igual |
Uno o varios rangos de puertos, separados por comas. |
| 10 | Estado de descubrimiento | es igual a | Estado de un objeto descubierto. Valores posibles: 0 - equipo o servicio activo; 1 - equipo o servicio inactivo; 2 - equipo o servicio descubierto; 3 - equipo o servicio perdido. |
| 11 | La duración del tiempo de actividad o inactividad | es mayor o igual, es menor o igual |
Tiempo que indica cuánto tiempo ha estado el objeto descubierto en el estado actual en segundos. |
| 12 | Valores recibidos | igual, no es igual, es mayor o igual, es menor o igual, contiene, no contiene |
Valor devuelto al realizar una Agente Zabbix, verificación de descubrimiento SNMPv1, SNMPv2 o SNMPv3. |
| 13 | Plantilla de equipos | es igual, no es igual |
ID de plantilla vinculada. |
| 16 | El problema se suprime | Sí, No | No se requiere ningún valor: usar el operador "Sí" significa que el problema debe suprimirse, "No" - no suprimirse. |
| 18 | Regla de descubrimiento | es igual, no es igual |
ID de la regla de descubrimiento. |
| 19 | Verificación de descubrimiento | es igual, no es igual |
ID de la verificación de descubrimiento. |
| 20 | Proxy | es igual, no es igual |
ID del proxy. |
| 21 | Objeto de descubrimiento | es igual a | Tipo de objeto que desencadenó el evento de descubrimiento. Valores posibles: 1 - host descubierto; 2 - servicio descubierto. |
| 22 | Nombre de equipo | contiene, no contiene, coincide, no coincide |
Nombre de equipo. Se admite el uso de una expresión regular para los operadores coincide y no coincide en condiciones de autorregistro. |
| 23 | Tipo de evento | es igual a | Evento interno específico. Valores posibles: 0 - elemento en estado "no compatible"; 1 - elemento en estado "normal"; 2 - Regla LLD en estado "no compatible"; 3 - Regla LLD en estado "normal"; 4 - iniciador en estado "desconocido"; 5 - iniciador en estado "normal". |
| 24 | Metadatos del host | contiene, no contiene, coincide, no coincide |
Metadatos del host registrado automáticamente. Se admite el uso de una expresión regular para los operadores coincidencias y no coincide. |
| 25 | Etiqueta | es igual, no es igual, contiene, no contiene |
Etiqueta de evento. |
| 26 | Valor de etiqueta | es igual, no es igual, contiene, no contiene |
Valor de etiqueta de evento. |
| 27 | Servicio | es igual, no es igual |
ID de servicio. |
| 28 | Nombre del servicio | es igual, no es igual |
nombre del servicio. |