Sidebar
Table of Contents
triggerprototype.get
Beschrijving
integer/array triggerprototype.get(objectparameters)
De methode maakt het mogelijk om trigger-prototypes op te halen volgens de gegeven parameters.
Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen voor meer informatie.
Parameters
(object) Parameters die de gewenste uitvoer definiëren.
De methode ondersteunt de volgende parameters.
| Parameter | Type | Beschrijving |
|---|---|---|
| active | flag | Retourneer alleen geactiveerde trigger-prototypes die behoren tot bewaakte hosts. |
| discoveryids | string/array | Retourneer alleen trigger-prototypes die behoren tot de gegeven LLD-regels. |
| functions | string/array | Retourneer alleen triggers die de opgegeven functies gebruiken. Raadpleeg de pagina ondersteunde triggerfuncties voor een lijst met ondersteunde functies. |
| group | string | Retourneer alleen trigger-prototypes die behoren tot hosts van de hostgroepen met de opgegeven naam. |
| groupids | string/array | Retourneer alleen trigger-prototypes die behoren tot hosts van de gegeven hostgroepen. |
| host | string | Retourneer alleen trigger-prototypes die behoren tot hosts met de opgegeven naam. |
| hostids | string/array | Retourneer alleen trigger-prototypes die bij de opgegeven hosts horen. |
| inherited | boolean | Indien ingesteld op true retourneer je alleen prototypes die zijn overgenomen van een sjabloon. |
| maintenance | boolean | Indien ingesteld op true retourneer alleen geactiveerde trigger-prototypes die behoren tot hosts in onderhoud. |
| min_severity | integer | Return alleen trigger-prototypes met een ernst groter of gelijk aan de opgegeven ernst. |
| monitored | flag | Retourneer alleen geactiveerde trigger-prototypes die behoren tot gecontroleerde hosts en alleen geactiveerde items bevatten. |
| template | boolean | Indien ingesteld op true, worden alleen prototypes geactiveerd die bij sjablonen horen. |
| templateids | string/array | Retourneer alleen trigger-prototypes die bij de opgegeven sjablonen horen. |
| triggerids | string/array | Retourneer alleen trigger-prototypes met de opgegeven ID's. |
| expandExpression | flag | Breid functies en macro's uit in de trigger-expressie. |
| selectDependencies | query | Retourneer trigger-prototypes en triggers waarvan het trigger-prototype afhankelijk is in de eigenschap dependencies. |
| selectDiscoveryRule | query | Retourneer de LLD-regel waartoe het trigger-prototype behoort. |
| selectFunctions | query | Retourneert functies die in het trigger-prototype worden gebruikt in de eigenschap functions.De functie-objecten vertegenwoordigen de functies die in de trigger-expressie worden gebruikt 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. De queryparameter wordt vervangen door het $-symbool in de geretourneerde tekenreeks. |
| selectGroups | query | Retourneer de hostgroepen waartoe het triggerprototype behoort in de eigenschap groups. |
| selectHosts | query | Retourneer de hosts waartoe het trigger-prototype behoort in de eigenschap hosts. |
| selectItems | query | Retouritems en item-prototypes gebruikten het trigger-prototype in de eigenschap items. |
| selectTags | query | Retourneer de trigger-prototype-tags in de eigenschap tags. |
| filter | object | Retourneert alleen die resultaten die exact overeenkomen met het opgegeven filter. Accepteert een array, waarbij de sleutels eigenschapsnamen zijn en de waarden een enkele waarde zijn of een array van waarden om mee te vergelijken. Ondersteunt 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. Van toepassing op de volgende subselecties: selectHosts - resultaten worden gesorteerd op host. |
| sortfield | string/array | Sorteer het resultaat op de gegeven eigenschappen. Mogelijke waarden zijn: triggerid, description, status en priority. |
| countOutput | boolean | Deze parameters gelden voor alle get-methoden en worden in detail beschreven in de referentiecommentaar. |
| editable | booleaans | |
| excludeSearch | boolean | |
| limiet | geheel getal | |
| uitvoer | query | |
| preservekeys | boolean | |
| zoeken | object | |
| searchByAny | boolean | |
| searchWildcardsIngeschakeld | boolean | |
| sortorde | string/array | |
| startZoeken | booleaans |
Retourwaarden
(integer/array) Retourneert ofwel:
- een reeks objecten;
- het aantal opgehaalde objecten, als de parameter
countOutputis gebruikt.
Voorbeelden
Trigger-prototypes ophalen uit een LLD-regel
Haal alle trigger-prototypes en hun functies op uit een LLD-regel.
Verzoek:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "extend",
"selectFunctions": "extend",
"discoveryids": "22450"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13272",
"expression": "{12598}<20",
"description": "Free inodes is less than 20% on volume {#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": "Free disk space is less than 20% on volume {#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
}Een specifiek trigger-prototype ophalen met tags
Verzoek:
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
]
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Antwoord:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "17373",
"description": "Free disk space is less than 20% on 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.