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.

Подржава 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

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

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

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

Примери

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

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

Захтев:

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

Одговор:

{
          "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": "Ово је званични Linux шаблон. Потребан је Zabbix агент 7.4 или новији.\r\n\r\nНапомене о откривању фајл система (FS):\r\n- Фајл систем ext4/3/2 резервише простор за привилеговану употребу, обично подразумевано подешен на 5%.\r\n- BTRFS додељује подразумевано 10% запремине за сопствене потребе.\r\n- Да би се ублажиле потенцијалне катастрофе, окидачи коришћења FS-а заснивају се на максимално доступном простору.\r\n- Формула коришћења: 'pused = 100 - 100 * (доступно / укупно - слободно + доступно)'\r\n- Графикон искоришћења ФС-а, изведен из прототипова графова, одражава резервисани простор ФС-а као разлику између коришћеног и расположивог простора од укупне запремине.\r\n\r\nМожете разговарати о овом шаблону или оставити повратне информације на нашем форуму https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nГенерисано званичним алатом за шаблоне Zabbix-а \"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": "## Преглед\r\n\r\nОво је званични Linux шаблон. Потребан је Zabbix агент 7.4 или новији.\r\n\r\n#### Напомене о откривању фајл система (FS):\r\n- ext4/3/2 FS резервише простор за привилеговану употребу, обично подразумевано подешен на 5%.\r\n- BTRFS додељује подразумевано 10% запремине за сопствене потребе.\r\n- Да би се ублажиле потенцијалне катастрофе, окидачи коришћења FS-а заснивају се на максимално доступном простору.\r\n - Формула искоришћења: `pused = 100 - 100 * (доступно / укупно - слободно + доступно)`\r\n- Графикон искоришћења простора за складиштење података, изведен из прототипова графова, одражава резервисани простор за складиштење података као разлику између коришћеног и доступног простора из укупне запремине.
          },
          {
          "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": "Ово је званични Windows шаблон. Потребан је Zabbix агент 7.4 или новији.\r\n\r\nМожете разговарати о овом шаблону или оставити повратне информације на нашем форуму." https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nГенерисано званичним алатом за шаблоне Zabbix-а \"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": "## Преглед\r\n\r\nОво је званични Windows шаблон. Потребан је Zabbix агент 7.4 или новији."
          }
          ],
          "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.