Los siguientes objetos están directamente relacionados con la API "action".
El objeto acción tiene las siguientes propiedades:
Propiedad | Tipo | Descripción |
---|---|---|
actionid | string | (solo lectura) ID de la acción. |
esc_period (requerido) |
string | Duración default del paso de operación. Debe de ser al mens de 60 segundo. Acepta segundos, unidad de tiempo con sufijo y macro de usuario. Notar que las escalaciones son solo soportados por los activadores (trigger), internos y acciones de servicio, y solo en operaciones normales. |
origen del evento (eventsource) (requerido) |
entero(integer) | (constante) El tipo de eventos que la acción manejará. Refiere a la propiedad del "origen" del evento for a list of supported event types. |
nombre (requerido) |
texto(string) | Nombre de la acción. |
status | entero(integer) | Si la acción está habilitada o deshabilitada. Valores posibles:: 0 - (default) habilitado; 1 - deshabilitado. |
pausa_suprimida | Entero(integer) | Si pausar la escalación durante los periodos de mantenimiento o no. Posibles valores: 0 - No pausar la escalación; 1 - (default) Pausar escalación. Note que este parámetro es válido para activadores de acciones únicamente (trigger actions). |
notificar_si_cancelado | Entero(integer) | Si notificar cuando una escalación es cancelada. Posibles valores: 0 - No notificar cuando la escalación es cancelada; 1 - (default) Notifica cuando la escalación es cancelada. Note que este parámetro solo es válido para activadores de acciones (trigger actions). |
Note que para algunos métodos (actualizar, eliminar), la combinación de el parámetro requerido/opcional es diferente
COMENTARIO https://git.zabbix.com/projects/WEB/repos/documentation/browse/en/manual/api/reference/action/object.md?at=refs%2Fheads%2Frelease%2F6.0 CONTEXTO manual/api/reference/action/object.md RECURSO Documentación 6.0•manual/api/reference/action/object.xliff
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 |
---|---|---|
operationid | cadena | (solo lectura) ID de la operación de acción. |
operationtype (obligatorio) |
entero | Tipo de operación. Valores posibles: 0 - enviar mensaje; 1 - script global; 2 - agregar host; 3 - eliminar host; 4 - agregar al grupo de hosts; 5 - eliminar del grupo de hosts; 6 - vincular a la plantilla; 7 - desvincular de la plantilla;<br >8: habilitar el host; 9: deshabilitar el host; 10: configurar el modo de inventario del host. Tenga en cuenta que solo se admiten los tipos '0' y '1' para acciones de activación y servicio, únicamente '0' se admite para acciones internas. Todos los tipos son compatibles con acciones de descubrimiento y registro automático. |
actionid | string | (readonly) ID de la acción a la que pertenece la operación. |
esc_period | string | Duración de un paso de escalada en segundos. Debe ser mayor a 60 segundos. Acepta segundos, unidad de tiempo con sufijo y macro de usuario. Si se establece en 0 o 0, se utilizará el período de escalamiento de acciones predeterminado. Predeterminado: 0. Tenga en cuenta que los escalamientos solo se admiten para iniciadores, acciones internas y de servicio, y solo en operaciones normales. |
esc_step_from | entero | Paso desde el que iniciar la escalada. Valor predeterminado: 1. Tenga en cuenta que las escaladas solo se admiten para acciones desencadenantes, internas y de servicio, y solo en operaciones normales. . |
esc_step_to | entero | Paso para finalizar la escalada en. Valor predeterminado: 1. Tenga en cuenta que las escaladas solo se admiten para acciones desencadenantes, internas y de servicio, y solo en operaciones normales . |
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 | object | Objeto que contiene datos sobre el script global ejecutado por la operación. Cada objeto tiene una de las siguientes propiedades: scriptid - (cadena) ID del script.Obligatorio para operaciones de script globales. |
opcommand_grp | array | Grupos de equipos para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: opcommand_grpid - (cadena, solo lectura) ID del objeto;operationid - (string, readonly) ID de la operación;groupid - (string) ID del grupo de hosts.Obligatorio para operaciones de script globales si opcommand_hst es no establecido. |
opcommand_hst | matriz | Equipo para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: opcommand_hstid - (cadena, solo lectura) ID del objeto;Operationid - (string, readonly) ID de la operación;hostid - (string) ID del equipo; si se establece en 0, el comando se ejecutará en el equipo actual.Requerido para operaciones de script globales si 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 | matriz | Grupos de equipos a los que agregar equipos. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;groupid - (cadena) ID del grupo de equipos.Obligatorio para las operaciones "agregar al grupo de equipos" y "eliminar del grupo de equipos". |
opmessage | object | 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> Requerido para operaciones de mensajes. |
opmessage_grp | array | Grupos de usuarios a los que enviar mensajes. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;usrgrpid - (cadena) ID del grupo de usuarios.Requerido para operaciones de mensajes si opmessage_usr no está configurado. |
opmessage_usr | matriz | Usuarios a los que enviar mensajes. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;userid - (cadena) ID del usuario.Obligatorio para operaciones de mensajes si opmessage_grp no está configurado. |
optemplate | matriz | Plantillas para vincular los hosts. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;templateid - (cadena) ID de la plantilla.Obligatorio para las operaciones "vincular a plantilla" y "desvincular de plantilla". |
opinventory | objeto | Modo de inventario configurado como host. El objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;inventory_mode - * (cadena)* Modo de inventario.Obligatorio para las operaciones "Establecer el modo de inventario del equipo". |
El objeto de mensaje de operación contiene datos sobre el mensaje que será enviado por la operación.
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 | cadena | ID del tipo de medio que se utilizará para enviar el mensaje. |
message | cadena | Texto del mensaje de operación. |
subject | cadena | Asunto del mensaje de operació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 |
---|---|---|
opconditionid | string | (readonly) ID de la condición de operación de acción |
conditiontype (obligatorio) |
entero | Tipo de condición. Valores posibles: 14 - evento reconocido. |
value (obligatorio) |
cadena | Valor con el que comparar. |
operationid | cadena | (solo lectura) ID de la operación. |
operator | entero | Operador de condición. Valores posibles: 0 - (predeterminado) =. |
Se admiten los siguientes operadores y valores para cada tipo de condición de la operació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.|
El objeto de operación de recuperación de acción define una operación que será realizada cuando se resuelva un problema. Las operaciones de recuperación son posibles. para iniciadores, acciones internas y de servicio. Tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
operationid | cadena | (solo lectura) ID de la operación de acción. |
operationtype (obligatorio) |
entero | Tipo de operación. Valores posibles para acciones de activación y servicio: 0 - enviar mensaje; 1 - script global;< br>11 - notificar a todos los involucrados. Valores posibles para acciones internas: 0 - enviar mensaje; 11 - notificar a todos los involucrados. |
actionid | string | (readonly) ID de la acción a la que pertenece la operación de recuperación. |
opcommand | object | Objeto que contiene datos sobre el script de tipo de acción global ejecutado por la operación. Cada objeto tiene una de las siguientes propiedades: scriptid - (cadena) ID del script de tipo de acción.Requerido para operaciones de script globales. |
opcommand_grp | array | Grupos de hosts para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: opcommand_grpid - (cadena, solo lectura) ID del objeto;operationid - (string, readonly) ID de la operación;groupid - (string) ID del grupo de hosts.Obligatorio para operaciones de script globales si opcommand_hst es no establecido. |
opcommand_hst | matriz | Equipo para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: opcommand_hstid - (cadena, solo lectura) ID del objeto;Operationid - (string, readonly) ID de la operación;hostid - (string) ID del equipo; si se establece en 0, el comando se ejecutará en el equipo actual.Requerido para operaciones de script globales si opcommand_grp no está configurado. |
opmessage | object | Objeto que contiene los datos sobre el mensaje enviado por la operación de recuperación. El objeto del mensaje de operación está descrito en detalle arriba. Requerido para operaciones de mensajes. |
opmessage_grp | matriz | Grupos de usuarios a los que enviar mensajes. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;usrgrpid - (cadena) ID del grupo de usuarios.Requerido para operaciones de mensajes si opmessage_usr no está configurado. |
opmessage_usr | matriz | Usuarios a los que enviar mensajes. Cada objeto tiene las siguientes propiedades: operationid - (cadena, solo lectura) ID de la operación;userid - (cadena) ID del usuario.Obligatorio para operaciones de mensajes si opmessage_grp no está configurado. |
El objeto de operación de actualización de acción define una operación que será realizada cuando se actualice un problema (comentado, reconocido, cambio de gravedad o cierre manual). Las operaciones de actualización son posibles para acciones de activación y servicio. Tiene las siguientes propiedades.
Propiedad | Tipo | Descripción |
---|---|---|
operationid | cadena | (solo lectura) ID de la operación de acción. |
operationtype (obligatorio) |
entero | Tipo de operación. Valores posibles para iniciador y acciones de servicio: 0 - enviar mensaje; 1 - script global;< br>12 - notificar a todos los involucrados. |
opcommand | object | Objeto que contiene datos sobre el script de tipo de acción global ejecutado por la operación. Cada objeto tiene una de las siguientes propiedades: scriptid - (cadena) ID del script de tipo de acción.Requerido para operaciones de script globales. |
opcommand_grp | array | Grupos de equipos para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: groupid - (cadena) ID del grupo de equipos.< br>Requerido para operaciones de script globales si opcommand_hst no está configurado. |
opcommand_hst | array | Equipo para ejecutar scripts globales. Cada objeto tiene las siguientes propiedades: hostid - (cadena) ID del equipo; si se establece en 0, el comando se ejecutará en el equipo actual.Requerido para operaciones de script globales si opcommand_grp no está configurado. |
opmessage | object | 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. Cada objeto tiene las siguientes propiedades: usrgrpid - (string) ID del grupo de usuarios.<br >Requerido sólo para operaciones de enviar mensaje si opmessage_usr no está configurado.Se ignora para operaciones de enviar mensaje de actualización . |
opmessage_usr | array | Usuarios a los que enviar mensajes. Cada objeto tiene las siguientes propiedades: userid - (string) ID del usuario.Obligatorio sólo para operaciones de enviar mensaje si opmessage_grp no está configurado.Se ignora para operaciones de enviar mensaje de actualizació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 (obligatorio) |
matriz | Conjunto de condiciones de filtro a utilizar para filtrar resultados. |
evaltype (obligatorio) |
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. |
eval_formula | string | (readonly) 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. |
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. Obligatorio para filtros de expresión personalizados. |
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 |
---|---|---|
conditionid | string | (readonly) ID de la condición de acción. |
conditiontype (obligatorio) |
entero | Tipo de condición. Valores posibles para acciones desencadenantes: 0 - grupo de equipos; 1 - equipo; 2 - iniciador; 3 - nombre del evento; 4 - gravedad del iniciador; 6 - período de tiempo; 13 - plantilla de equipo; 16 - el problema se suprime; 25 - evento etiqueta; 26 - valor de etiqueta de evento. Valores posibles para acciones de descubrimiento: 7 - IP del equipo; 8 - tipo de servicio descubierto; 9 - puerto de servicio descubierto;< br>10 - estado de descubrimiento; 11 - duración del tiempo de actividad o inactividad; 12 - valor recibido; 18 - regla de descubrimiento; 19 - verificación de descubrimiento; 20 - proxy;<br >21 - objeto de descubrimiento. Valores posibles para acciones de registro automático: 20 - proxy; 22 - nombre de equipo; 24 - metadatos del equipo. Valores posibles para acciones internas: 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 para acciones de servicio: 25 - etiqueta de evento; 26 - valor de etiqueta de evento; 27 - servicio; 28 - nombre de servicio. |
value (obligatorio) |
cadena | Valor con el que comparar. |
valor2 |
cadena | Valor secundario con el que comparar. Requerido para iniciadores, acciones internas y de servicio cuando el tipo de condición es 26. |
actionid | string | (readonly) ID de la acción a la que pertenece la condición. |
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, ver ejemplos en las páginas del 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 iniciaodr | es igual, no es igual, es mayor o igual, es menor o igual |
Gravedad del iniciador. Consulte la propiedad "gravedad" del iniciador para obtener una lista de las gravedades de iniciador admitidas. |
5 | Valor de activación | es igual a | Valor de activación. Consulte la propiedad "valor" del activador para obtener una lista de los valores de activación 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 "tipo" 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 - host o servicio activo; 1 - host o servicio inactivo; 2 - host o servicio descubierto; 3 - host 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 que, es menor o igual que, contiene, no contiene |
Valor devuelto al realizar una Agente Zabbix, verificación de descubrimiento SNMPv1, SNMPv2 o SNMPv3. |
13 | Plantilla de equipo | 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 - activador en estado "desconocido"; 5 - activador en estado "normal". |
24 | Metadatos del equipo | contiene, no contiene, coincide, no coincide |
Metadatos del equipo 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. |