triggerprototype.get

Descrizione

integer/array triggerprototype.get(object parameters)

Il metodo consente di recuperare i prototipi di trigger 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.

Parameter Type Description
active flag Restituisce solo i prototipi di trigger abilitati che appartengono a host monitorati.
discoveryids ID/array Restituisce solo i prototipi di trigger che appartengono alle regole LLD specificate.
functions string/array Restituisce solo i trigger che usano le funzioni specificate.

Per un elenco delle funzioni supportate, consulta la pagina Supported functions.
group string Restituisce solo i prototipi di trigger che appartengono a host o template dei gruppi host o dei gruppi template con il nome specificato.
groupids ID/array Restituisce solo i prototipi di trigger che appartengono a host o template dei gruppi host o dei gruppi template specificati.
host string Restituisce solo i prototipi di trigger che appartengono a host con il nome specificato.
hostids ID/array Restituisce solo i prototipi di trigger che appartengono 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 che appartengono a host in manutenzione.
min_severity integer Restituisce solo i prototipi di trigger con severità maggiore o uguale a quella specificata.
monitored flag Restituisce solo i prototipi di trigger abilitati che appartengono a host monitorati e contengono solo item abilitati.
templated boolean Se impostato su true, restituisce solo i prototipi di trigger che appartengono a template.
templateids ID/array Restituisce solo i prototipi di trigger che appartengono ai template specificati.
triggerids ID/array Restituisce solo i prototipi di trigger con gli ID specificati.
expandExpression flag Espande funzioni e macro nell'espressione del trigger.
selectDependencies query Restituisce i prototipi di trigger e i trigger da cui il prototipo di trigger dipende 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 scoperto al prototipo di trigger da cui è stato scoperto.

Ha 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 - (default) il prototipo di trigger è scoperto,
1 - il prototipo di trigger non è più scoperto;
ts_delete - (timestamp) momento in cui un prototipo di trigger che non è più scoperto verrà eliminato;
ts_disable - (timestamp) momento in cui un prototipo di trigger che non è più scoperto verrà disabilitato;
disable_source - (int) indicatore che specifica se il prototipo di trigger è stato disabilitato da una regola LLD o manualmente:
0 - (default) 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 usate nel prototipo di 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 di query viene sostituito dal simbolo $ nella stringa restituita.
selectHostGroups query Restituisce i gruppi 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.
selectItems query Restituisce gli item e i prototipi di item usati dal prototipo di trigger nella proprietà items.
selectTags query Restituisce i tag del prototipo di trigger nella proprietà tags.
selectTemplateGroups query Restituisce i gruppi 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 oppure un array di valori da confrontare.

Non supporta le proprietà di tipo text data type.

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 sotto-selezioni.

Si applica alle seguenti sotto-selezioni:
selectHosts - i risultati saranno 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 reference commentary.
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 trigger prototype da una regola LLD

Recupera tutti i trigger prototype 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",
                    "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",
                    "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.