En esta página
Objeto acción
Los siguientes objetos están directamente relacionados con la API de acción.
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 - obligatoria para las operaciones de actualización |
| esc_period | string | Duración predeterminada del paso de operación. Debe ser de al menos 60 segundos. Acepta un número de segundos (por ejemplo, 60, 300), un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h) o una macro de usuario.Comportamiento de la propiedad: - compatible si eventsource está establecido en "evento creado por un trigger", "evento interno" o "evento creado al actualizar el estado del servicio" |
| eventsource | integer | Tipo de eventos que gestionará la acción. Consulte la propiedad source del evento para obtener una lista de los tipos de eventos compatibles.Comportamiento de la propiedad: - constante - obligatoria para las operaciones de creación |
| name | string | Nombre de la acción. Comportamiento de la propiedad: - obligatoria para las operaciones de creación |
| status | integer | Indica si la acción está habilitada o deshabilitada. Valores posibles: 0 - habilitada (predeterminado); 1 - deshabilitada. |
| pause_symptoms | integer | Indica si se debe pausar la escalación cuando el evento es un evento de síntoma. Valores posibles: 0 - No pausar la escalación para problemas de síntomas; 1 - Pausar la escalación para problemas de síntomas (predeterminado). Comportamiento de la propiedad: - compatible si eventsource está establecido en "evento creado por un trigger" |
| pause_suppressed | integer | Indica si se debe pausar la escalación durante los períodos de mantenimiento. Valores posibles: 0 - No pausar la escalación; 1 - Pausar la escalación (predeterminado). Comportamiento de la propiedad: - compatible si eventsource está establecido en "evento creado por un trigger" |
| notify_if_canceled | integer | Indica si se debe enviar una notificación cuando se cancela la escalación. Valores posibles: 0 - No enviar una notificación cuando se cancela la escalación; 1 - Enviar una notificación cuando se cancela la escalación (predeterminado). Comportamiento de la propiedad: - compatible si eventsource está establecido en "evento creado por un trigger" |
Operación de la acción
El objeto de operación de la 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 host; 3 - eliminar host; 4 - añadir a un grupo de hosts; 5 - eliminar de un grupo de hosts; 6 - vincular template; 7 - desvincular template; 8 - habilitar host; 9 - deshabilitar host; 10 - establecer el modo de inventario del host; 13 - añadir etiquetas al host; 14 - eliminar etiquetas del host. Valores posibles si eventsource del objeto Action está establecido en "evento creado por un trigger" o "evento creado al actualizar el estado del servicio":0 - "enviar mensaje"; 1 - "script global". Valores posibles si eventsource del objeto Action está establecido en "evento interno":0 - "enviar mensaje". Comportamiento de la propiedad: - obligatoria |
| esc_period | string | Duración de un paso de escalado en segundos. Debe ser superior a 60 segundos. Acepta un número de segundos (por ejemplo, 60, 300), un valor con un sufijo de tiempo (por ejemplo, 30s, 1m, 2h) o una macro de usuario. Si se establece en 0 o 0s, se utilizará el período de escalado predeterminado de la acción.Predeterminado: 0s. Comportamiento de la propiedad: - compatible si eventsource del objeto Action está establecido en "evento creado por un trigger", "evento interno" o "evento creado al actualizar el estado del servicio" |
| esc_step_from | integer | Paso desde el que se inicia el escalado. Predeterminado: 1. Comportamiento de la propiedad: - compatible si eventsource del objeto Action está establecido en "evento creado por un trigger", "evento interno" o "evento creado al actualizar el estado del servicio" |
| esc_step_to | integer | Paso en el que finaliza el escalado. Predeterminado: 1. Comportamiento de la propiedad: - compatible si eventsource del objeto Action está establecido en "evento creado por un trigger", "evento interno" o "evento creado al actualizar el estado del servicio" |
| evaltype | integer | Método de evaluación de las condiciones de la operación. Valores posibles: 0 - (predeterminado) And/Or; 1 - And; 2 - Or. |
| opcommand | object | Script global que se ejecutará. El script global debe tener definida la propiedad scriptid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "script global" |
| opcommand_grp | array | Grupos de hosts en los que se ejecutarán los scripts globales. Los grupos de hosts deben tener definida la propiedad groupid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "script global" y opcommand_hst no está establecido |
| opcommand_hst | array | Host en el que se ejecutarán los scripts globales. Los hosts deben tener definida la propiedad hostid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "script global" y opcommand_grp no está establecido |
| opconditions | array | Condiciones de la operación utilizadas para las acciones de trigger. El objeto de condición de la operación se describe detalladamente a continuación. |
| opgroup | array | Grupos de hosts a los que se añadirán los hosts. Los grupos de hosts deben tener definida la propiedad groupid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "añadir a un grupo de hosts" o "eliminar de un grupo de hosts" |
| opmessage | object | Objeto que contiene los datos sobre el mensaje enviado por la operación. El objeto de mensaje de la operación se describe detalladamente a continuación. Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "enviar mensaje" |
| opmessage_grp | array | Grupos de usuarios a los que se enviarán los mensajes. Los grupos de usuarios deben tener definida la propiedad usrgrpid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "enviar mensaje" y opmessage_usr no está establecido |
| opmessage_usr | array | Usuarios a los que se enviarán los mensajes. Los usuarios deben tener definida la propiedad userid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "enviar mensaje" y opmessage_grp no está establecido |
| optemplate | array | Templates que se vincularán a los hosts. Los templates deben tener definida la propiedad templateid.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "vincular template" o "desvincular template" |
| opinventory | object | Modo de inventario que se establecerá en el host. El inventario debe tener definida la propiedad inventory_mode.Comportamiento de la propiedad: - obligatoria si operationtype está establecido en "establecer el modo de inventario del host" |
| optag | array | Etiquetas del host que se añadirán o eliminarán. Las etiquetas deben tener definida la propiedad tag.La propiedad value es opcional. Comportamiento de la propiedad: - compatible si operationtype está establecido en "añadir etiquetas al host" o "eliminar etiquetas del host". |
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 por defecto del mensaje de acción. 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 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 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 a 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 trigger, 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 trigger" 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 hosts en los que ejecutar scripts globales. Los grupos de hosts deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un trigger", y operationtype está establecido en "script global", y opcommand_hst no está establecido |
| opcommand_hst | array | Host en los que ejecutar scripts globales. Los hosts deben tener definida la propiedad hostid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un trigger", 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 severidad o se cierre manualmente). Las operaciones de actualización son posibles solo para acciones de trigger 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 hosts en los que ejecutar scripts globales. Los grupos de hosts deben tener definida la propiedad groupid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un trigger", y operationtype está establecido en "script global", y opcommand_hst no está establecido |
| opcommand_hst | array | Host en los que ejecutar scripts globales. Los hosts deben tener definida la propiedad hostid.Comportamiento de la propiedad: - requerido si eventsource del objeto Acción está establecido en "evento creado por un trigger", 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 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 los resultados. Las condiciones se ordenarán en el orden de su colocación en la fórmula. Comportamiento de la propiedad: - obligatorio |
| evaltype | integer | 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 | 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: - obligatorio si evaltype está establecido en "expresión personalizada" |
Condición del filtro de la acción
El objeto de condición del filtro de la acción define una condición específica que debe comprobarse antes de ejecutar las operaciones de la acción.
| Property | Type | Description |
|---|---|---|
| conditiontype | integer | Tipo de condición. Valores posibles si eventsource del Action object está establecido en "evento creado por un trigger":0 - grupo de hosts; 1 - host; 2 - trigger; 3 - nombre del evento; 4 - gravedad del trigger; 6 - período de tiempo; 13 - template de host; 16 - el problema está suprimido; 25 - etiqueta del evento; 26 - valor de la etiqueta del evento. Valores posibles si eventsource del Action object está establecido en "evento creado por una regla de descubrimiento":7 - IP del host; 8 - tipo de servicio descubierto; 9 - puerto del servicio descubierto; 10 - estado del descubrimiento; 11 - duración del tiempo de actividad o inactividad; 12 - valor recibido; 18 - regla de descubrimiento; 19 - comprobación de descubrimiento; 20 - proxy; 21 - objeto de descubrimiento; 29 - grupo de proxies. Valores posibles si eventsource del Action object está establecido en "evento creado por el registro automático de un agent activo":20 - proxy; 22 - nombre del host; 24 - metadatos del host; 29 - grupo de proxies. Valores posibles si eventsource del Action object está establecido en "evento interno":0 - grupo de hosts; 1 - host; 13 - template de host; 23 - tipo de evento; 25 - etiqueta del evento; 26 - valor de la etiqueta del evento. Valores posibles si eventsource del Action object está establecido en "evento creado al actualizar el estado del servicio":25 - etiqueta del evento; 26 - valor de la etiqueta del evento; 27 - servicio; 28 - nombre del servicio. Property behavior: - required |
| value | string | Valor con el que se debe comparar. Property behavior: - required |
| value2 | string | Valor secundario con el que se debe comparar. Property behavior: - required si eventsource del Action object está establecido en "evento creado por un trigger", conditiontype está establecido en cualquier valor posible para las acciones de trigger y el tipo de condición (véase más abajo) es "26"- required si eventsource del Action object está establecido en "evento interno", conditiontype está establecido en cualquier valor posible para las acciones internas y el tipo de condición (véase más abajo) es "26"- required si eventsource del Action object está establecido en "evento creado al actualizar el estado del servicio", conditiontype está establecido en cualquier valor posible para las acciones de servicio y el tipo de condición (véase más abajo) es "26" |
| formulaid | string | ID único arbitrario que se utiliza para hacer referencia a la condición desde una expresión personalizada. Solo puede contener letras mayúsculas. El usuario debe definir el ID al modificar las condiciones del filtro, pero se generará uno nuevo al solicitarlas posteriormente. |
| operator | integer | Operador de la condición. Valores posibles: 0 - (predeterminado) es igual a; 1 - no es igual a; 2 - contiene; 3 - no contiene; 4 - está en; 5 - es mayor o igual que; 6 - es menor o igual que; 7 - no está en; 8 - coincide; 9 - no coincide; 10 - Sí; 11 - No. |
Para comprender mejor cómo utilizar filtros con distintos tipos de expresiones, consulte los ejemplos de las páginas de los métodos action.get y action.create.
Los siguientes operadores y valores son compatibles con cada tipo de condición.
| Condition | Condition name | Supported operators | Expected value |
|---|---|---|---|
| 0 | Grupo de hosts | es igual a, no es igual a |
ID del grupo de hosts. |
| 1 | Host | es igual a, no es igual a |
ID del host. |
| 2 | Trigger | es igual a, no es igual a |
ID del trigger. |
| 3 | Nombre del evento | contiene, no contiene |
Nombre del evento. |
| 4 | Gravedad del trigger | es igual a, no es igual a, es mayor o igual que, es menor o igual que |
Gravedad del trigger. Consulte la propiedad severity del trigger para obtener una lista de las gravedades de trigger compatibles. |
| 5 | Valor del trigger | es igual a | Valor del trigger. Consulte la propiedad value del trigger para obtener una lista de los valores de trigger compatibles. |
| 6 | Período de tiempo | está en, no está en | Momento en que se activó el evento, expresado como un período de tiempo. |
| 7 | IP del host | es igual a, no es igual a |
Uno o varios rangos de IP que se comprobarán, separados por comas. Consulte la sección configuración del descubrimiento de red para obtener más información sobre los formatos compatibles de los rangos de IP. |
| 8 | Tipo de servicio descubierto | es igual a, no es igual a |
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 obtener una lista de los tipos compatibles. |
| 9 | Puerto del servicio descubierto | es igual a, no es igual a |
Uno o varios rangos de puertos, separados por comas. |
| 10 | Estado del descubrimiento | es igual a | Estado de un objeto descubierto. Valores posibles: 0 - host o servicio activo; 1 - host o servicio inactivo; 2 - host o servicio descubierto; 3 - host o servicio perdido. |
| 11 | Duración del tiempo de actividad o inactividad | es mayor o igual que, es menor o igual que |
Tiempo, en segundos, que indica cuánto tiempo ha permanecido el objeto descubierto en el estado actual. |
| 12 | Valores recibidos | es igual a, no es igual a, es mayor o igual que, es menor o igual que, contiene, no contiene |
Valor devuelto al realizar una comprobación de descubrimiento de Zabbix agent, SNMPv1, SNMPv2 o SNMPv3. |
| 13 | Template de host | es igual a, no es igual a |
ID del template vinculado. |
| 16 | El problema está suprimido | Sí, No | No se requiere ningún valor: utilizar el operador "Sí" significa que el problema debe estar suprimido; "No" significa que no debe estar suprimido. |
| 18 | Regla de descubrimiento | es igual a, no es igual a |
ID de la regla de descubrimiento. |
| 19 | Comprobación de descubrimiento | es igual a, no es igual a |
ID de la comprobación de descubrimiento. |
| 20 | Proxy | es igual a, no es igual a |
ID del proxy. |
| 21 | Objeto de descubrimiento | es igual a | Tipo de objeto que activó el evento de descubrimiento. Valores posibles: 1 - host descubierto; 2 - servicio descubierto. |
| 22 | Nombre del host | contiene, no contiene, coincide, no coincide |
Nombre del host. El uso de una expresión regular es compatible con los operadores coincide y no coincide en las condiciones de registro automático. |
| 23 | Tipo de evento | es igual a | Evento interno específico. Valores posibles: 0 - item en estado "no compatible"; 1 - item en estado "normal"; 2 - regla LLD en estado "no compatible"; 3 - regla LLD en estado "normal"; 4 - trigger en estado "desconocido"; 5 - trigger en estado "normal". |
| 24 | Metadatos del host | contiene, no contiene, coincide, no coincide |
Metadatos del host registrado automáticamente. El uso de una expresión regular es compatible con los operadores coincide y no coincide. |
| 25 | Etiqueta | es igual a, no es igual a, contiene, no contiene |
Etiqueta del evento. |
| 26 | Valor de la etiqueta | es igual a, no es igual a, contiene, no contiene |
Valor de la etiqueta del evento. |
| 27 | Servicio | es igual a, no es igual a |
ID del servicio. |
| 28 | Nombre del servicio | es igual a, no es igual a |
Nombre del servicio. |
| 29 | Grupo de proxies | es igual a, no es igual a |
ID del grupo de proxies. |