Sidebar
ru:manual:api:reference:template:get
Table of Contents
template.get
Описание
целое число/массив template.get(объект параметры)
Этот метод позволяет получать шаблоны в соответствии с заданными параметрами.
Параметры
(объект) Параметры задают желаемый вывод.
Этот метод поддерживает следующие параметры.
| Параметр | Тип | Описание |
|---|---|---|
| templateids | строка/массив | Возврат шаблонов только с заданными ID шаблонов. |
| groupids | строка/массив | Возврат только тех шаблонов, которые принадлежат заданным группам узлов сети. |
| parentTemplateids | строка/массив | Возврат только тех шаблонов, которые являются дочерними заданным шаблонам. |
| hostids | строка/массив | Возврат только тех шаблонов, которые присоединены к заданным узлам сети. |
| graphids | строка/массив | Возврат только тех шаблонов, которые содержат заданные графики. |
| itemids | строка/массив | Возврат только тех шаблонов, которые содержат заданные элементы данных. |
| triggerids | строка/массив | Возврат только тех шаблонов, которые содержат заданные триггеры. |
| with_items | флаг | Возврат только тех шаблонов, которые имеют элементы данных. |
| with_triggers | флаг | Возврат только тех шаблонов, которые имеют триггеры. |
| with_graphs | флаг | Возврат только тех шаблонов, которые имеют графики. |
| with_httptests | флаг | Возврат только тех шаблонов, которые имеют веб-сценарии. |
| evaltype | целое число | Правила для поиска тегов. Возможные значения: 0 - (по умолчанию) И / ИЛИ; 2 - ИЛИ. |
| tags | массив/объект | Возврат шаблонов только с заданными тегами. Точное совпадение по тегу и регистрозависимый или независимый от регистра поиск по значению тега в зависимости от значения оператора. Формат: [{"tag": "<тег>", "value": "<значение>", "operator": "<оператор>"}, ...].Пустой массив вернёт все шаблоны. Возможные значения оператора: 0 - (по умолчанию) Содержит; 1 - Равен. |
| selectGroups | запрос | Возврат групп узлов сети, которым принадлежит шаблон, в свойстве groups. |
| selectTags | запрос | Возврат тегов шаблона в свойстве tags. |
| selectHosts | запрос | Возврат узлов сети, которые присоединены к шаблону, в свойстве hosts. Поддерживается count. |
| selectTemplates | запрос | Возврат дочерних шаблонов в свойстве templates. Поддерживается count. |
| selectParentTemplates | запрос | Возврат родительских шаблонов в свойстве parentTemplates. Поддерживается count. |
| selectHttpTests | запрос | Возврат веб-сценариев из шаблона в свойстве httpTests. Поддерживается count. |
| selectItems | запрос | Возврат элементов данных из шаблона в свойстве items. Поддерживается count. |
| selectDiscoveries | запрос | Возврат низкоуровневых обнаружений из шаблона в свойстве discoveries. Поддерживается count. |
| selectTriggers | запрос | Возврат триггеров из шаблона в свойстве triggers. Поддерживается count. |
| selectGraphs | запрос | Возврат графиков из шаблона в свойстве graphs. Поддерживается count. |
| selectApplications | запрос | Возврат групп элементов данных из шаблона в свойстве applications. Поддерживается count. |
| selectMacros | запрос | Возврат макросов из шаблона в свойстве macros. |
| selectScreens | запрос | Возврат комплексных экранов из шаблона в свойстве screens. Поддерживается count. |
| limitSelects | целое число | Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: selectTemplates - результаты сортируются по name; selectHosts - сортируются по host; selectParentTemplates - сортируются по host; selectItems - сортируются по name; selectDiscoveries - сортируются по name; selectTriggers - сортируются по description; selectGraphs - сортируются по name; selectApplications - сортируются по name; selectScreens - сортируются по name. |
| sortfield | строка/массив | Сортировка результата в соответствии с заданными свойствами. Возможные значения: hostid, host, name, status. |
| countOutput | логический | Эти параметры являются общими для всех методов get и они описаны в справочных комментариях. |
| editable | логический | |
| excludeSearch | логический | |
| filter | объект | |
| limit | целое число | |
| output | запрос | |
| preservekeys | логический | |
| search | объект | |
| searchByAny | логический | |
| searchWildcardsEnabled | логический | |
| sortorder | строка/массив | |
| startSearch | логический | |
Возвращаемые значения
(целое число/массив) Возвращает либо:
- массив объектов;
- количество найденных объектов, если используется параметр
countOutput.
Примеры
Получение шаблонов по имени
Получение всех данных о двух шаблонах с именами “Template OS Linux” и “Template OS Windows”.
Запрос:
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": "extend", "filter": { "host": [ "Template OS Linux", "Template OS Windows" ] } }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Ответ:
{ "jsonrpc": "2.0", "result": [ { "proxy_hostid": "0", "host": "Template OS 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": "Template OS Linux", "flags": "0", "templateid": "10001", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "tls_psk_identity": "", "tls_psk": "" }, { "proxy_hostid": "0", "host": "Template OS 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": "Template OS Windows", "flags": "0", "templateid": "10081", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "tls_psk_identity": "", "tls_psk": "" } ], "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 } ] }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Ответ:
{ "jsonrpc": "2.0", "result": [ { "hostid": "10402", "tags": [ { "tag": "Host name", "value": "{HOST.NAME}" } ] } ], "id": 1 }
Смотрите также
Исходный код
CTemplate::get() в frontends/php/include/classes/api/services/CTemplate.php.