Table of Contents
Objeto acción
Los siguientes objetos están directamente relacionados con la API de acción.
Acción
El objeto acción tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| actionid | ID | ID de la acción. Comportamiento de la propiedad: - solo lectura - requerido para operaciones de actualización |
| esc_period | string | Duración por defecto del paso de la operación. Debe ser al menos 60 segundos. Acepta segundos, unidad de tiempo con sufijo o una macro de usuario. Comportamiento de la propiedad: - soportado si eventsource está establecido en "evento creado por un disparador", "evento interno" o "evento creado en la actualización del estado del servicio" |
| eventsource | integer | Tipo de eventos que la acción gestionará. Consulte la propiedad source del evento para ver una lista de los tipos de eventos soportados.Comportamiento de la propiedad: - constante - requerido para operaciones de creación |
| name | string | Nombre de la acción. Comportamiento de la propiedad: - requerido para operaciones de creación |
| status | integer | Indica si la acción está habilitada o deshabilitada. Valores posibles: 0 - (por defecto) habilitada; 1 - deshabilitada. |
| pause_symptoms | integer | Indica si se debe pausar la escalada si el evento es un evento síntoma. Valores posibles: 0 - No pausar la escalada para problemas síntoma; 1 - (por defecto) Pausar la escalada para problemas síntoma. Comportamiento de la propiedad: - soportado si eventsource está establecido en "evento creado por un disparador" |
| pause_suppressed | integer | Indica si se debe pausar la escalada durante los periodos de mantenimiento o no. Valores posibles: 0 - No pausar la escalada; 1 - (por defecto) Pausar la escalada. Comportamiento de la propiedad: - soportado si eventsource está establecido en "evento creado por un disparador" |
| notify_if_canceled | integer | Indica si se debe notificar cuando la escalada es cancelada. Valores posibles: 0 - No notificar cuando la escalada es cancelada; 1 - (por defecto) Notificar cuando la escalada es cancelada. Comportamiento de la propiedad: - soportado si eventsource está establecido en "evento creado por un disparador" |
Operación de acción
El objeto de operación de acción define una operación que se realizará cuando se ejecute una acción. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | integer | Tipo de operación. Valores posibles: 0 - enviar mensaje; 1 - script global; 2 - añadir equipo; 3 - eliminar equipo; 4 - añadir a grupo de equipos; 5 - eliminar de grupo de equipos; 6 - vincular plantilla; 7 - desvincular plantilla; 8 - habilitar equipo; 9 - deshabilitar equipo; 10 - establecer modo de inventario del equipo; 13 - añadir etiquetas de equipo; 14 - eliminar etiquetas de equipo. Valores posibles si eventsource del objeto Acción está establecido en "evento creado por un disparador" o "evento creado en actualización de estado de servicio":0 - "enviar mensaje"; 1 - "script global". Valores posibles si eventsource del objeto Acción está establecido en "evento interno":0 - "enviar mensaje". Comportamiento de la propiedad: - requerido |
| esc_period | string | Duración de un paso de escalado 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 escalado de acción por defecto. Por defecto: 0s. Comportamiento de la propiedad: - soportado si eventsource del objeto Acción está establecido en "evento creado por un disparador", "evento interno" o "evento creado en actualización de estado de servicio" |
| esc_step_from | integer | Paso desde el que comenzar la escalada. Por defecto: 1. Comportamiento de la propiedad: - soportado si eventsource del objeto Acción está establecido en "evento creado por un disparador", "evento interno" o "evento creado en actualización de estado de servicio" |
| esc_step_to | integer | Paso en el que finalizar la escalada. Por defecto: 1. Comportamiento de la propiedad: - soportado si eventsource del objeto Acción está establecido en "evento creado por un disparador", "evento interno" o "evento creado en actualización de estado de servicio" |
| evaltype | integer | Método de evaluación de condición de operación. Valores posibles: 0 - (por defecto) AND / OR; 1 - AND; 2 - OR. |
| opcommand | object | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "script global" |
| opcommand_grp | array | Grupos de equipos en los que ejecutar scripts globales. Los grupos de equipos deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "script global" y opcommand_hst no está establecido |
| opcommand_hst | array | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "script global" y opcommand_grp no está establecido |
| opconditions | array | Condiciones de operación utilizadas para acciones de disparador. El objeto condición de operación se describe en detalle más abajo. |
| opgroup | array | Grupos de equipos a los que añadir equipos. Los grupos de equipos deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "añadir a grupo de equipos" o "eliminar de grupo de equipos" |
| opmessage | object | Objeto que contiene los datos sobre el mensaje enviado por la operación. El objeto mensaje de operación se describe en detalle más abajo. Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" |
| opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener definida la propiedad usrgrpid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_usr no está establecido |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_grp no está establecido |
| optemplate | array | Plantillas a vincular a los equipos. Las plantillas deben tener definida la propiedad templateid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "vincular plantilla" o "desvincular plantilla" |
| opinventory | object | Modo de inventario a establecer en el equipo. El inventario debe tener definida la propiedad inventory_mode.Comportamiento de la propiedad: - requerido si operationtype está establecido en "establecer modo de inventario del equipo" |
| optag | array | Etiquetas de equipo a añadir o eliminar. Las etiquetas deben tener definida la propiedad tag.La propiedad value es opcional. Comportamiento de la propiedad: - soportado si operationtype está establecido en "añadir etiquetas de equipo" o "eliminar etiquetas de equipo". |
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 | integer | Indica si se debe usar el texto y asunto de mensaje de acción por defecto. Valores posibles: 0 - usar los datos de la operación; 1 - (por defecto) usar los datos del tipo de medio. |
| mediatypeid | ID | ID del tipo de medio que se utilizará para enviar el mensaje. Comportamiento de la propiedad: - soportado si operationtype del 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á establecido en "enviar mensaje", o si operationtype del Objeto de operación de actualización de acción está establecido en "notificar a todos los involucrados" |
| message | string | Texto del mensaje de la operación. Comportamiento de la propiedad: - soportado si default_msg está establecido en "usar los datos de la operación" |
| subject | string | Asunto del mensaje de la operación. Comportamiento de la propiedad: - soportado si default_msg está establecido en "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 | integer | Tipo de condición. Valores posibles: 14 - evento reconocido. Comportamiento de la propiedad: - requerido |
| value | string | Valor con el que comparar. Comportamiento de la propiedad: - requerido |
| operator | integer | Operador de condición. Valores posibles: 0 - (por defecto) = |
Los siguientes operadores y valores son compatibles para cada tipo de condición de operación.
| Condición | Nombre de la condición | Operadores soportados | Valor esperado |
|---|---|---|---|
| 14 | Evento reconocido | = | Si el evento está reconocido. 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 solo para acciones de disparador, internas y de servicio. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | integer | Tipo de operación. Valores posibles si eventsource del objeto Acción está establecido en "evento creado por un disparador" 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 del objeto Acción está establecido en "evento interno":0 - enviar mensaje; 11 - notificar a todos los involucrados. Comportamiento de la propiedad: - requerido |
| opcommand | object | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "script global" |
| opcommand_grp | array | Grupos de equipos en los que ejecutar scripts globales. Los grupos de equipos deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un disparador", y operationtype está establecido en "script global", y opcommand_hst no está establecido |
| opcommand_hst | array | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un disparador", y operationtype está establecido en "script global", y opcommand_grp no está establecido |
| opmessage | object | Objeto que contiene los datos sobre el mensaje enviado por la operación de recuperación. El objeto de mensaje de operación se describe en detalle arriba. Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" |
| opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener definida la propiedad usrgrpid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_usr no está establecido |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_grp no está establecido |
Operación de actualización de acción
El objeto de operación de actualización de acción define una operación que se realizará cuando se actualice un problema (se comente, se reconozca, se cambie la gravedad o se cierre manualmente). Las operaciones de actualización son posibles solo para acciones de disparador y de servicio. Tiene las siguientes propiedades.
| Propiedad | Tipo | Descripción |
|---|---|---|
| operationtype | integer | Tipo de operación. Valores posibles: 0 - enviar mensaje; 1 - script global; 12 - notificar a todos los involucrados. Comportamiento de la propiedad: - requerido |
| opcommand | object | Script global a ejecutar. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "script global" |
| opcommand_grp | array | Grupos de equipos en los que ejecutar scripts globales. Los grupos de equipos deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un disparador", y operationtype está establecido en "script global", y opcommand_hst no está establecido |
| opcommand_hst | array | Equipo en el que ejecutar scripts globales. Los equipos deben tener definida la propiedad hostid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un disparador", y operationtype está establecido en "script global", y opcommand_grp no está establecido |
| opmessage | object | Objeto que contiene los datos sobre el mensaje enviado por la operación de actualización. El objeto de mensaje de operación se describe en detalle arriba. |
| opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Los grupos de usuarios deben tener definida la propiedad usrgrpid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_usr no está establecido |
| opmessage_usr | array | Usuarios a los que enviar mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - requerido si operationtype está establecido en "enviar mensaje" y opmessage_grp no está establecido |
Filtro de acción
El objeto 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 | array | Conjunto de condiciones de filtro a utilizar para filtrar resultados. Las condiciones se ordenarán en el orden de su colocación en la fórmula. Comportamiento de la propiedad: - requerido |
| evaltype | integer | Método de evaluación de la condición de filtro. Valores posibles: 0 - y/o; 1 - y; 2 - o; 3 - expresión personalizada. Comportamiento de la propiedad: - requerido |
| eval_formula | string | Expresión generada que se utilizará para evaluar las condiciones del filtro. La expresión contiene IDs que hacen referencia a condiciones de filtro específicas por su formulaid. El valor de eval_formula es igual al valor de formula para los filtros con una expresión personalizada.Comportamiento de la propiedad: - solo lectura |
| formula | string | 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 IDs que hagan referencia a condiciones de filtro específicas por su formulaid. Los IDs utilizados en la expresión deben coincidir exactamente con los definidos en las condiciones del filtro: ninguna condición puede quedar sin usar u omitida.Comportamiento de la propiedad: - requerido si evaltype está establecido en "expresión personalizada" |
Condición de filtro de acción
El objeto condición de filtro de acción define una condición específica que debe ser verificada antes de ejecutar las operaciones de la acción.
| Propiedad | Tipo | Descripción |
|---|---|---|
| conditiontype | integer | Tipo de condición. Valores posibles si eventsource del objeto Acción está establecido en "evento creado por un disparador":0 - grupo de equipos; 1 - equipo; 2 - disparador; 3 - nombre del evento; 4 - severidad del disparador; 6 - periodo de tiempo; 13 - plantilla de equipo; 16 - el problema está suprimido; 25 - etiqueta del evento; 26 - valor de la etiqueta del evento. Valores posibles si eventsource del objeto Acción está establecido en "evento creado por una regla de descubrimiento":7 - IP del equipo; 8 - tipo de servicio descubierto; 9 - puerto de servicio descubierto; 10 - estado de descubrimiento; 11 - duración de tiempo activo o inactivo; 12 - valor recibido; 18 - regla de descubrimiento; 19 - comprobación de descubrimiento; 20 - proxy; 21 - objeto de descubrimiento. Valores posibles si eventsource del objeto Acción está establecido en "evento creado por autorregistro de agente activo":20 - proxy; 22 - nombre del equipo; 24 - metadatos del equipo. Valores posibles si eventsource del objeto Acción está establecido en "evento interno":0 - grupo de equipos; 1 - equipo; 13 - plantilla de equipo; 23 - tipo de evento; 25 - etiqueta del evento; 26 - valor de la etiqueta del evento. Valores posibles si eventsource del objeto Acción está establecido en "evento creado en actualización de estado de servicio":25 - etiqueta del evento; 26 - valor de la etiqueta del evento; 27 - servicio; 28 - nombre del servicio. Comportamiento de la propiedad: - requerido |
| value | string | Valor a comparar. Comportamiento de la propiedad: - requerido |
| value2 | string | Valor secundario a comparar. Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un disparador", conditiontype está establecido en cualquier valor posible para acciones de disparador, y el tipo de condición (ver abajo) es "26"- requerido si eventsource del objeto Acción está establecido en "evento interno", conditiontype está establecido en cualquier valor posible para acciones internas, y el tipo de condición (ver abajo) es "26"- requerido si eventsource del objeto Acción está establecido en "evento creado en actualización de estado de servicio", conditiontype está establecido en cualquier valor posible para acciones de servicio, y el tipo de condición (ver abajo) es "26" |
| formulaid | string | ID único arbitrario que se utiliza para referenciar la condición desde una expresión personalizada. Solo puede contener letras mayúsculas. El ID debe ser definido por el usuario al modificar condiciones de filtro, pero se generará uno nuevo al solicitarlas posteriormente. |
| operator | integer | Operador de condición. Valores posibles: 0 - (por defecto) igual; 1 - no igual; 2 - contiene; 3 - no contiene; 4 - en; 5 - es mayor o igual que; 6 - es menor o igual que; 7 - no en; 8 - coincide; 9 - no coincide; 10 - Sí; 11 - No. |
Para comprender mejor cómo utilizar filtros con varios tipos de expresiones, consulte los ejemplos en las páginas de los métodos action.get y action.create.
Los siguientes operadores y valores son compatibles para cada tipo de condición.
| Condición | Nombre de la condición | Operadores soportados | Valor esperado |
|---|---|---|---|
| 0 | Grupo de equipos | igual, no igual |
ID del grupo de equipos. |
| 1 | Equipo | igual, no igual |
ID del equipo. |
| 2 | Disparador | igual, no igual |
ID del disparador. |
| 3 | Nombre del evento | contiene, no contiene |
Nombre del evento. |
| 4 | Severidad del disparador | igual, no igual, es mayor o igual que, es menor o igual que |
Severidad del disparador. Consulte la propiedad severity del disparador para ver una lista de severidades de disparador soportadas. |
| 5 | Valor del disparador | igual | Valor del disparador. Consulte la propiedad value del disparador para ver una lista de valores de disparador soportados. |
| 6 | Periodo de tiempo | en, no en | Momento en que se activó el evento como un periodo de tiempo. |
| 7 | IP del equipo | igual, no igual |
Uno o varios rangos de IP a comprobar, separados por comas. Consulte la sección de configuración de descubrimiento de red para más información sobre los formatos soportados de rangos de IP. |
| 8 | Tipo de servicio descubierto | igual, no igual |
Tipo de servicio descubierto. El tipo de servicio coincide con el tipo de comprobación de descubrimiento utilizada para detectar el servicio. Consulte la propiedad type de la comprobación de descubrimiento para ver una lista de tipos soportados. |
| 9 | Puerto de servicio descubierto | igual, no igual |
Uno o varios rangos de puertos, separados por comas. |
| 10 | Estado de descubrimiento | igual | 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 | Duración de tiempo activo o inactivo | es mayor o igual que, es menor o igual que |
Tiempo que indica cuánto tiempo ha estado el objeto descubierto en el estado actual en segundos. |
| 12 | Valores recibidos | igual, no igual, es mayor o igual que, es menor o igual que, contiene, no contiene |
Valor devuelto al realizar una comprobación de descubrimiento de agente Zabbix, SNMPv1, SNMPv2 o SNMPv3. |
| 13 | Plantilla de equipo | igual, no igual |
ID de la plantilla vinculada. |
| 16 | El problema está suprimido | Sí, No | No se requiere valor: usar el operador "Sí" significa que el problema debe estar suprimido, "No" - no suprimido. |
| 18 | Regla de descubrimiento | igual, no igual |
ID de la regla de descubrimiento. |
| 19 | Comprobación de descubrimiento | igual, no igual |
ID de la comprobación de descubrimiento. |
| 20 | Proxy | igual, no igual |
ID del proxy. |
| 21 | Objeto de descubrimiento | igual | Tipo de objeto que activó el evento de descubrimiento. Valores posibles: 1 - equipo descubierto; 2 - servicio descubierto. |
| 22 | Nombre del equipo | contiene, no contiene, coincide, no coincide |
Nombre del equipo. El uso de una expresión regular es compatible para los operadores coincide y no coincide en condiciones de autorregistro. |
| 23 | Tipo de evento | igual | Evento interno específico. Valores posibles: 0 - métrica en estado "no soportado"; 1 - métrica en estado "normal"; 2 - regla LLD en estado "no soportado"; 3 - regla LLD en estado "normal"; 4 - disparador en estado "desconocido"; 5 - disparador en estado "normal". |
| 24 | Metadatos del equipo | contiene, no contiene, coincide, no coincide |
Metadatos del equipo autorregistrado. El uso de una expresión regular es compatible para los operadores coincide y no coincide. |
| 25 | Etiqueta | igual, no igual, contiene, no contiene |
Etiqueta del evento. |
| 26 | Valor de la etiqueta | igual, no igual, contiene, no contiene |
Valor de la etiqueta del evento. |
| 27 | Servicio | igual, no igual |
ID del servicio. |
| 28 | Nombre del servicio | igual, no igual |
Nombre del servicio. |