Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

trigger.get

Descripción

integer/array trigger.get(object parameters)

El método permite recuperar disparadores según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
triggerids ID/array Devolver solo los triggers con los IDs dados.
groupids ID/array Devolver solo los triggers que pertenecen a hosts o templates de los grupos de hosts o grupos de templates dados.
templateids ID/array Devolver solo los triggers que pertenecen a los templates dados.
hostids ID/array Devolver solo los triggers que pertenecen a los hosts dados.
itemids ID/array Devolver solo los triggers que contienen los items dados.
functions string/array Devolver solo los triggers que usan las funciones dadas.

Consulte la página de funciones soportadas para ver una lista de funciones soportadas.
group string Devolver solo los triggers que pertenecen a hosts o templates del grupo de hosts o grupo de templates con el nombre dado.
host string Devolver solo los triggers que pertenecen al host con el nombre técnico dado.
inherited boolean Si se establece en true, devuelve solo los triggers heredados de un template.
templated boolean Si se establece en true, devuelve solo los triggers que pertenecen a templates.
dependent boolean Si se establece en true, devuelve solo los triggers que tienen dependencias. Si se establece en false, devuelve solo los triggers que no tienen dependencias.
monitored flag Devolver solo los triggers habilitados que pertenecen a hosts monitorizados y contienen solo items habilitados.
active flag Devolver solo los triggers habilitados que pertenecen a hosts monitorizados.
maintenance boolean Si se establece en true, devuelve solo los triggers habilitados que pertenecen a hosts en mantenimiento.
withUnacknowledgedEvents flag Devolver solo los triggers que tienen eventos no reconocidos.
withAcknowledgedEvents flag Devolver solo los triggers con todos los eventos reconocidos.
withLastEventUnacknowledged flag Devolver solo los triggers con el último evento no reconocido.
skipDependent flag Omitir triggers en estado de problema que dependen de otros triggers. Tenga en cuenta que los otros triggers se ignoran si están deshabilitados, tienen items deshabilitados o los hosts de los items están deshabilitados.
lastChangeSince timestamp Devolver solo los triggers que han cambiado su estado después del tiempo dado.
lastChangeTill timestamp Devolver solo los triggers que han cambiado su estado antes del tiempo dado.
only_true flag Devolver solo los triggers que recientemente han estado en estado de problema.
min_severity integer Devolver solo los triggers con severidad mayor o igual que la severidad dada.
evaltype integer Método de evaluación de la etiqueta.

Valores posibles:
0 - (por defecto) And/Or;
2 - Or.
tags array Devolver solo los triggers con las etiquetas dadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vacío devuelve todos los triggers.

Valores posibles de operator:
0 - (por defecto) Contiene;
1 - Igual;
2 - No contiene;
3 - No es igual;
4 - Existe;
5 - No existe.
expandComment flag Expandir macros en la descripción del trigger.
expandDescription flag Expandir macros en el nombre del trigger.
expandExpression flag Expandir funciones y macros en la expresión del trigger.
selectHostGroups query Devolver los grupos de hosts a los que pertenece el trigger en la propiedad hostgroups.
selectHosts query Devolver los hosts a los que pertenece el trigger en la propiedad hosts.
selectItems query Devolver los items contenidos por el trigger en la propiedad items.
selectFunctions query Devolver las funciones usadas en el trigger en la propiedad functions.

Los objetos de función representan las funciones usadas en la expresión del trigger y tienen las siguientes propiedades:
functionid - (ID) ID de la función;
itemid - (ID) ID del item usado en la función;
function - (string) nombre de la función;
parameter - (string) parámetro pasado a la función. El parámetro de consulta se reemplaza por el símbolo $ en la cadena devuelta.
selectDependencies query Devolver los triggers de los que depende el trigger en la propiedad dependencies.
selectDiscoveryData query Devolver una propiedad discoveryData con los datos del objeto de descubrimiento de triggers. El objeto de descubrimiento de triggers vincula un trigger descubierto a una plantilla de trigger de la que fue descubierto.

Tiene las siguientes propiedades:
parent_triggerid - (ID) ID de la plantilla de trigger de la que se ha creado el trigger;
status - (int) estado de descubrimiento del trigger:
0 - (por defecto) el trigger está descubierto,
1 - el trigger ya no está descubierto;
ts_delete - (timestamp) hora en la que se eliminará un trigger que ya no se descubre;
ts_disable - (timestamp) hora en la que se deshabilitará un trigger que ya no se descubre;
disable_source - (int) indicador de si el trigger fue deshabilitado por una regla LLD o manualmente:
0 - (por defecto) deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.
selectDiscoveryRule query Devolver la regla de descubrimiento de bajo nivel que creó el trigger en la propiedad discoveryRule.
selectLastEvent query Devolver el último evento significativo del trigger en la propiedad lastEvent.
selectTags query Devolver las etiquetas del trigger en la propiedad tags.
selectTemplateGroups query Devolver los grupos de templates a los que pertenece el trigger en la propiedad templategroups.
filter object Devolver solo aquellos resultados que coincidan exactamente con el filtro dado.

Acepta un objeto, donde las claves son nombres de propiedades y los valores son un único valor o un array de valores con los que comparar.

No admite propiedades del tipo de datos text data type.

Admite propiedades adicionales:
host - nombre técnico del host al que pertenece el trigger;
hostid - ID del host al que pertenece el trigger.
limitSelects integer Limita el número de registros devueltos por subconsultas.

Se aplica a las siguientes subconsultas:
selectHosts - los resultados se ordenarán por host.
sortfield string/array Ordenar el resultado por las propiedades dadas.

Valores posibles: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Devuelve el objeto de descubrimiento de triggers en la propiedad triggerDiscovery. Los objetos de descubrimiento de triggers vinculan el trigger a una plantilla de trigger de la que fue creado.

Esta consulta está obsoleta, por favor use selectDiscoveryData en su lugar.

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar datos por ID de disparador

Recuperar todos los datos y las funciones utilizadas en el disparador "14062".

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "triggerids": "14062",
               "output": "extend",
               "selectFunctions": "extend"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "14062",
                   "expression": "{13513}<10m",
                   "description": "{HOST.NAME} ha sido reiniciado (tiempo de actividad < 10m)",
                   "url": "",
                   "status": "0",
                   "value": "0",
                   "priority": "2",
                   "lastchange": "0",
                   "comments": "El tiempo de actividad del host es menor a 10 minutos",
                   "error": "",
                   "templateid": "10016",
                   "type": "0",
                   "state": "0",
                   "flags": "0",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "event_name": "",
                   "uuid": "",
                   "url_name": "",
                   "functions": [
                       {
                           "functionid": "13513",
                           "itemid": "24350",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recuperar disparadores en estado de problema

Recuperar el ID, nombre y gravedad de todos los disparadores en estado de problema y ordenarlos por gravedad en orden descendente.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "output": [
                   "triggerid",
                   "description",
                   "priority"
               ],
               "filter": {
                   "value": 1
               },
               "sortfield": "priority",
               "sortorder": "DESC"
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13907",
                   "description": "Zabbix self-monitoring processes < 100% busy",
                   "priority": "4"
               },
               {
                   "triggerid": "13824",
                   "description": "Zabbix discoverer processes more than 75% busy",
                   "priority": "3"
               }
           ],
           "id": 1
       }

Recuperar un disparador específico con etiquetas

Recuperar un disparador específico con etiquetas.

Solicitud:

{
           "jsonrpc": "2.0",
           "method": "trigger.get",
           "params": {
               "output": [
                   "triggerid",
                   "description"
               ],
               "selectTags": "extend",
               "triggerids": [
                   "17578"
               ]
           },
           "id": 1
       }

Respuesta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "17370",
                   "description": "Service status",
                   "tags": [
                       {
                           "tag": "service",
                           "value": "{{ITEM.VALUE}.regsub(\"Service (.*) has stopped\", \"\\1\")}"
                       },
                       {
                           "tag": "error",
                           "value": ""
                       }
                   ]
               }
           ],
           "id": 1
       }

Véase también

Fuente

CTrigger::get() en ui/include/classes/api/services/CTrigger.php.