template.get

Opis

integer/array template.get(object parameters)

Metoda umożliwia pobieranie szablonów zgodnie z podanymi parametrami.

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

Parametry

(object) Parametry definiujące oczekiwany wynik.

Metoda obsługuje następujące parametry.

Parameter Type Description
templateids ID/array Zwracaj tylko szablony o podanych ID szablonów.
groupids ID/array Zwracaj tylko szablony należące do podanych grup szablonów.
parentTemplateids ID/array Zwracaj tylko szablony, z którymi podany szablon jest powiązany.
hostids ID/array Zwracaj tylko szablony powiązane z podanymi hostami/szablonami.
graphids ID/array Zwracaj tylko szablony zawierające podane wykresy.
itemids ID/array Zwracaj tylko szablony zawierające podane pozycje.
triggerids ID/array Zwracaj tylko szablony zawierające podane wyzwalacze.
with_items flag Zwracaj tylko szablony, które mają pozycje.
with_triggers flag Zwracaj tylko szablony, które mają wyzwalacze.
with_graphs flag Zwracaj tylko szablony, które mają wykresy.
with_httptests flag Zwracaj tylko szablony, które mają scenariusze web.
evaltype integer Metoda oceny etykiet.

Possible values:
0 - (default) And/Or;
2 - Or.
tags object/array Zwracaj tylko szablony o podanych etykietach.
Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Pusta tablica zwraca wszystkie szablony.

Possible operator values:
0 - (default) Contains;
1 - Equals;
2 - Does not contain;
3 - Does not equal;
4 - Exists;
5 - Does not exist.
selectTags query Zwraca etykiety szablonu w właściwości tags.
selectHosts query Zwraca hosty powiązane z szablonem w właściwości hosts.

Supports count.
selectTemplateGroups query Zwraca grupy szablonów, do których należy szablon, w właściwości templategroups.
selectTemplates query Zwraca szablony, z którymi podany szablon jest powiązany, w właściwości templates.

Supports count.
selectParentTemplates query Zwraca szablony, które są powiązane z podanym szablonem, w właściwości parentTemplates.

Supports count.
selectHttpTests query Zwraca scenariusze web z szablonu w właściwości httpTests.

Supports count.
selectItems query Zwraca pozycje z szablonu w właściwości items.

Supports count.
selectDiscoveries query Zwraca wykrycia niskiego poziomu z szablonu w właściwości discoveries.

Supports count.
selectTriggers query Zwraca wyzwalacze z szablonu w właściwości triggers.

Supports count.
selectGraphs query Zwraca wykresy z szablonu w właściwości graphs.

Supports count.
selectMacros query Zwraca makra z szablonu w właściwości macros.
selectDashboards query Zwraca dashboardy z szablonu w właściwości dashboards.

Supports count.
selectValueMaps query Zwraca właściwość valuemaps z mapami wartości szablonu.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

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

Possible values: hostid, host, name, status.
countOutput boolean Te parametry są 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
selectGroups
(deprecated)		 query Ten parametr jest przestarzały, użyj zamiast niego selectTemplateGroups.
Zwraca grupy szablonów, do których należy szablon, w właściwości groups.

Wartości zwracane

(integer/array) Zwraca:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput.

Przykłady

Pobieranie szablonów według nazwy

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

Żądanie:

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

Odpowiedź:

{
    "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
}

Pobieranie grup szablonów

Pobierz grupy szablonów, do których należy szablon „Linux by Zabbix agent”.

Żądanie:

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

Odpowiedź:

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

Pobieranie hostów według szablonu

Pobierz hosty, które mają podłączony szablon „10001” (Linux by Zabbix agent).

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": "templateid",
        "templateids": "10001",
        "selectHosts": ["hostid", "name"]
    },
    "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 tagów szablonu

Pobierz szablony, które mają tag "host-name" równy "{HOST.NAME}".

Żądanie:

{
    "jsonrpc": "2.0",
    "method": "template.get",
    "params": {
        "output": ["hostid"],
        "selectTags": "extend",
        "evaltype": 0,
        "tags": [
            {
                "tag": "host-name",
                "value": "{HOST.NAME}",
                "operator": 1
            }
        ]
    },
    "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.