template.get

Опис

integer/array template.get(object parameters)

Метода омогућава преузимање шаблона према датим параметрима.

Ова метода је доступна корисницима било ког типа. Дозволе за позивање методе могу се опозвати у подешавањима улоге корисника. Погледајте Корисничка улога за више информација.

Параметри

(object) Параметри који дефинишу жељени излаз.

Метод подржава следеће параметре.

Parameter Type Description
templateids ID/array Враћа само шаблоне са датим ID-ијевима шаблона.
groupids ID/array Враћа само шаблоне који припадају датим групама шаблона.
parentTemplateids ID/array Враћа само шаблоне са којима је дати шаблон повезан.
hostids ID/array Враћа само шаблоне који су повезани са датим домаћинима/шаблонима.
graphids ID/array Враћа само шаблоне који садрже дате графиконе.
itemids ID/array Враћа само шаблоне који садрже дате ставке.
triggerids ID/array Враћа само шаблоне који садрже дате окидаче.
with_items flag Враћа само шаблоне који имају ставке.
with_triggers flag Враћа само шаблоне који имају окидаче.
with_graphs flag Враћа само шаблоне који имају графиконе.
with_httptests flag Враћа само шаблоне који имају веб сценарије.
evaltype integer Правила за претрагу ознака.

Могуће вредности:
0 - (подразумевано) И/Или;
2 - Или.
tags object/array Враћа само шаблоне са датим ознакама. Тачно подударање по ознаци и претрага која разликује велика и мала слова или која не разликује по вредности ознаке у зависности од вредности оператора.
Формат: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Празан низ враћа све шаблоне.

Могуће вредности оператора:
0 - (подразумевано) Садржи (подударање подстринга, без разликовања великих и малих слова);
1 - Једнако (разликује велика и мала слова);
2 - Не садржи (подударање подстринга, не разликује велика и мала слова);
3 - Није једнако (разликује велика и мала слова);
4 - Постоји;
5 - Не постоји.
selectTags query Враћа ознаке шаблона у својству tags.
selectHosts query Враћа домаћине који су повезани са шаблоном у својству hosts.

Подржава count.
selectTemplateGroups query Враћа групе шаблона којима шаблон припада својству templategroups.
selectTemplates query Враћа шаблоне са којима је дати шаблон повезан у својству templates.

Подржава count.
selectParentTemplates query Враћа шаблоне који су повезани са датим шаблоном у својству parentTemplates.

Подржава count.
selectHttpTests query Враћа веб сценарије из шаблона у својству httpTests.

Подржава count.
selectItems query Враћа ставке из шаблона у својству [items]
(/manual/api/reference/item/object).

Подржава count.
selectDiscoveries query Враћа открића ниског нивоа из шаблона у својству discoveries.

Подржава count.
selectTriggers query Враћа окидаче из шаблона у својству triggers.

Подржава count.
selectGraphs query Враћа графиконе из шаблона у својству graphs.

Подржава count.
selectMacros query Враћа макрое из шаблона у својству macros.
selectDashboards query Враћа контролне табле из шаблона у својству dashboards.

Подржава count.
selectValueMaps query Враћа својство valuemaps са мапама вредности шаблона.
limitSelects integer Ограничава број записа које враћају подизбори.

Примјењује се на следеће подизборе:
selectTemplates - резултати ће бити сортирани према name;
selectHosts - сортирано по host;
selectParentTemplates - сортирано по host;
selectItems - сортирано по name;
selectDiscoveries - сортирано по name;
selectTriggers - сортирано по description;
selectGraphs - сортирано по name;
selectDashboards - сортирано по name.
sortfield string/array Сортира резултат према датим подешавањима.

Могуће вредности: hostid, host, name, status.
countOutput boolean Ови параметри су описани у референтном коментару.
editable boolean ^
excludeSearch boolean ^
filter object ^
limit integer ^
output query ^
preservekeys boolean ^
search object ^
searchByAny boolean ^
searchWildcardsEnabled boolean ^
sortorder string/array ^
startSearch boolean ^
selectGroups
(застарело)		 query Овај параметар је застарео, користитеselectTemplateGroups уместо тога.
Враћа групе шаблона којима шаблон припада у groups својство.

Повратне вредности

(integer/array) Враћа било:

  • низ објеката;
  • број преузетих објеката, ако је параметар countOutput коришћен.

Примери

Преузимање шаблона по имену

Преузми све податке о два шаблона по имену "Linux" и "Windows".

Захтев:

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

Одговор:

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

Преузимање група шаблона

Преузми групе шаблона чији је члан шаблон "Linux by Zabbix agent".

Захтев:

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

Одговор:

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

Преузимање домаћина по шаблону

Преузмите домаћине са којима је повезан шаблон "10001" (Linux by Zabbix agent).

Захтев:

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

Одговор:

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

Претраживање по ознакама шаблона

Преузмите шаблоне који имају ознаку "host-name" једнаку "{HOST.NAME}".

Захтев:

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

Одговор:

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

Погледајте такође

Извор

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