triggerprototype.get

Descrizione

integer/array triggerprototype.get(object parameters)

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

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare 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.

Parametro Tipo Descrizione
active flag Restituisce solo i prototipi di trigger abilitati appartenenti a host monitorati.
discoveryids ID/array Restituisce solo i prototipi di trigger appartenenti alle regole LLD specificate.
functions string/array Restituisce solo i trigger che utilizzano le funzioni specificate.

Per un elenco delle funzioni supportate, consultare la pagina Funzioni supportate.
group string Restituisce solo i prototipi di trigger appartenenti a host o template dei gruppi di host o dei gruppi di template con il nome specificato.
groupids ID/array Restituisce solo i prototipi di trigger appartenenti a host o template dei gruppi di host o dei gruppi di template specificati.
host string Restituisce solo i prototipi di trigger appartenenti agli host con il nome specificato.
hostids ID/array Restituisce solo i prototipi di trigger appartenenti agli host specificati.
inherited boolean Se impostato su true, restituisce solo i prototipi di trigger ereditati da un template.
maintenance boolean Se impostato su true, restituisce solo i prototipi di trigger abilitati appartenenti a host in manutenzione.
min_severity integer Restituisce solo i prototipi di trigger con una gravità maggiore o uguale a quella specificata.
monitored flag Restituisce solo i prototipi di trigger abilitati appartenenti a host monitorati e contenenti solo item abilitati.
templated boolean Se impostato su true, restituisce solo i prototipi di trigger appartenenti ai template.
templateids ID/array Restituisce solo i prototipi di trigger appartenenti ai template specificati.
triggerids ID/array Restituisce solo i prototipi di trigger con gli ID specificati.
expandExpression flag Espande le funzioni e le macro nell'espressione del trigger.
selectDependencies query Restituisce i prototipi di trigger e i trigger da cui dipende il prototipo di trigger nella proprietà dependencies.
selectDiscoveryData query Restituisce una proprietà discoveryData con i dati dell'oggetto di discovery del prototipo di trigger. L'oggetto di discovery del prototipo di trigger collega un prototipo di trigger rilevato al prototipo di trigger da cui è stato rilevato.

Presenta le seguenti proprietà:
parent_triggerid - (ID) ID del prototipo di trigger da cui è stato creato il prototipo di trigger;
status - (int) stato di discovery del prototipo di trigger:
0 - (predefinito) il prototipo di trigger è rilevato,
1 - il prototipo di trigger non è più rilevato;
ts_delete - (timestamp) momento in cui verrà eliminato un prototipo di trigger non più rilevato;
ts_disable - (timestamp) momento in cui verrà disabilitato un prototipo di trigger non più rilevato;
disable_source - (int) indicatore che specifica se il prototipo di trigger è stato disabilitato da una regola LLD o manualmente:
0 - (predefinito) disabilitato automaticamente,
1 - disabilitato da una regola LLD.
selectDiscoveryRule query Restituisce la regola LLD a cui appartiene il prototipo di trigger nella proprietà discoveryRule.
selectDiscoveryRulePrototype query Restituisce una proprietà discoveryRulePrototype con il prototipo della regola LLD padre a cui appartiene il prototipo di trigger.
selectFunctions query Restituisce le funzioni utilizzate nel prototipo di trigger nella proprietà functions.

Gli oggetti funzione rappresentano le funzioni utilizzate nell'espressione del trigger e presentano le seguenti proprietà:
functionid - (ID) ID della funzione;
itemid - (ID) ID dell'item utilizzato nella funzione;
function - (string) nome della funzione;
parameter - (string) parametro passato alla funzione. Il parametro della query viene sostituito dal simbolo $ nella stringa restituita.
selectHostGroups query Restituisce i gruppi di host a cui appartiene il prototipo di trigger nella proprietà hostgroups.
selectHosts query Restituisce gli host a cui appartiene il prototipo di trigger nella proprietà hosts.
selectInheritedTags query Restituisce una proprietà inheritedTags con i tag ereditati da template, template collegati e host, nonché dagli item e dai prototipi di item a cui si fa riferimento nelle espressioni del trigger o di recovery.
selectItems query Restituisce gli item e i prototipi di item utilizzati dal prototipo di trigger nella proprietà items.
selectTags query Restituisce i tag del prototipo di trigger nella proprietà tags.
selectTemplateGroups query Restituisce i gruppi di template a cui appartiene il prototipo di 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à del tipo di dati text.

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

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

Valori possibili: triggerid, description, status, priority, discovered.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce uno dei seguenti valori:

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

Esempi

Recuperare i prototipi di trigger da una regola LLD

Recupera tutti i prototipi di trigger e le relative funzioni da una regola LLD.

Richiesta:

{
    "jsonrpc": "2.0",
    "method": "triggerprototype.get",
    "params": {
        "output": "extend",
        "selectFunctions": "extend",
        "discoveryids": "22450"
    },
    "id": 1
}

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "13272",
            "expression": "{12598}<20",
            "description": "Free inodes is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "6ce467d05e8745409a177799bed34bb3",
            "url_name": "",
            "functions": [
                {
                    "functionid": "12598",
                    "itemid": "22454",
                    "triggerid": "13272",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        },
        {
            "triggerid": "13266",
            "expression": "{13500}<20",
            "description": "Free disk space is less than 20% on volume {#FSNAME}",
            "url": "",
            "status": "0",
            "value": "0",
            "priority": "2",
            "lastchange": "0",
            "comments": "",
            "error": "",
            "templateid": "0",
            "type": "0",
            "state": "0",
            "flags": "2",
            "recovery_mode": "0",
            "recovery_expression": "",
            "correlation_mode": "0",
            "correlation_tag": "",
            "manual_close": "0",
            "opdata": "",
            "discover": "0",
            "event_name": "",
            "uuid": "74a1fc62bfe24b7eabe4e244c70dc384",
            "url_name": "",
            "functions": [
                {
                    "functionid": "13500",
                    "itemid": "22686",
                    "triggerid": "13266",
                    "parameter": "$",
                    "function": "last"
                }
            ]
        }
    ],
    "id": 1
}

Recupero di uno specifico prototipo di trigger con tag

Richiesta:

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

Risposta:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "triggerid": "17373",
            "description": "Lo spazio libero su disco è inferiore al 20% sul volume {#FSNAME}",
            "tags": [
                {
                    "tag": "volume",
                    "value": "{#FSNAME}"
                },
                {
                    "tag": "type",
                    "value": "{#FSTYPE}"
                }
            ]
        }
    ],
    "id": 1
}

Vedi anche

Fonte

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