triggerprototype.get

Beschreibung

integer/array triggerprototype.get(object parameters)

Die Methode ermöglicht es Ihnen, Auslöser-Prototypen anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle widerrufen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
active flag Nur aktivierte Auslöser-Prototypen zurückgeben, die zu überwachten Hosts gehören.
discoveryids ID/array Nur Auslöser-Prototypen 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öser-Prototypen zurückgeben, die zu Hosts oder Vorlagen aus Hostgruppen oder Vorlagengruppen mit dem angegebenen Namen gehören.
groupids ID/array Nur Auslöser-Prototypen zurückgeben, die zu Hosts oder Vorlagen aus den angegebenen Hostgruppen oder Vorlagengruppen gehören.
host string Nur Auslöser-Prototypen zurückgeben, die zu Hosts mit dem angegebenen Namen gehören.
hostids ID/array Nur Auslöser-Prototypen zurückgeben, die zu den angegebenen Hosts gehören.
inherited boolean Wenn auf true gesetzt, nur von einer Vorlage geerbte Auslöser-Prototypen zurückgeben.
maintenance boolean Wenn auf true gesetzt, nur aktivierte Auslöser-Prototypen zurückgeben, die zu Hosts im Wartungsmodus gehören.
min_severity integer Nur Auslöser-Prototypen zurückgeben, deren Schweregrad größer oder gleich dem angegebenen Schweregrad ist.
monitored flag Nur aktivierte Auslöser-Prototypen zurückgeben, die zu überwachten Hosts gehören und ausschließlich aktivierte Datenpunkte enthalten.
templated boolean Wenn auf true gesetzt, nur Auslöser-Prototypen zurückgeben, die zu Vorlagen gehören.
templateids ID/array Nur Auslöser-Prototypen zurückgeben, die zu den angegebenen Vorlagen gehören.
triggerids ID/array Nur Auslöser-Prototypen mit den angegebenen IDs zurückgeben.
expandExpression flag Funktionen und Makros im Auslöserausdruck erweitern.
selectDependencies query Auslöser-Prototypen und Auslöser, von denen der Auslöser-Prototyp abhängt, in der Eigenschaft dependencies zurückgeben.
selectDiscoveryData query Eine Eigenschaft discoveryData mit den Daten des Discovery-Objekts des Auslöser-Prototyps zurückgeben. Das Discovery-Objekt des Auslöser-Prototyps verknüpft einen erkannten Auslöser-Prototyp mit dem Auslöser-Prototyp, aus dem er erkannt wurde.

Es verfügt über die folgenden Eigenschaften:
parent_triggerid - (ID) ID des Auslöser-Prototyps, aus dem der Auslöser-Prototyp erstellt wurde;
status - (int) Discovery-Status des Auslöser-Prototyps:
0 - (Standard) Auslöser-Prototyp wurde erkannt,
1 - Auslöser-Prototyp wird nicht mehr erkannt;
ts_delete - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Auslöser-Prototyp gelöscht wird;
ts_disable - (timestamp) Zeitpunkt, zu dem ein nicht mehr erkannter Auslöser-Prototyp deaktiviert wird;
disable_source - (int) Gibt an, ob der Auslöser-Prototyp durch eine LLD-Regel oder manuell deaktiviert wurde:
0 - (Standard) automatisch deaktiviert,
1 - durch eine LLD-Regel deaktiviert.
selectDiscoveryRule query Die LLD-Regel, zu der der Auslöser-Prototyp gehört, in der Eigenschaft discoveryRule zurückgeben.
selectDiscoveryRulePrototype query Eine Eigenschaft discoveryRulePrototype mit dem übergeordneten LLD-Regel-Prototyp zurückgeben, zu dem der Auslöser-Prototyp gehört.
selectFunctions query Die im Auslöser-Prototyp verwendeten Funktionen in der Eigenschaft functions zurückgeben.

Die Funktionsobjekte stellen die im Auslöserausdruck verwendeten Funktionen dar und verfügen über 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 Die Hostgruppen, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft hostgroups zurückgeben.
selectHosts query Die Hosts, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft hosts zurückgeben.
selectInheritedTags query Eine Eigenschaft inheritedTags mit von Vorlagen, verknüpften Vorlagen und Hosts geerbten Tags sowie mit Tags aus Datenpunkten und Datenpunkt-Prototypen zurückgeben, auf die in Auslöser- oder Wiederherstellungsausdrücken verwiesen wird.
selectItems query Die im Auslöser-Prototyp verwendeten Datenpunkte und Datenpunkt-Prototypen in der Eigenschaft items zurückgeben.
selectTags query Die Tags des Auslöser-Prototyps in der Eigenschaft tags zurückgeben.
selectTemplateGroups query Die Vorlagengruppen, zu denen der Auslöser-Prototyp gehört, in der Eigenschaft templategroups zurückgeben.
filter object Nur Ergebnisse zurückgeben, die exakt dem angegebenen Filter entsprechen.

Akzeptiert ein Objekt, dessen Schlüssel Eigenschaftsnamen und dessen 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 Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: triggerid, description, status, priority, discovered.
countOutput boolean Diese Parameter werden im Referenzkommentar 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

Auslöser-Prototypen aus einer LLD-Regel abrufen

Rufen Sie alle Auslöser-Prototypen 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": "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

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.