Table of Contents
template.get
Descripción
integer/array template.get(object parameters)
El método permite recuperar templates de acuerdo con los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte Roles de usuario para más información.
Parámetros
(object) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| templateids | ID/array | Devolver solo las templates con los IDs de template dados. |
| groupids | ID/array | Devolver solo las templates que pertenecen a los grupos de templates dados. |
| parentTemplateids | ID/array | Devolver solo las templates a las que la template dada está vinculada. |
| hostids | ID/array | Devolver solo las templates que están vinculadas a los hosts/templates dados. |
| graphids | ID/array | Devolver solo las templates que contienen los gráficos dados. |
| itemids | ID/array | Devolver solo las templates que contienen los items dados. |
| triggerids | ID/array | Devolver solo las templates que contienen los triggers dados. |
| with_items | flag | Devolver solo las templates que tienen items. |
| with_triggers | flag | Devolver solo las templates que tienen triggers. |
| with_graphs | flag | Devolver solo las templates que tienen gráficos. |
| with_httptests | flag | Devolver solo las templates que tienen escenarios web. |
| evaltype | integer | Método de evaluación de etiquetas. Valores posibles: 0 - (por defecto) And/Or; 2 - Or. |
| tags | object/array | Devolver solo las templates con las etiquetas dadas. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un array vacío devuelve todas las templates. Valores posibles de operator: 0 - (por defecto) Contiene; 1 - Es igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. |
| inheritedTags | boolean | Devolver templates que tengan las tags dadas también en las templates vinculadas.Valores posibles: true - las templates vinculadas también deben tener las etiquetas dadas;false - (por defecto) se ignoran las etiquetas de las templates vinculadas. |
| selectInheritedTags | query | Devolver una propiedad inheritedTags con las etiquetas que están en las templates vinculadas. |
| selectTags | query | Devolver las etiquetas de la template en la propiedad tags. |
| selectDiscoveryRules | query | Devolver una propiedad discoveryRules con las reglas LLD de la template. Soporta count. |
| selectHosts | query | Devolver los hosts que están vinculados a la template en la propiedad hosts.Soporta count. |
| selectTemplateGroups | query | Devolver los grupos de templates a los que pertenece la template en la propiedad templategroups. |
| selectTemplates | query | Devolver las templates a las que la template dada está vinculada en la propiedad templates.Soporta count. |
| selectParentTemplates | query | Devolver las templates que están vinculadas a la template dada en la propiedad parentTemplates.Soporta count. |
| selectHttpTests | query | Devolver los escenarios web de la template en la propiedad httpTests.Soporta count. |
| selectItems | query | Devolver los items de la template en la propiedad items.Soporta count. |
| selectTriggers | query | Devolver los triggers de la template en la propiedad triggers.Soporta count. |
| selectGraphs | query | Devolver los gráficos de la template en la propiedad graphs.Soporta count. |
| selectMacros | query | Devolver las macros de la template en la propiedad macros. |
| selectDashboards | query | Devolver los dashboards de la template en la propiedad dashboards.Soporta count. |
| selectValueMaps | query | Devolver una propiedad valuemaps con los mapas de valores de la template. |
| limitSelects | integer | Limita el número de registros devueltos por subconsultas. Se aplica a las siguientes subconsultas: selectTemplates - los resultados se ordenarán por name;selectHosts - ordenados por host;selectParentTemplates - ordenados por host;selectItems - ordenados por name;selectDiscoveryRules - ordenados por name;selectTriggers - ordenados por description;selectGraphs - ordenados por name;selectDashboards - ordenados por name. |
| sortfield | string/array | Ordenar el resultado por las propiedades dadas. Valores posibles: hostid, host, name, status. |
| countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
| 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 | Devolver los descubrimientos de bajo nivel de la template en la propiedad discoveries.Soporta count.Esta consulta está obsoleta, por favor use selectDiscoveryRules en su lugar. |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar templates por nombre
Recuperar todos los datos sobre dos templates llamados "Linux by Zabbix agent" y "Windows by Zabbix agent".
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux by Zabbix agent",
"Windows by Zabbix agent"
]
}
},
"id": 1
}Respuesta:
{
"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": "This is an official Linux template. It requires Zabbix agent 8.0 or newer.\r\n\r\nNotes on filesystem (FS) discovery:\r\n- The ext4/3/2 filesystem reserves space for privileged usage, typically set at 5% by default.\r\n- BTRFS allocates a default of 10% of the volume for its own needs.\r\n- To mitigate potential disasters, FS usage triggers are based on the maximum available space.\r\n - Utilization formula: 'pused = 100 - 100 * (available / total - free + available)'\r\n- The FS utilization chart, derived from graph prototypes, reflects FS reserved space as the difference between used and available space from the total volume.\r\n\r\nYou can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nGenerated by official Zabbix template tool \"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": "8.0-2",
"proxy_groupid": "0",
"monitored_by": "0",
"wizard_ready": "1",
"readme": "## Overview\r\n\r\nThis is an official Linux template. It requires Zabbix agent 8.0 or newer.\r\n\r\n#### Notes on filesystem (FS) discovery:\r\n- The ext4/3/2 FS reserves space for privileged usage, typically set at 5% by default.\r\n- BTRFS allocates a default of 10% of the volume for its own needs.\r\n- To mitigate potential disasters, FS usage triggers are based on the maximum available space.\r\n - Utilization formula: `pused = 100 - 100 * (available / total - free + available)`\r\n- The FS utilization chart, derived from graph prototypes, reflects FS reserved space as the difference between used and available space from the total volume."
},
{
"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": "This is an official Windows template. It requires Zabbix agent 8.0 or newer.\r\n\r\nYou can discuss this template or leave feedback on our forum https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nGenerated by official Zabbix template tool \"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": "8.0-2",
"proxy_groupid": "0",
"monitored_by": "0",
"wizard_ready": "1",
"readme": "## Overview\r\n\r\nThis is an official Windows template. It requires Zabbix agent 8.0 or newer."
}
],
"id": 1
}Recuperar grupos de plantillas
Recuperar los grupos de plantillas a los que pertenece la plantilla "Linux by Zabbix agent".
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTemplateGroups": "extend",
"filter": {
"host": [
"Linux by Zabbix agent"
]
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"templategroups": [
{
"groupid": "10",
"name": "Templates/Operating systems",
"uuid": "846977d1dfed4968bc5f8bdb363285bc"
}
]
}
],
"id": 1
}Recuperar equipos por plantilla
Recuperar los equipos que tienen la plantilla "10001" (Linux por Zabbix agent) vinculada a ellos.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "templateid",
"templateids": "10001",
"selectHosts": ["hostid", "name"]
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Búsqueda por etiquetas de template
Recuperar templates que tengan la etiqueta "host-name" igual a "{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
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10402",
"tags": [
{
"tag": "host-name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Ver también
Fuente
CTemplate::get() en ui/include/classes/api/services/CTemplate.php.