template.get
Descripción
integer/array template.get(object parameters)
El método permite recuperar templates según los parámetros proporcionados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte User roles para obtener más información.
Parámetros
(object) Parámetros que definen el resultado deseado.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| templateids | ID/array | Devuelve solo los templates con los ID de template indicados. |
| groupids | ID/array | Devuelve solo los templates que pertenecen a los grupos de templates indicados. |
| parentTemplateids | ID/array | Devuelve solo los templates a los que está vinculado el template indicado. |
| hostids | ID/array | Devuelve solo los templates vinculados a los hosts/templates indicados. |
| graphids | ID/array | Devuelve solo los templates que contienen los gráficos indicados. |
| itemids | ID/array | Devuelve solo los templates que contienen los items indicados. |
| triggerids | ID/array | Devuelve solo los templates que contienen los triggers indicados. |
| with_items | flag | Devuelve solo los templates que tienen items. |
| with_triggers | flag | Devuelve solo los templates que tienen triggers. |
| with_graphs | flag | Devuelve solo los templates que tienen gráficos. |
| with_httptests | flag | Devuelve solo los templates que tienen escenarios web. |
| evaltype | integer | Método de evaluación de etiquetas. Valores posibles: 0 - (predeterminado) Y/O; 2 - O. |
| tags | object/array | Devuelve solo los templates con las etiquetas indicadas. Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Una matriz vacía devuelve todos los templates. Valores posibles de operador: 0 - (predeterminado) Contiene; 1 - Es igual a; 2 - No contiene; 3 - No es igual a; 4 - Existe; 5 - No existe. |
| inheritedTags | boolean | Devuelve los templates que también tienen las tags indicadas en los templates vinculados.Valores posibles: true - los templates vinculados también deben tener las etiquetas indicadas;false - (predeterminado) se ignoran las etiquetas de los templates vinculados. |
| selectInheritedTags | query | Devuelve una propiedad inheritedTags con las etiquetas presentes en los templates vinculados. |
| selectTags | query | Devuelve las etiquetas del template en la propiedad tags. |
| selectDiscoveryRules | query | Devuelve una propiedad discoveryRules con las reglas LLD del template.Admite count. |
| selectHosts | query | Devuelve los hosts vinculados al template en la propiedad hosts.Admite count. |
| selectTemplateGroups | query | Devuelve los grupos de templates a los que pertenece el template en la propiedad templategroups. |
| selectTemplates | query | Devuelve los templates a los que está vinculado el template indicado en la propiedad templates.Admite count. |
| selectParentTemplates | query | Devuelve los templates vinculados al template indicado en la propiedad parentTemplates.Admite count. |
| selectHttpTests | query | Devuelve los escenarios web del template en la propiedad httpTests.Admite count. |
| selectItems | query | Devuelve los items del template en la propiedad items.Admite count. |
| selectTriggers | query | Devuelve los triggers del template en la propiedad triggers.Admite count. |
| selectGraphs | query | Devuelve los gráficos del template en la propiedad graphs.Admite count. |
| selectMacros | query | Devuelve las macros del template en la propiedad macros. |
| selectDashboards | query | Devuelve los dashboards del template en la propiedad dashboards.Admite count. |
| selectValueMaps | query | Devuelve una propiedad valuemaps con los mapas de valores del template. |
| limitSelects | integer | Limita el número de registros devueltos por las subselecciones. Se aplica a las siguientes subselecciones: 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 | Ordena el resultado por las propiedades indicadas. Valores posibles: hostid, host, name, status. |
| countOutput | boolean | Estos parámetros se describen en los comentarios 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 | Devuelve los descubrimientos de bajo nivel del template en la propiedad discoveries.Admite count.Esta consulta está obsoleta; utilice 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
Recuperación de templates por nombre
Recupere todos los datos sobre dos templates denominados "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.2-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.2-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.