template.get

Beschreibung

integer/array template.get(object parameters)

Die Methode ermöglicht das Abrufen von Vorlagen anhand der angegebenen Parameter.

Diese Methode ist für Benutzer aller Typen verfügbar. Berechtigungen zum Aufruf 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 Gibt nur Vorlagen mit den angegebenen Vorlagen-IDs zurück.
groupids ID/array Gibt nur Vorlagen zurück, die zu den angegebenen Vorlagengruppen gehören.
parentTemplateids ID/array Gibt nur Vorlagen zurück, mit denen die angegebene Vorlage verknüpft ist.
hostids ID/array Gibt nur Vorlagen zurück, die mit den angegebenen Hosts/Vorlagen verknüpft sind.
graphids ID/array Gibt nur Vorlagen zurück, die die angegebenen Diagramme enthalten.
itemids ID/array Gibt nur Vorlagen zurück, die die angegebenen Datenpunkte enthalten.
triggerids ID/array Gibt nur Vorlagen zurück, die die angegebenen Auslöser enthalten.
with_items flag Gibt nur Vorlagen zurück, die Datenpunkte haben.
with_triggers flag Gibt nur Vorlagen zurück, die Auslöser haben.
with_graphs flag Gibt nur Vorlagen zurück, die Diagramme haben.
with_httptests flag Gibt nur Vorlagen zurück, die Webszenarien haben.
evaltype integer Tag-Auswertungsmethode.

Mögliche Werte:
0 - (Standard) Und/Oder;
2 - Oder.
tags object/array Gibt nur Vorlagen mit den angegebenen Tags zurück.
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 Gibt Vorlagen-Tags in der Eigenschaft tags zurück.
selectDiscoveryRules query Gibt eine Eigenschaft discoveryRules mit LLD-Regeln der Vorlage zurück.

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

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

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

Unterstützt count.
selectHttpTests query Gibt die Webszenarien aus der Vorlage in der Eigenschaft httpTests zurück.

Unterstützt count.
selectItems query Gibt Datenpunkte aus der Vorlage in der Eigenschaft items zurück.

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

Unterstützt count.
selectGraphs query Gibt Diagramme aus der Vorlage in der Eigenschaft graphs zurück.

Unterstützt count.
selectMacros query Gibt die Makros aus der Vorlage in der Eigenschaft macros zurück.
selectDashboards query Gibt Dashboards aus der Vorlage in der Eigenschaft dashboards zurück.

Unterstützt count.
selectValueMaps query Gibt eine Eigenschaft valuemaps mit Wertzuordnungen der Vorlage zurück.
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 Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: hostid, host, name, status.
countOutput boolean Diese Parameter werden in den Referenzkommentaren 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 Gibt Low-Level-Discoveries aus der Vorlage in der Eigenschaft discoveries zurück.

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

Abrufen von Vorlagen nach Namen

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 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 7.4 oder neuer.\r\n\r\nHinweise zur Erkennung von Dateisystemen (FS):\r\n- Das ext4/3/2-Dateisystem reserviert Speicherplatz für privilegierte Nutzung, standardmäßig typischerweise auf 5 % festgelegt.\r\n- BTRFS reserviert standardmäßig 10 % des Volumens für eigene Zwecke.\r\n- Um potenzielle Probleme zu vermeiden, basieren FS-Auslöser auf dem maximal verfügbaren Speicherplatz.\r\n  - Nutzungsformel: 'pused = 100 - 100 * (available / total - free + available)'\r\n- Das FS-Nutzungsdiagramm, abgeleitet von Diagrammvorlagen, stellt den reservierten FS-Speicherplatz als Differenz zwischen verwendetem und verfügbarem Speicherplatz des Gesamtvolumens dar.\r\n\r\nSie können diese Vorlage im Forum besprechen oder Feedback hinterlassen: https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nErstellt mit dem offiziellen Zabbix-Vorlagentool \"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": "7.4-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Übersicht\r\n\r\nDies ist eine offizielle Linux-Vorlage. Sie erfordert Zabbix Agent 7.4 oder neuer.\r\n\r\n#### Hinweise zur Erkennung von Dateisystemen (FS):\r\n- Das ext4/3/2-FS reserviert Speicherplatz für privilegierte Nutzung, standardmäßig typischerweise auf 5 % festgelegt.\r\n- BTRFS reserviert standardmäßig 10 % des Volumens für eigene Zwecke.\r\n- Um potenzielle Probleme zu vermeiden, basieren FS-Auslöser auf dem maximal verfügbaren Speicherplatz.\r\n  - Nutzungsformel: `pused = 100 - 100 * (available / total - free + available)`\r\n- Das FS-Nutzungsdiagramm, abgeleitet von Diagrammvorlagen, stellt den reservierten FS-Speicherplatz als Differenz zwischen verwendetem und verfügbarem Speicherplatz des Gesamtvolumens 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 7.4 oder neuer.\r\n\r\nSie können diese Vorlage im Forum besprechen oder Feedback hinterlassen: https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nErstellt mit dem offiziellen Zabbix-Vorlagentool \"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": "7.4-2",
            "proxy_groupid": "0",
            "monitored_by": "0",
            "wizard_ready": "1",
            "readme": "## Übersicht\r\n\r\nDies ist eine offizielle Windows-Vorlage. Sie erfordert Zabbix Agent 7.4 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

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.