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. Vedere Ruoli utente per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

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

Consultare la pagina Supported functions per un elenco delle funzioni supportate.
group string Restituisce solo i trigger prototype che appartengono a host o template dei gruppi host o gruppi template con il nome specificato.
groupids ID/array Restituisce solo i trigger prototype che appartengono a host o template dei gruppi host o gruppi template specificati.
host string Restituisce solo i trigger prototype che appartengono a host con il nome specificato.
hostids ID/array Restituisce solo i trigger prototype che appartengono agli host specificati.
inherited boolean Se impostato su true, restituisce solo i trigger prototype ereditati da un template.
maintenance boolean Se impostato su true, restituisce solo i trigger prototype abilitati che appartengono a host in manutenzione.
min_severity integer Restituisce solo i trigger prototype con severità maggiore o uguale a quella specificata.
monitored flag Restituisce solo i trigger prototype abilitati che appartengono a host monitorati e contengono solo item abilitati.
templated boolean Se impostato su true, restituisce solo i trigger prototype che appartengono a template.
templateids ID/array Restituisce solo i trigger prototype che appartengono ai template specificati.
triggerids ID/array Restituisce solo i trigger prototype con gli ID specificati.
expandExpression flag Espande funzioni e macro nell'espressione del trigger.
selectDependencies query Restituisce i trigger prototype e i trigger da cui dipende il trigger prototype nella proprietà dependencies.
selectDiscoveryRule query Restituisce la regola LLD a cui appartiene il trigger prototype nella proprietà discoveryRule.
selectFunctions query Restituisce le funzioni usate nel trigger prototype 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.
selectHostGroups query Restituisce i gruppi host a cui appartiene il trigger prototype nella proprietà hostgroups.
selectHosts query Restituisce gli host a cui appartiene il trigger prototype nella proprietà hosts.
selectItems query Restituisce gli item e gli item prototype usati dal trigger prototype nella proprietà items.
selectTags query Restituisce i tag del trigger prototype nella proprietà tags.
selectTemplateGroups query Restituisce i gruppi template a cui appartiene il trigger prototype 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 prototype;
hostid - ID dell'host a cui appartiene il trigger prototype.
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 nella reference commentary.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Questo parametro è deprecato, usare invece selectHostGroups o selectTemplateGroups.
Restituisce i gruppi host e i gruppi template a cui appartiene il trigger prototype nella proprietà groups.

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.