trigger.get

Descrizione

integer/array trigger.get(object parameters)

Il metodo consente di recuperare i trigger in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per richiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
triggerids ID/array Restituisce solo i trigger con gli ID specificati.
groupids ID/array Restituisce solo i trigger che appartengono a host o template dei gruppi host o dei gruppi template specificati.
templateids ID/array Restituisce solo i trigger che appartengono ai template specificati.
hostids ID/array Restituisce solo i trigger che appartengono agli host specificati.
itemids ID/array Restituisce solo i trigger che contengono gli item specificati.
functions string/array Restituisce solo i trigger che usano le funzioni specificate.

Consulta la pagina delle funzioni supportate per l'elenco delle funzioni supportate.
group string Restituisce solo i trigger che appartengono a host o template del gruppo host o del gruppo template con il nome specificato.
host string Restituisce solo i trigger che appartengono all'host con il nome tecnico specificato.
inherited boolean Se impostato su true, restituisce solo i trigger ereditati da un template.
templated boolean Se impostato su true, restituisce solo i trigger che appartengono ai template.
dependent boolean Se impostato su true, restituisce solo i trigger che hanno dipendenze. Se impostato su false, restituisce solo i trigger che non hanno dipendenze.
monitored flag Restituisce solo i trigger abilitati che appartengono a host monitorati e contengono solo item abilitati.
active flag Restituisce solo i trigger abilitati che appartengono a host monitorati.
maintenance boolean Se impostato su true, restituisce solo i trigger abilitati che appartengono a host in manutenzione.
withUnacknowledgedEvents flag Restituisce solo i trigger che hanno eventi non riconosciuti.
withAcknowledgedEvents flag Restituisce solo i trigger con tutti gli eventi riconosciuti.
withLastEventUnacknowledged flag Restituisce solo i trigger con l'ultimo evento non riconosciuto.
skipDependent flag Salta i trigger in stato di problema che dipendono da altri trigger. Nota che gli altri trigger vengono ignorati se sono disabilitati, hanno item disabilitati o host degli item disabilitati.
lastChangeSince timestamp Restituisce solo i trigger che hanno cambiato stato dopo l'ora specificata.
lastChangeTill timestamp Restituisce solo i trigger che hanno cambiato stato prima dell'ora specificata.
only_true flag Restituisce solo i trigger che sono stati recentemente in stato di problema.
min_severity integer Restituisce solo i trigger con severità maggiore o uguale a quella specificata.
evaltype integer Metodo di valutazione dei tag.

Valori possibili:
0 - (predefinito) And/Or;
2 - Or.
tags array Restituisce solo i trigger con i tag specificati.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vuoto restituisce tutti i trigger.

Valori possibili di operator:
0 - (predefinito) Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
expandComment flag Espande le macro nella descrizione del trigger.
expandDescription flag Espande le macro nel nome del trigger.
expandExpression flag Espande funzioni e macro nell'espressione del trigger.
selectHostGroups query Restituisce i gruppi host a cui appartiene il trigger nella proprietà hostgroups.
selectHosts query Restituisce gli host a cui appartiene il trigger nella proprietà hosts.
selectItems query Restituisce gli item contenuti nel trigger nella proprietà items.
selectFunctions query Restituisce le funzioni usate nel trigger nella proprietà functions.

Gli oggetti funzione rappresentano le funzioni usate nell'espressione del trigger e hanno le seguenti proprietà:
functionid - (ID) ID della funzione;
itemid - (ID) ID dell'item usato nella funzione;
function - (string) nome della funzione;
parameter - (string) parametro passato alla funzione. Il parametro della query viene sostituito dal simbolo $ nella stringa restituita.
selectDependencies query Restituisce i trigger da cui dipende il trigger nella proprietà dependencies.
selectDiscoveryData query Restituisce una proprietà discoveryData con i dati dell'oggetto di discovery del trigger. L'oggetto di discovery del trigger collega un trigger scoperto a un trigger prototype da cui è stato scoperto.

Ha le seguenti proprietà:
parent_triggerid - (ID) ID del trigger prototype da cui il trigger è stato creato;
status - (int) stato di discovery del trigger:
0 - (predefinito) il trigger è scoperto,
1 - il trigger non è più scoperto;
ts_delete - (timestamp) momento in cui un trigger non più scoperto verrà eliminato;
ts_disable - (timestamp) momento in cui un trigger non più scoperto verrà disabilitato;
disable_source - (int) indicatore che mostra se il trigger è stato disabilitato da una regola LLD o manualmente:
0 - (predefinito) disabilitato automaticamente,
1 - disabilitato da una regola LLD.
selectDiscoveryRule query Restituisce la regola di discovery a basso livello che ha creato il trigger nella proprietà discoveryRule.
selectLastEvent query Restituisce l'ultimo evento significativo del trigger nella proprietà lastEvent.
selectTags query Restituisce i tag del trigger nella proprietà tags.
selectTemplateGroups query Restituisce i gruppi template a cui appartiene il trigger nella proprietà templategroups.
filter object Restituisce solo i risultati che corrispondono esattamente al filtro specificato.

Accetta un oggetto in cui le chiavi sono nomi di proprietà e i valori sono un singolo valore o un array di valori da confrontare.

Non supporta le proprietà di tipo data type text.

Supporta proprietà aggiuntive:
host - nome tecnico dell'host a cui appartiene il trigger;
hostid - ID dell'host a cui appartiene il trigger.
limitSelects integer Limita il numero di record restituiti dalle sottoquery.

Si applica alle seguenti sottoquery:
selectHosts - i risultati saranno ordinati per host.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: triggerid, description, status, priority, lastchange, hostname.
countOutput boolean Questi parametri sono descritti nella reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectTriggerDiscovery query Restituisce l'oggetto di discovery del trigger nella proprietà triggerDiscovery. Gli oggetti di discovery del trigger collegano il trigger a un trigger prototype da cui è stato creato.

Questa query è deprecata, usa invece selectDiscoveryData.

Valori restituiti

(integer/array) Restituisce:

  • un array di oggetti;
  • il numero di oggetti recuperati, se è stato utilizzato il parametro countOutput.

Esempi

Recupero dei dati per ID trigger

Recupera tutti i dati e le funzioni utilizzate nel trigger "14062".

Request:

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

Response:

{
    "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",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recupero dei trigger nello stato di problema

Recupera l'ID, il nome e la gravità di tutti i trigger nello stato di problema e li ordina per gravità in ordine decrescente.

Richiesta:

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

Risposta:

{
    "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
}

Recupero di un trigger specifico con tag

Recupera un trigger specifico con tag.

Richiesta:

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

Risposta:

{
    "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
}

Vedi anche

Fonte

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