triggerprototype.get

Descripció

integer/array triggerprototype.get(object parameters)

El mètode permet recuperar prototips de triggers segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida esperada.

el mètode admet els paràmetres següents.

Paràmetre Tipus Descripció
active flag Retorna només els prototips activats que pertanyen als equips monitoritzats.
discoveryids ID/array Retorna només prototips de triggers que pertanyen a les regles LLD donades.
functions string/array Retorna només triggers que empren les funcions donades.

Consulteu la pàgina trigger functions per obtindre una llista de funcions admeses.
grup string Retorna només prototips de triggers que pertanyen als equips dels grups donats.
groupids ID/array Retorna només prototips de triggers que pertanyen als equips dels grups donats.
host string Retorna només prototips de triggers que pertanyen als equips donats.
hostids ID/array Retorna només els prototips de triggers que pertanyen als equips donats.
inherited boolean Si s'estableix a true, només retorna els prototips de triggers heretats d'una plantilla.
manteinance boolean Si s'estableix a true, només es retornen els prototips de triggers que pertanyen als equips en manteniment.
min_severity integer Retorn només els prototips de triggers la gravetat dels quals és superior o igual a la gravetat donada.
monitored flag Retorna només prototips de triggers activats que pertanyen a equips supervisats i que només contenen elements activats.
template boolean Si s'estableix com a true, només retorna prototips de triggers que pertanyen a plantilles.
templateids string/array Retorna només prototips de triggers que pertanyen a les plantilles donades.
triggerids string/array Retorna només els prototips de triggers amb els ID donats.
expandExpression flag Amplieu les funcions i les macros a l'expressió de trigger.
selectDependencies query Retorna els prototips del trigger i els triggers dels quals depèn el prototip del trigger a la propietat dependencies.
selectDiscoveryRule query Retorna la regla LLD a la qual pertany el prototip del trigger.
selectFunctions query Retorna les funcions emprades en el prototip de trigger a la propietat functions.

Els objectes de funció representen les funcions emprades a l'expressió de trigger i tenen les propietats següents:
functionid - (ID) ID de la funció;
itemid - (ID) ID de l'element emprat a la funció;
funció - (string) nom de la funció;
paràmetre - El paràmetre (string) que s'ha passat a la funció. El paràmetre de consulta es substitueix pel símbol $ a la cadena retornada.
selectHostGroups query Retorna els grups d'equips als quals pertany el prototip del trigger a la propietat hostgroups.
selectHosts query Retorna els equips als quals pertany el prototip de trigger a la propietat equips.
selectItems query Retorna els elements i els prototips d'elements emprats pel prototip de trigger a la propietat elements.
selectTags query Retorna les etiquetes del prototip de trigger a la propietat etiquetes.
selectTemplateGroups query Retorna els grups de plantilles als quals pertany el prototip del trigger a la propietat templategroups.
filter object Només retorna resultats que coincideixen exactament amb el filtre donat.

Accepta una matriu on les claus són noms de propietat i els valors són un valor únic o una matriu de valors per comparar.< br>
Compatibilitat amb filtres addicionals:
host - nom tècnic de l'equip al qual pertany el prototip de trigger;
hostid - ID de l'equip al qual pertany el prototip de trigger.
limitSelects integer Limita el nombre de registres retornats per les subconsultes.

S'aplica a les subseleccions següents:
selectHosts: els resultats s'ordenaran per host.
sortfield string/array Ordena el resultat per les propietats donades.

Valors possibles: triggerid, description, status i priority.
countOutput boolean Aquests paràmetres, comuns a tots els mètodes get, es descriuen als comentaris de referència.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(obsolet)
query Aquest paràmetre és obsolet; si us plau, emprau selectHostGroups o selectTemplateGroups en el seu lloc.
Retorna els grups d'equips i els grups de plantilles on el trigger pertany a la propietat groups.

Valors de retorn

(integer/array) Retorna un d'entre:

  • una taula d'objectes;
  • el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar prototips de triggers a partir d'una regla LLD

Recupera tots els prototips de triggers i les seves funcions a partir d'una regla LLD.

Petició:

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

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Els inodes lliures són inferiors al 20% al volum {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "12598",
                           "itemid": "22454",
                           "triggerid": "13272",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               },
               {
                   "triggerid": "13266",
                   "expression": "{13500}<20",
                   "description": "L'espai lliure de disc és inferior al 20% al volum {#FSNAME}",
                   "url": "",
                   "status": "0",
                   "priority": "2",
                   "comments": "",
                   "templateid": "0",
                   "type": "0",
                   "flags": "2",
                   "recovery_mode": "0",
                   "recovery_expression": "",
                   "correlation_mode": "0",
                   "correlation_tag": "",
                   "manual_close": "0",
                   "opdata": "",
                   "discover": "0",
                   "functions": [
                       {
                           "functionid": "13500",
                           "itemid": "22686",
                           "triggerid": "13266",
                           "parameter": "$",
                           "function": "last"
                       }
                   ]
               }
           ],
           "id": 1
       }

Recuperar un prototip de trigger específic amb etiquetes

Petició:

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

Resposta:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "17373",
                   "description": "L'espai lliure de disc és inferior al 20% al volum {#FSNAME}",
                   "tags": [
                       {
                           "tag": "volume",
                           "value": "{#FSNAME}"
                       },
                       {
                           "tag": "type",
                           "value": "{#FSTYPE}"
                       }
                   ]
               }
           ],
           "id": 1
       }

Veieu també

Font

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