template.get

Beschreibung

integer/array template.get(object parameters)

Die Methode ermöglicht es Ihnen, Vorlagen anhand der angegebenen Parameter abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigung zum Aufrufen der Methode kann 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 Graphen 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 Graphen 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 Werte für Operatoren:
0 - (Standard) Enthält;
1 - Ist gleich;
2 - Enthält nicht;
3 - Ist nicht gleich;
4 - Existiert;
5 - Existiert nicht.
inheritedTags boolean Vorlagen zurückgeben, die die angegebenen tags auch in verknüpften Vorlagen haben.

Mögliche Werte:
true - Verknüpfte Vorlagen müssen die angegebenen Tags ebenfalls haben;
false - (Standard) Tags aus verknüpften Vorlagen werden ignoriert.
selectInheritedTags query Eine inheritedTags-Eigenschaft mit Tags zurückgeben, die in verknüpften Vorlagen vorhanden sind.
selectTags query Vorlagen-Tags in der tags-Eigenschaft zurückgeben.
selectDiscoveryRules query Eine discoveryRules-Eigenschaft mit LLD-Regeln der Vorlage zurückgeben.

Unterstützt count.
selectHosts query Die Hosts, die mit der Vorlage verknüpft sind, in der hosts-Eigenschaft zurückgeben.

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

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

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

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

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

Unterstützt count.
selectGraphs query Graphen der Vorlage in der graphs-Eigenschaft zurückgeben.

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

Unterstützt count.
selectValueMaps query Eine valuemaps-Eigenschaft mit Wertzuordnungen der Vorlage 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;
selectDiscoveryRules - 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 Referenzdokumentation beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectDiscoveries query Low-Level-Entdeckungen der Vorlage in der discoveries-Eigenschaft zurückgeben.

Unterstützt count.

Diese Abfrage ist veraltet. Verwenden Sie stattdessen selectDiscoveryRules.

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

Vorlagen nach Namen abrufen

Rufen Sie alle Daten zu zwei Vorlagen mit den Namen „Linux by Zabbix Agent“ und „Windows by Zabbix Agent“ ab.

Anfrage:

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

Antwort:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxyid": "0",
            "host": "Linux by Zabbix agent",
            "status": "3",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Linux by Zabbix agent",
            "flags": "0",
            "templateid": "10001",
            "description": "Dies ist eine offizielle Linux-Vorlage. Sie erfordert Zabbix Agent 8.0 oder neuer.\r\n\r\nHinweise zur Dateisystem- (FS-)Erkennung:\r\n- Das ext4/3/2-Dateisystem reserviert Speicherplatz für privilegierte Nutzung, standardmäßig typischerweise auf 5 % gesetzt.\r\n- BTRFS reserviert standardmäßig 10 % des Volumes für eigene Zwecke.\r\n- Um potenzielle Katastrophen zu vermeiden, basieren die Auslöser für die FS-Nutzung auf dem maximal verfügbaren Speicherplatz.\r\n  - Formel für die Auslastung: 'pused = 100 - 100 * (available / total - free + available)'\r\n- Das FS-Auslastungsdiagramm, das aus Graph-Prototypen abgeleitet wird, stellt den reservierten FS-Speicherplatz als Differenz zwischen verwendetem und verfügbarem Speicherplatz des gesamten Volumes dar.\r\n\r\nSie können diese Vorlage in unserem Forum diskutieren oder Feedback hinterlassen: https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nErzeugt mit dem offiziellen Zabbix-Vorlagenwerkzeug \"Templator\"",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "custom_interfaces": "0",
            "uuid": "f8f7908280354f2abeed07dc788c3747",
            "vendor_name": "Zabbix",
            "vendor_version": "8.0-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Überblick\r\n\r\nDies ist eine offizielle Linux-Vorlage. Sie erfordert Zabbix Agent 8.0 oder neuer.\r\n\r\n#### Hinweise zur Dateisystem- (FS-)Erkennung:\r\n- Das ext4/3/2-FS reserviert Speicherplatz für privilegierte Nutzung, standardmäßig typischerweise auf 5 % gesetzt.\r\n- BTRFS reserviert standardmäßig 10 % des Volumes für eigene Zwecke.\r\n- Um potenzielle Katastrophen zu vermeiden, basieren die Auslöser für die FS-Nutzung auf dem maximal verfügbaren Speicherplatz.\r\n  - Formel für die Auslastung: `pused = 100 - 100 * (available / total - free + available)`\r\n- Das FS-Auslastungsdiagramm, das aus Graph-Prototypen abgeleitet wird, stellt den reservierten FS-Speicherplatz als Differenz zwischen verwendetem und verfügbarem Speicherplatz des gesamten Volumes dar."
        },
        {
            "proxyid": "0",
            "host": "Windows by Zabbix agent",
            "status": "3",
            "ipmi_authtype": "-1",
            "ipmi_privilege": "2",
            "ipmi_username": "",
            "ipmi_password": "",
            "maintenanceid": "0",
            "maintenance_status": "0",
            "maintenance_type": "0",
            "maintenance_from": "0",
            "name": "Windows by Zabbix agent",
            "flags": "0",
            "templateid": "10081",
            "description": "Dies ist eine offizielle Windows-Vorlage. Sie erfordert Zabbix Agent 8.0 oder neuer.\r\n\r\nSie können diese Vorlage in unserem Forum diskutieren oder Feedback hinterlassen: https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nErzeugt mit dem offiziellen Zabbix-Vorlagenwerkzeug \"Templator\"",
            "tls_connect": "1",
            "tls_accept": "1",
            "tls_issuer": "",
            "tls_subject": "",
            "tls_psk_identity": "",
            "tls_psk": "",
            "custom_interfaces": "0",
            "uuid": "13b06904a6bf41cbb795e3193d896340",
            "vendor_name": "Zabbix",
            "vendor_version": "8.0-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Überblick\r\n\r\nDies ist eine offizielle Windows-Vorlage. Sie erfordert Zabbix Agent 8.0 oder neuer."
        }
    ],
    "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

Rufen Sie 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": [
        {
            "templateid": "10402",
            "tags": [
                {
                    "tag": "host-name",
                    "value": "{HOST.NAME}"
                }
            ]
        }
    ],
    "id": 1
}

Siehe auch

Quelle

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