[comment]: # ({896915aa-896915aa})
# template.get
[comment]: # ({/896915aa-896915aa})
[comment]: # ({808af69c-4e400711})
### Описание
`integer/array template.get(параметры объекта)`
Этот метод позволяет получать шаблоны в соответствии с заданными параметрами.
::: noteclassic
Этот метод доступен пользователям любого типа.
Разрешения на вызов метода можно отозвать в настройках ролей пользователя.
Дополнительную информацию см. в разделе [Роли пользователей](/manual/web_interface/frontend_sections/users/user_roles).
:::
[comment]: # ({/808af69c-4e400711})
[comment]: # ({bba4c1f2-97f0e40b})
### Параметры
`(object)` Параметры, определяющие требуемый результат.
Метод поддерживает следующие параметры.
|Parameter|[Type](/manual/api/reference_commentary#data-types)|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|Метод [оценки тегов](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter).
Возможные значения:
0 - *(по умолчанию)* И/ИЛИ;
2 - ИЛИ.|
|tags|object/array|Возвращать только шаблоны с указанными тегами.
Формат: `[{"tag": "", "value": "", "operator": ""}, ...]`.
Пустой массив возвращает все шаблоны.
Возможные значения [оператора](/manual/web_interface/frontend_sections/data_collection/hosts#using-filter):
0 - *(по умолчанию)* Содержит;
1 - Равно;
2 - Не содержит;
3 - Не равно;
4 - Существует;
5 - Не существует.|
|selectTags|query|Возвращать теги шаблона в свойстве [`tags`](/manual/api/reference/template/object#template-tag).|
|selectDiscoveryRules|query|Возвращать свойство [`discoveryRules`](/manual/api/reference/discoveryrule/object) с правилами LLD шаблона.
Поддерживает `count`.|
|selectHosts|query|Возвращать узлы сети, привязанные к шаблону, в свойстве [`hosts`](/manual/api/reference/host/object).
Поддерживает `count`.|
|selectTemplateGroups|query|Возвращать группы шаблонов, к которым принадлежит шаблон, в свойстве [`templategroups`](/manual/api/reference/templategroup/object).|
|selectTemplates|query|Возвращать шаблоны, к которым привязан указанный шаблон, в свойстве [`templates`](/manual/api/reference/template/object).
Поддерживает `count`.|
|selectParentTemplates|query|Возвращать шаблоны, которые привязаны к указанному шаблону, в свойстве `parentTemplates`.
Поддерживает `count`.|
|selectHttpTests|query|Возвращать веб-сценарии из шаблона в свойстве [`httpTests`](/manual/api/reference/httptest/object).
Поддерживает `count`.|
|selectItems|query|Возвращать элементы данных из шаблона в свойстве [`items`](/manual/api/reference/item/object).
Поддерживает `count`.|
|selectTriggers|query|Возвращать триггеры из шаблона в свойстве [`triggers`](/manual/api/reference/trigger/object).
Поддерживает `count`.|
|selectGraphs|query|Возвращать графики из шаблона в свойстве [`graphs`](/manual/api/reference/graph/object).
Поддерживает `count`.|
|selectMacros|query|Возвращать макросы из шаблона в свойстве [`macros`](/manual/api/reference/usermacro/object#host-macro).|
|selectDashboards|query|Возвращать дашборды из шаблона в свойстве [`dashboards`](/manual/api/reference/templatedashboard/object).
Поддерживает `count`.|
|selectValueMaps|query|Возвращать свойство [`valuemaps`](/manual/api/reference/valuemap/object) с картами значений шаблона.|
|limitSelects|integer|Ограничивает число записей, возвращаемых подвыборками.
Применяется к следующим подвыборкам:
`selectTemplates` - результаты будут отсортированы по `name`;
`selectHosts` - по `host`;
`selectParentTemplates` - по `host`;
`selectItems` - по `name`;
`selectDiscoveryRules` - по `name`;
`selectTriggers` - по `description`;
`selectGraphs` - по `name`;
`selectDashboards` - по `name`.|
|sortfield|string/array|Сортировать результат по указанным свойствам.
Возможные значения: `hostid`, `host`, `name`, `status`.|
|countOutput|boolean|Эти параметры описаны в [справочном комментарии](/manual/api/reference_commentary#common-get-method-parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|
|selectDiscoveries|query|Возвращать низкоуровневые обнаружения из шаблона в свойстве `discoveries`.
Поддерживает `count`.
Этот запрос **устарел**, вместо него используйте `selectDiscoveryRules`.
[comment]: # ({/bba4c1f2-97f0e40b})
[comment]: # ({7223bab1-7223bab1})
### Возвращаемые значения
`(целое число/массив)` Возвращает либо:
- · массив объектов;
- · количество извлеченных объектов, если использовался параметр `countOutput`.
[comment]: # ({/7223bab1-7223bab1})
[comment]: # ({b41637d2-b41637d2})
### Примеры
[comment]: # ({/b41637d2-b41637d2})
[comment]: # ({418c03b3-7e546e9a})
#### Получение шаблонов по имени
Получите все данные о двух шаблонах с именами "Linux" и "Windows".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux by Zabbix agent",
"Windows by Zabbix agent"
]
}
},
"id": 1
}
```
Ответ:
```json
{
"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 * (available / total - free + available)'\r\n- График использования FS, полученный из прототипов графиков, отражает зарезервированное пространство FS как разницу между используемым и доступным пространством от общего объема.\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 резервирует место для привилегированного использования, обычно по умолчанию 5%.\r\n- BTRFS по умолчанию выделяет 10% тома для собственных нужд.\r\n- Чтобы снизить риск потенциальных проблем, триггеры использования FS основаны на максимальном доступном пространстве.\r\n - Формула использования: `pused = 100 - 100 * (available / total - free + available)`\r\n- График использования FS, полученный из прототипов графиков, отражает зарезервированное пространство FS как разницу между используемым и доступным пространством от общего объема."
},
{
"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
}
```
[comment]: # ({/418c03b3-7e546e9a})
[comment]: # ({4e2a2df6-84d0cbf3})
#### Получение групп шаблонов
Получите группы шаблонов, членом которых является шаблон "Linux by Zabbix agent".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTemplateGroups": "extend",
"filter": {
"host": [
"Linux by Zabbix agent"
]
}
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"templategroups": [
{
"groupid": "10",
"name": "Templates/Operating systems",
"uuid": "846977d1dfed4968bc5f8bdb363285bc"
}
]
}
],
"id": 1
}
```
[comment]: # ({/4e2a2df6-84d0cbf3})
[comment]: # ({ce53b2e1-a8599e09})
#### Получение узлов сети по шаблону
Получите узлы сети, к которым привязан шаблон "10001" (*Linux by Zabbix agent*).
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "templateid",
"templateids": "10001",
"selectHosts": ["hostid", "name"]
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}
```
[comment]: # ({/ce53b2e1-a8599e09})
[comment]: # ({3380e3c0-0fe2d603})
#### Поиск по тегам шаблона
Получить шаблоны, у которых тег "host-name" равен "{HOST.NAME}".
[Запрос](/manual/api#performing-requests):
```json
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "host-name",
"value": "{HOST.NAME}",
"operator": 1
}
]
},
"id": 1
}
```
Ответ:
```json
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10402",
"tags": [
{
"tag": "host-name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}
```
[comment]: # ({/3380e3c0-0fe2d603})
[comment]: # ({45da1f59-ee3fc022})
### См. также
- [Группа шаблонов](/manual/api/reference/templategroup/object#template-group)
- [Шаблон](object#template)
- [Пользовательский макрос](/manual/api/reference/usermacro/object#hosttemplate-level-macro)
- [Интерфейс узла сети](/manual/api/reference/hostinterface/object#host-interface)
[comment]: # ({/45da1f59-ee3fc022})
[comment]: # ({4fdbde5d-4fdbde5d})
### Источник
CTemplate::get() в *ui/include/classes/api/services/CTemplate.php*.
[comment]: # ({/4fdbde5d-4fdbde5d})