triggerprototype.get

Beschreibung

integer/array triggerprototype.get(object parameters)

Die Methode ermöglicht das Abrufen von Auslöser-Prototypen anhand der angegebenen Parameter.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufruf der Methode kann 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 Typ Beschreibung
active flag Nur aktivierte Auslöserprototypen zurückgeben, die zu überwachten Hosts gehören.
discoveryids ID/array Nur Auslöserprototypen zurückgeben, die zu den angegebenen LLD-Regeln gehören.
functions string/array Nur Auslöser zurückgeben, die die angegebenen Funktionen verwenden.

Eine Liste der unterstützten Funktionen finden Sie auf der Seite Unterstützte Funktionen.
group string Nur Auslöserprototypen zurückgeben, die zu Hosts oder Vorlagen aus den Hostgruppen oder Vorlagengruppen mit dem angegebenen Namen gehören.
groupids ID/array Nur Auslöserprototypen zurückgeben, die zu Hosts oder Vorlagen aus den angegebenen Hostgruppen oder Vorlagengruppen gehören.
host string Nur Auslöserprototypen zurückgeben, die zu Hosts mit dem angegebenen Namen gehören.
hostids ID/array Nur Auslöserprototypen zurückgeben, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, nur von einer Vorlage geerbte Auslöserprototypen zurückgeben.
maintenance boolean Wenn auf true gesetzt, nur aktivierte Auslöserprototypen zurückgeben, die zu Hosts in Wartung gehören.
min_severity integer Nur Auslöserprototypen mit einer Schwere größer oder gleich der angegebenen Schwere zurückgeben.
monitored flag Nur aktivierte Auslöserprototypen zurückgeben, die zu überwachten Hosts gehören und nur aktivierte Datenpunkte enthalten.
templated boolean Wenn auf true gesetzt, nur Auslöserprototypen zurückgeben, die zu Vorlagen gehören.
templateids ID/array Nur Auslöserprototypen zurückgeben, die zu den angegebenen Vorlagen gehören.
triggerids ID/array Nur Auslöserprototypen mit den angegebenen IDs zurückgeben.
expandExpression flag Funktionen und Makros im Auslöserausdruck erweitern.
selectDependencies query Auslöserprototypen und Auslöser zurückgeben, von denen der Auslöserprototyp in der Eigenschaft dependencies abhängt.
selectDiscoveryData query Eine Eigenschaft discoveryData mit den Daten des Discovery-Objekts des Auslöserprototyps zurückgeben. Das Discovery-Objekt des Auslöserprototyps verknüpft einen entdeckten Auslöserprototyp mit einem Auslöserprototyp, aus dem er entdeckt wurde.

Es hat die folgenden Eigenschaften:
parent_triggerid - (ID) ID des Auslöserprototyps, aus dem der Auslöserprototyp erstellt wurde;
status - (int) Status der Discovery des Auslöserprototyps:
0 - (Standard) Auslöserprototyp ist entdeckt,
1 - Auslöserprototyp ist nicht mehr entdeckt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Auslöserprototyp gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr entdeckter Auslöserprototyp deaktiviert wird;
disable_source - (int) Kennzeichnung, ob der Auslöserprototyp durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Die LLD-Regel zurückgeben, zu der der Auslöserprototyp in der Eigenschaft discoveryRule gehört.
selectDiscoveryRulePrototype query Eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regelprototyp zurückgeben, zu dem der Auslöserprototyp gehört.
selectFunctions query Die im Auslöserprototyp verwendeten Funktionen in der Eigenschaft functions zurückgeben.

Die Funktionsobjekte stellen die im Auslöserausdruck 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 im zurückgegebenen String durch das Symbol $ ersetzt.
selectHostGroups query Die Hostgruppen zurückgeben, zu denen der Auslöserprototyp in der Eigenschaft hostgroups gehört.
selectHosts query Die Hosts zurückgeben, zu denen der Auslöserprototyp in der Eigenschaft hosts gehört.
selectItems query Datenpunkte und Datenpunktprototypen zurückgeben, die vom Auslöserprototyp in der Eigenschaft items verwendet werden.
selectTags query Die Tags des Auslöserprototyps in der Eigenschaft tags zurückgeben.
selectTemplateGroups query Die Vorlagengruppen zurückgeben, zu denen der Auslöserprototyp in der Eigenschaft templategroups gehört.
filter object Nur Ergebnisse zurückgeben, die genau 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 verglichen werden soll.

Unterstützt keine Eigenschaften des Datentyps text.

Unterstützt zusätzliche Eigenschaften:
host - technischer Name des Hosts, zu dem der Auslöserprototyp gehört;
hostid - ID des Hosts, zu dem der Auslöserprototyp 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 Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: triggerid, description, status, priority, discovered.
countOutput boolean Diese Parameter werden in der Referenzdokumentation 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 countOutput verwendet wurde.

Beispiele

Abrufen von Auslöservorlagen aus einer LLD-Regel

Rufen Sie alle Auslöservorlagen und ihre Funktionen aus einer LLD-Regel ab.

Anfrage:

{
    "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": "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
}

Abrufen eines bestimmten Auslöser-Prototyps mit Tags

Anfrage:

{
    "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.