template.get

Beschreibung

integer/array template.get(object parameters)

Die Methode ermöglicht das Abrufen von Vorlagen entsprechend den angegebenen Parametern.

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, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
templateids ID/array Nur Vorlagen mit den angegebenen Vorlagen-IDs zurückgeben.
groupids ID/array Nur Vorlagen zurückgeben, die zu den angegebenen Vorlagengruppen gehören.
parentTemplateids ID/array Nur Vorlagen zurückgeben, mit denen die angegebene Vorlage verknüpft ist.
hostids ID/array Nur Vorlagen zurückgeben, die mit den angegebenen Hosts/Vorlagen verknüpft sind.
graphids ID/array Nur Vorlagen zurückgeben, die die angegebenen Diagramme enthalten.
itemids ID/array Nur Vorlagen zurückgeben, die die angegebenen Datenpunkte enthalten.
triggerids ID/array Nur Vorlagen zurückgeben, die die angegebenen Auslöser enthalten.
with_items flag Nur Vorlagen zurückgeben, die Datenpunkte haben.
with_triggers flag Nur Vorlagen zurückgeben, die Auslöser haben.
with_graphs flag Nur Vorlagen zurückgeben, die Diagramme haben.
with_httptests flag Nur Vorlagen zurückgeben, die Webszenarien haben.
evaltype integer Tag-Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
tags object/array Nur Vorlagen mit den angegebenen Tags zurückgeben.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Ein leeres Array gibt alle Vorlagen zurück.

Mögliche Operator-Werte:
0 - (Standard) Enthält;
1 - Entspricht;
2 - Enthält nicht;
3 - Entspricht nicht;
4 - Existiert;
5 - Existiert nicht.
selectTags query Vorlagen-Tags in der Eigenschaft tags zurückgeben.
selectHosts query Die Hosts zurückgeben, die mit der Vorlage in der Eigenschaft hosts verknüpft sind.

Unterstützt count.
selectTemplateGroups query Die Vorlagengruppen zurückgeben, zu denen die Vorlage in der Eigenschaft templategroups gehört.
selectTemplates query Vorlagen zurückgeben, mit denen die angegebene Vorlage in der Eigenschaft templates verknüpft ist.

Unterstützt count.
selectParentTemplates query Vorlagen zurückgeben, die mit der angegebenen Vorlage in der Eigenschaft parentTemplates verknüpft sind.

Unterstützt count.
selectHttpTests query Die Webszenarien aus der Vorlage in der Eigenschaft httpTests zurückgeben.

Unterstützt count.
selectItems query Die Datenpunkte aus der Vorlage in der Eigenschaft items zurückgeben.

Unterstützt count.
selectDiscoveries query Low-Level-Discoveries aus der Vorlage in der Eigenschaft discoveries zurückgeben.

Unterstützt count.
selectTriggers query Die Auslöser aus der Vorlage in der Eigenschaft triggers zurückgeben.

Unterstützt count.
selectGraphs query Die Diagramme aus der Vorlage in der Eigenschaft graphs zurückgeben.

Unterstützt count.
selectMacros query Die Makros aus der Vorlage in der Eigenschaft macros zurückgeben.
selectDashboards query Die Dashboards aus der Vorlage in der Eigenschaft dashboards zurückgeben.

Unterstützt count.
selectValueMaps query Eine Eigenschaft valuemaps mit Vorlagen-Wertzuordnungen zurückgeben.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectTemplates - Ergebnisse werden nach name sortiert;
selectHosts - sortiert nach host;
selectParentTemplates - sortiert nach host;
selectItems - sortiert nach name;
selectDiscoveries - sortiert nach name;
selectTriggers - sortiert nach description;
selectGraphs - sortiert nach name;
selectDashboards - sortiert nach name.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: hostid, host, name, status.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectGroups
(deprecated)		 query Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen selectTemplateGroups.
Die Vorlagengruppen zurückgeben, zu denen die Vorlage in der Eigenschaft groups gehört.

Rückgabewerte

(integer/array) Gibt entweder zurück:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Vorlagen nach Namen abrufen

Rufen Sie alle Daten zu zwei Vorlagen mit den Namen "Linux" und "Windows" ab.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": "extend",
        "filter": {
            "host": [
                "Linux",
                "Windows"
            ]
        }
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxyid": "0",
            "host": "Linux",
            "status": "3",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "0",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Linux",
            "flags": "0",
            "templateid": "10001",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "uuid": "282ffe33afc74cccaf1524d9aa9dc502"
        },
        {
            "proxyid": "0",
            "host": "Windows",
            "status": "3",
            "disable_until": "0",
            "error": "",
            "available": "0",
            "errors_from": "0",
            "lastaccess": "0",
            "ipmi_authtype": "0",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "ipmi_disable_until": "0",
            "ipmi_available": "0",
            "snmp_disable_until": "0",
            "snmp_available": "0",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "ipmi_errors_from": "0",
            "snmp_errors_from": "0",
            "ipmi_error": "",
            "snmp_error": "",
            "jmx_disable_until": "0",
            "jmx_available": "0",
            "jmx_errors_from": "0",
            "jmx_error": "",
            "name": "Windows",
            "flags": "0",
            "templateid": "10081",
            "description": "",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "uuid": "522d17e1834049be879287b7c0518e5d"
        }
    ],
    "id": 1
}

Abrufen von Vorlagengruppen

Rufen Sie die Vorlagengruppen ab, deren Mitglied die Vorlage „Linux by Zabbix Agent“ ist.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": ["hostid"],
        "selectTemplateGroups": "extend",
        "filter": {
            "host": [
                "Linux by Zabbix agent"
            ]
        }
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10001",
            "templategroups": [
                {
                    "groupid": "10",
                    "name": "Templates/Operating systems",
                    "uuid": "846977d1dfed4968bc5f8bdb363285bc"
                }
            ]
        }
    ],
    "id": 1
}

Hosts nach Vorlage abrufen

Rufen Sie Hosts ab, mit denen die Vorlage „10001“ (Linux by Zabbix agent) verknüpft ist.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": "templateid",
        "templateids": "10001",
        "selectHosts": ["hostid", "name"]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "templateid": "10001",
            "hosts": [
                {
                    "hostid": "10084",
                    "name": "Zabbix server"
                },
                {
                    "hostid": "10603",
                    "name": "Host 1"
                },
                {
                    "hostid": "10604",
                    "name": "Host 2"
                }
            ]
        }
    ],
    "id": 1
}

Suche nach Vorlagen-Tags

Ruft Vorlagen ab, die das Tag "host-name" mit dem Wert "{HOST.NAME}" haben.

Anfrage:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "host-name",
                "value": "{HOST.NAME}",
                "operator": 1
            }
        ]
    },
    "id": 1
}

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "hostid": "10402",
            "tags": [
                {
                    "tag": "host-name",
                    "value": "{HOST.NAME}"
                }
            ]
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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