On this page
triggerprototype.get
Beschreibung
integer/array triggerprototype.get(object parameters)
Mit dieser Methode können Auslöser-Prototypen entsprechend den angegebenen Parametern abgerufen werden.
Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.
Parameter
(object) Parameter, die die gewünschte Ausgabe definieren.
Die Methode unterstützt die folgenden Parameter.
| Parameter | Type | Beschreibung |
|---|---|---|
| active | flag | Gibt nur aktivierte Auslöser-Prototypen zurück, die zu überwachten Hosts gehören. |
| discoveryids | ID/array | Gibt nur Auslöser-Prototypen zurück, die zu den angegebenen LLD-Regeln gehören. |
| functions | string/array | Gibt nur Auslöser zurück, die die angegebenen Funktionen verwenden. Eine Liste der unterstützten Funktionen finden Sie auf der Seite Supported functions. |
| group | string | Gibt nur Auslöser-Prototypen zurück, die zu Hosts oder Vorlagen aus den Host-Gruppen oder Vorlagen-Gruppen mit dem angegebenen Namen gehören. |
| groupids | ID/array | Gibt nur Auslöser-Prototypen zurück, die zu Hosts oder Vorlagen aus den angegebenen Host-Gruppen oder Vorlagen-Gruppen gehören. |
| host | string | Gibt nur Auslöser-Prototypen zurück, die zu Hosts mit dem angegebenen Namen gehören. |
| hostids | ID/array | Gibt nur Auslöser-Prototypen zurück, die zu den angegebenen Hosts gehören. |
| inherited | boolean | Wenn auf true gesetzt, werden nur Auslöser-Prototypen zurückgegeben, die von einer Vorlage geerbt wurden. |
| maintenance | boolean | Wenn auf true gesetzt, werden nur aktivierte Auslöser-Prototypen zurückgegeben, die zu Hosts in Wartung gehören. |
| min_severity | integer | Gibt nur Auslöser-Prototypen mit einem Schweregrad zurück, der größer oder gleich dem angegebenen Schweregrad ist. |
| monitored | flag | Gibt nur aktivierte Auslöser-Prototypen zurück, die zu überwachten Hosts gehören und nur aktivierte Datenpunkte enthalten. |
| templated | boolean | Wenn auf true gesetzt, werden nur Auslöser-Prototypen zurückgegeben, die zu Vorlagen gehören. |
| templateids | ID/array | Gibt nur Auslöser-Prototypen zurück, die zu den angegebenen Vorlagen gehören. |
| triggerids | ID/array | Gibt nur Auslöser-Prototypen mit den angegebenen IDs zurück. |
| expandExpression | flag | Erweitert Funktionen und Makros im Auslöser-Ausdruck. |
| selectDependencies | query | Gibt Auslöser-Prototypen und Auslöser, von denen der Auslöser-Prototyp abhängt, in der Eigenschaft dependencies zurück. |
| selectDiscoveryData | query | Gibt eine Eigenschaft discoveryData mit den Objektdaten der Auslöser-Prototyp-Erkennung zurück. Das Erkennungsobjekt des Auslöser-Prototyps verknüpft einen erkannten Auslöser-Prototypen mit einem Auslöser-Prototypen, von dem er erkannt wurde.Es hat die folgenden Eigenschaften: parent_triggerid - (ID) ID des Auslöser-Prototyps, aus dem der Auslöser-Prototyp erstellt wurde;status - (int) Erkennungsstatus des Auslöser-Prototyps:0 - (default) Auslöser-Prototyp ist erkannt, 1 - Auslöser-Prototyp wird nicht mehr erkannt; ts_delete - (timestamp) Zeitpunkt, zu dem ein Auslöser-Prototyp, der nicht mehr erkannt wird, gelöscht wird;ts_disable - (timestamp) Zeitpunkt, zu dem ein Auslöser-Prototyp, der nicht mehr erkannt wird, deaktiviert wird;disable_source - (int) Kennzeichen dafür, ob der Auslöser-Prototyp durch eine LLD-Regel oder manuell deaktiviert wurde:0 - (default) automatisch deaktiviert, 1 - durch eine LLD-Regel deaktiviert. |
| selectDiscoveryRule | query | Gibt die LLD-Regel, zu der der Auslöser-Prototyp gehört, in der Eigenschaft discoveryRule zurück. |
| selectDiscoveryRulePrototype | query | Gibt eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regelprototyp zurück, zu dem der Auslöser-Prototyp gehört. |
| selectFunctions | query | Gibt die im Auslöser-Prototyp verwendeten Funktionen in der Eigenschaft functions zurück.Die Funktionsobjekte stellen die im Auslöser-Ausdruck verwendeten Funktionen dar und haben die folgenden Eigenschaften: functionid - (ID) ID der Funktion;itemid - (ID) ID des in der Funktion verwendeten Datenpunkts;function - (string) Name der Funktion;parameter - (string) an die Funktion übergebener Parameter. Der Abfrageparameter wird in der zurückgegebenen Zeichenfolge durch das Symbol $ ersetzt. |
| selectHostGroups | query | Gibt die Host-Gruppen, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft hostgroups zurück. |
| selectHosts | query | Gibt die Hosts, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft hosts zurück. |
| selectInheritedTags | query | Gibt eine Eigenschaft inheritedTags mit Tags zurück, die von Vorlagen, verknüpften Vorlagen und Hosts sowie von Datenpunkt-Prototypen geerbt wurden, auf die in Auslöser- oder Wiederherstellungsausdrücken verwiesen wird. |
| selectItems | query | Gibt Datenpunkte und Datenpunkt-Prototypen, die vom Auslöser-Prototyp verwendet werden, in der Eigenschaft items zurück. |
| selectTags | query | Gibt die Tags des Auslöser-Prototyps in der Eigenschaft tags zurück. |
| selectTemplateGroups | query | Gibt die Vorlagen-Gruppen, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft templategroups zurück. |
| filter | object | Gibt nur die Ergebnisse zurück, die exakt dem angegebenen Filter entsprechen. Akzeptiert ein Objekt, bei dem die Schlüssel Eigenschaftsnamen sind und die Werte entweder ein einzelner Wert oder ein Array von Werten sind, mit denen abgeglichen werden soll. Unterstützt keine Eigenschaften des Datentyps text.Unterstützt zusätzliche Eigenschaften: host - technischer Name des Hosts, zu dem der Auslöser-Prototyp gehört;hostid - ID des Hosts, zu dem der Auslöser-Prototyp gehört. |
| limitSelects | integer | Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze. Gilt für die folgenden Unterabfragen: selectHosts - Ergebnisse werden nach host sortiert. |
| sortfield | string/array | Sortiert das Ergebnis nach den angegebenen Eigenschaften. Mögliche Werte: triggerid, description, status, priority, discovered. |
| countOutput | boolean | Diese Parameter sind in der Referenzkommentierung beschrieben. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Rückgabewerte
(integer/array) Gibt entweder Folgendes zurück:
- ein Array von Objekten;
- die Anzahl der abgerufenen Objekte, wenn der Parameter
countOutputverwendet wurde.
Beispiele
Auslöser-Prototypen aus einer LLD-Regel abrufen
Rufen Sie alle Auslöser-Prototypen und ihre Funktionen aus einer LLD-Regel ab.
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": "extend",
"selectFunctions": "extend",
"discoveryids": "22450"
},
"id": 1
}
Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "13272",
"expression": "{12598}<20",
"description": "Freie Inodes sind auf Volume {#FSNAME} kleiner als 20%",
"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": "Freier Festplattenspeicher ist auf Volume {#FSNAME} kleiner als 20%",
"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
}
Abrufen eines bestimmten Auslöser-Prototyps mit Tags
{
"jsonrpc": "2.0",
"method": "triggerprototype.get",
"params": {
"output": [
"triggerid",
"description"
],
"selectTags": "extend",
"triggerids": [
"17373"
]
},
"id": 1
}
Antwort:
{
"jsonrpc": "2.0",
"result": [
{
"triggerid": "17373",
"description": "Freier Festplattenspeicher ist auf Volume {#FSNAME} kleiner als 20%",
"tags": [
{
"tag": "volume",
"value": "{#FSNAME}"
},
{
"tag": "type",
"value": "{#FSTYPE}"
}
]
}
],
"id": 1
}
Siehe auch
Quelle
CTriggerPrototype::get() in ui/include/classes/api/services/CTriggerPrototype.php.