trigger.get

Descripción

integer/array trigger.get(object parameters)

El método permite recuperar triggers de acuerdo con 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 del rol de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

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

El método admite los siguientes parámetros.

Parameter Type Description
triggerids ID/array Devuelve solo triggers con los IDs dados.
groupids ID/array Devuelve solo triggers que pertenecen a hosts o templates de los grupos de hosts o grupos de templates dados.
templateids ID/array Devuelve solo triggers que pertenecen a los templates dados.
hostids ID/array Devuelve solo triggers que pertenecen a los hosts dados.
itemids ID/array Devuelve solo triggers que contienen los items dados.
functions string/array Devuelve solo triggers que usan las funciones dadas.

Consulte la página de funciones compatibles para obtener una lista de las funciones compatibles.
group string Devuelve solo triggers que pertenecen a hosts o templates del grupo de hosts o grupo de templates con el nombre dado.
host string Devuelve solo triggers que pertenecen al host con el nombre técnico dado.
inherited boolean Si se establece en true, devuelve solo triggers heredados de un template.
templated boolean Si se establece en true, devuelve solo triggers que pertenecen a templates.
dependent boolean Si se establece en true, devuelve solo triggers que tienen dependencias. Si se establece en false, devuelve solo triggers que no tienen dependencias.
monitored flag Devuelve solo triggers habilitados que pertenecen a hosts monitorizados y contienen solo items habilitados.
active flag Devuelve solo triggers habilitados que pertenecen a hosts monitorizados.
maintenance boolean Si se establece en true, devuelve solo triggers habilitados que pertenecen a hosts en mantenimiento.
withUnacknowledgedEvents flag Devuelve solo triggers que tienen eventos sin reconocer.
withAcknowledgedEvents flag Devuelve solo triggers con todos los eventos reconocidos.
withLastEventUnacknowledged flag Devuelve solo triggers con el último evento sin reconocer.
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 hosts de items deshabilitados.
lastChangeSince timestamp Devuelve solo triggers que han cambiado de estado después de la hora dada.
lastChangeTill timestamp Devuelve solo triggers que han cambiado de estado antes de la hora dada.
only_true flag Devuelve solo triggers que han estado recientemente en estado de problema (dentro del ok_period).
min_severity integer Devuelve solo triggers con severidad mayor o igual que la severidad dada.
evaltype integer Método de evaluación de etiquetas.

Valores posibles:
0 - (predeterminado) And/Or;
2 - Or.
tags array Devuelve solo 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 - (predeterminado) Contiene;
1 - Igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
expandComment flag Expande macros en la descripción del trigger.
expandDescription flag Expande macros en el nombre del trigger.
expandExpression flag Expande funciones y macros en la expresión del trigger.
selectHostGroups query Devuelve los grupos de hosts a los que pertenece el trigger en la propiedad hostgroups.
selectHosts query Devuelve los hosts a los que pertenece el trigger en la propiedad hosts.
selectItems query Devuelve los items contenidos por el trigger en la propiedad items.
selectFunctions query Devuelve 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 Devuelve los triggers de los que depende el trigger en la propiedad dependencies.
selectDiscoveryData query Devuelve una propiedad discoveryData con los datos del objeto de descubrimiento del trigger. El objeto de descubrimiento del trigger vincula un trigger descubierto con un prototipo de trigger del que fue descubierto.

Tiene las siguientes propiedades:
parent_triggerid - (ID) ID del prototipo de trigger a partir del cual se ha creado el trigger;
status - (int) estado del descubrimiento del trigger:
0 - (predeterminado) el trigger está descubierto,
1 - el trigger ya no está descubierto;
ts_delete - (timestamp) momento en que se eliminará un trigger que ya no está descubierto;
ts_disable - (timestamp) momento en que se deshabilitará un trigger que ya no está descubierto;
disable_source - (int) indicador de si el trigger fue deshabilitado por una regla LLD o manualmente:
0 - (predeterminado) deshabilitado automáticamente,
1 - deshabilitado por una regla LLD.
selectDiscoveryRule query Devuelve la regla de descubrimiento de bajo nivel que creó el trigger en la propiedad discoveryRule.
selectLastEvent query Devuelve el último evento significativo del trigger en la propiedad lastEvent.
selectTags query Devuelve las etiquetas del trigger en la propiedad tags.
inheritedTags boolean Devuelve triggers que tienen las etiquetas dadas también en template/host/linked templates.

Valores posibles:
true - template/host/linked templates también deben tener las etiquetas dadas;
false - (predeterminado) se ignoran las etiquetas de template/host/linked templates.
selectInheritedTags query Devuelve una propiedad inheritedTags con etiquetas heredadas de templates, linked templates y hosts, y de items referenciados en expresiones de trigger o recuperación.
selectTemplateGroups query Devuelve los grupos de templates a los que pertenece el trigger en la propiedad templategroups.
filter object Devuelve solo aquellos resultados que coinciden 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 de tipo de datos text.

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 los subselects.

Se aplica a los siguientes subselects:
selectHosts - los resultados se ordenarán por host.
sortfield string/array Ordena 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 del trigger en la propiedad triggerDiscovery. Los objetos de descubrimiento del trigger vinculan el trigger con un prototipo de trigger a partir del cual se creó.

Esta consulta está obsoleta; utilice 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 trigger

Recuperar todos los datos y las funciones utilizadas en el trigger "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} has been restarted (uptime < 10m)",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "The host uptime is less than 10 minutes",
            "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",
                    "triggerid": "14062",
                    "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 trigger específico con etiquetas

Recuperar un trigger 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\")}",
                    "automatic": "1"
                },
                {
                    "tag": "error",
                    "value": "",
                    "automatic": "1"
                }
            ]
        }
    ],
    "id": 1
}

Ver también

Fuente

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