template.get

Opis

integer/array template.get(object parameters)

Metoda umożliwia pobieranie szablonów zgodnie z określonymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do jej wywołania mogą zostać cofnięte w ustawieniach ról użytkownika. Zobacz Role użytkowników , aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
templateids string/array Zwróć tylko szablony o podanych identyfikatorach szablonów.
groupids string/array Zwróć tylko szablony należące do podanych grup hostów.
parentTemplateids string/array Zwróć tylko szablony, które są nadrzędne wobec podanych szablonów.
hostids string/array Zwróć tylko szablony połączone z podanymi hostami/szablonami.
graphids string/array Zwróć tylko szablony zawierające podane wykresy.
itemids string/array Zwróć tylko szablony zawierające podane pozycje.
triggerids string/array Zwróć tylko szablony zawierające podane wyzwalacze.
with_items flag Zwróć tylko szablony posiadające pozycje.
with_triggers flag Zwróć tylko szablony posiadające wyzwalacze.
with_graphs flag Zwróć tylko szablony posiadające wykresy.
with_httptests flag Zwróć tylko szablony posiadające scenariusze WWW.
evaltype integer Reguły wyszukiwania znaczników.

Możliwe wartości:
0 - (domyślnie) I/Lub;
2 - Lub.
tags object/array Zwróć tylko szablony z podanymi znacznikami. Dokładne dopasowanie według tagu i przeszukiwanie według wartości znacznika z uwzględnieniem wielkości liter lub niezależnie od wielkości liter w zależności od wartości operatora.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie szablony.

Możliwe wartości operatora:
0 - (domyślnie) Zawiera;
1 - Jest równy;
2 - Nie zawiera;
3 - Nie równa się
4 - Istnieje;
5 - Nie istnieje.
selectGroups query Zwróć grupy hostów, do których należy szablon, w właściwości groups.
selectTags query Zwróć znaczniki szablonu w właściwości tags.
selectHosts query Zwróć hosty, które są połączone z szablonem w właściwości hosts.

Obsługuje count.
selectTemplates query Zwróć szablony, do których szablon jest podrzędny, w właściwości templates.

Obsługuje count.
selectParentTemplates query Zwróć szablony, do których szablon jest nadrzędny, w właściwości parentTemplates.

Obsługuje count.
selectHttpTests query Zwróć scenariusze WWW z szablonu w właściwości httpTests.

Obsługuje count.
selectItems query Zwróć pozycje z szablonu w właściwości items.

Obsługuje count.
selectDiscoveries query Zwróć wykrywania niskopoziomowe z szablonu w właściwości discoveries.

Obsługuje count.
selectTriggers query Zwróć wyzwalacze z szablonu w właściwości triggers.

Obsługuje count.
selectGraphs query Zwróć wykresy z szablonu w właściwości graphs.

Obsługuje count.
selectMacros query Zwróć makra z szablonu w właściwości macros.
selectDashboards query Zwróć pulpity z szablonu w właściwości dashboards.

Obsługuje count.
selectValueMaps query Zwróć właściwość valuemaps z mapami wartości szablonu.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytanie.

Dotyczy następujących podzapytań:
selectTemplates - wyniki zostaną posortowane według name;
selectHosts - posortowane według host;
selectParentTemplates - posortowane według host;
selectItems - posortowane według name;
selectDiscoveries - posortowane według name;
selectTriggers - posortowane według description;
selectGraphs - posortowane według name;
selectDashboards - posortowane według name.
sortfield string/array Sortuj wyniki według podanych właściwości.

Możliwe wartości: hostid, host, name, status.
countOutput boolean Parametry te, będąc wspólne dla wszystkich metod get, są szczegółowo opisane w komentarzu referencyjnym.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie szablonów według nazwy

Pobierz wszystkie dane dotyczące dwóch szablonów o nazwach "Linux" i "Windows".

Zapytanie:

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

Odpowiedź:

{
    "jsonrpc": "2.0",
    "result": [
        {
            "proxy_hostid": "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"
        },
        {
            "proxy_hostid": "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
}

Pobieranie hostów według szablonu

Pobierz hosty, do których przypisany jest szablon "10001" (Linux by Zabbix agent).

Zapytanie:

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

Odpowiedź:

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

Wyszukiwanie według znaczników szablonu

Pobierz szablony, które mają znacznik "Host name" równy "{HOST.NAME}".

Zapytanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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