This is a translation of the original English documentation page. Help us make it better.

triggerprototype.get

Beschrijving

integer/array triggerprototype.get(object parameters)

Deze methode maakt het mogelijk om trigger-prototypes op te halen aan de hand van de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Toestemming om de methode op te roepen kan worden ingetrokken in de instellingen van gebruikersrollen. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter Type Beschrijving
active flag Alleen ingeschakelde trigger-prototypes retourneren die behoren tot gemonitorde hosts.
discoveryids string/array Alleen trigger-prototypes retourneren die behoren tot de opgegeven LLD-regels.
functions string/array Alleen trigger-prototypes retourneren die de opgegeven functies gebruiken.

Zie de Ondersteunde functies pagina voor een lijst van ondersteunde functies.
group string Alleen trigger-prototypes retourneren die behoren tot hosts of templates uit hostgroepen of sjabloongroepen met de opgegeven naam.
groupids string/array Alleen trigger-prototypes retourneren die behoren tot hosts of templates uit de opgegeven hostgroepen of sjabloongroepen.
host string Alleen trigger-prototypes retourneren die behoren tot hosts met de opgegeven naam.
hostids string/array Alleen trigger-prototypes retourneren die behoren tot de opgegeven hosts.
inherited boolean Indien ingesteld op true, alleen trigger-prototypes retourneren die geërfd zijn van een sjabloon.
maintenance boolean Indien ingesteld op true, alleen ingeschakelde trigger-prototypes retourneren die behoren tot hosts in onderhoud.
min_severity integer Alleen trigger-prototypes retourneren met ernst groter dan of gelijk aan de opgegeven ernst.
monitored flag Alleen ingeschakelde trigger-prototypes retourneren die behoren tot gemonitorde hosts en alleen ingeschakelde items bevatten.
templated boolean Indien ingesteld op true, alleen trigger-prototypes retourneren die behoren tot sjablonen.
templateids string/array Alleen trigger-prototypes retourneren die behoren tot de opgegeven sjablonen.
triggerids string/array Alleen trigger-prototypes retourneren met de opgegeven ID's.
expandExpression flag Functies en macro's uitbreiden in de trigger expressie.
selectDependencies query Retourneer trigger-prototypes en triggers waar de trigger-prototype van afhankelijk is in de dependencies eigenschap.
selectDiscoveryRule query Retourneer de LLD-regel waar het trigger-prototype toe behoort.
selectFunctions query Retourneer functies die in het trigger-prototype worden gebruikt in de functions eigenschap.

De functie-objecten vertegenwoordigen de functies die worden gebruikt in de trigger expressie en hebben de volgende eigenschappen:
functionid - (string) ID van de functie;
itemid - (string) ID van het item dat in de functie wordt gebruikt;
function - (string) naam van de functie;
parameter - (string) parameter doorgegeven aan de functie. Query parameter wordt vervangen door het $ symbool in de geretourneerde string.
selectHostGroups query Retourneer de hostgroepen waar het trigger-prototype toe behoort in de hostgroups eigenschap.
selectHosts query Retourneer de hosts waar het trigger-prototype toe behoort in de hosts eigenschap.
selectItems query Retourneer items en item-prototypes die in het trigger-prototype worden gebruikt in de items eigenschap.
selectTags query Retourneer de tags van het trigger-prototype in de tags eigenschap.
selectTemplateGroups query Retourneer de sjabloongroepen waar het trigger-prototype toe behoort in de templategroups eigenschap.
filter object Alleen die resultaten retourneren die precies overeenkomen met de opgegeven filter.
<brAccepteert een array waarbij de sleutels eigenschapsnamen zijn en de waarden ofwel een enkele waarde zijn of een array van waarden om tegenover te stellen.
<brOndersteunt extra filters:
host - technische naam van de host waartoe het trigger-prototype behoort;
hostid - ID van de host waartoe het trigger-prototype behoort.
limitSelects integer Beperkt het aantal records dat wordt geretourneerd door subselecties.
<brVan toepassing op de volgende subselecties:
selectHosts - resultaten worden gesorteerd op host.
sortfield string/array Sorteer het resultaat op basis van de opgegeven eigenschappen.
<brMogelijke waarden: triggerid, description, status, priority.
countOutput boolean Deze parameters, die algemeen zijn voor alle get methoden, worden in detail beschreven in de referentie toelichting.
editable boolean
excludeSearch boolean
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(verouderd)
query Deze parameter is verouderd, gebruik alstublieft selectHostGroups of selectTemplateGroups in plaats daarvan.
Retourneer de hostgroepen en sjabloongroepen waar het trigger-prototype toe behoort in de groups eigenschap.

Retourwaarden

(integer/array) Geeft ofwel:

  • een reeks objecten;
  • het aantal opgehaalde objecten, als de parameter countOutput is gebruikt.

Voorbeelden

Trigger prototypes ophalen vanuit een LLD-regel

Haal alle trigger-prototypes en hun functies op vanuit een LLD-regel.

Aanvraag:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "13272",
                   "expression": "{12598}<20",
                   "description": "Aantal vrije inodes is minder dan 20% op 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": "Aantal vrije schijfruimte is minder dan 20% op 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
       }

Het ophalen van een specifiek trigger-prototype met tags

Aanvraag:

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

Reactie:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "triggerid": "17373",
                   "description": "Aantal vrije schijfruimte is minder dan 20% op volume {#FSNAME}",
                   "tags": [
                       {
                           "tag": "volume",
                           "value": "{#FSNAME}"
                       },
                       {
                           "tag": "type",
                           "value": "{#FSTYPE}"
                       }
                   ]
               }
           ],
           "id": 1
       }

Zie ook

Bron

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