Documentation
Table of Contents
template.get
Descripción
integer/array template.get(object parameters)
El método permite recuperar plantillas de acuerdo con los parámetros dados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se puede revocar en la configuración de roles de usuario. Ver Roles de usuario para obtener 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) Y/O; 2 - O. |
| 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. |
| 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 paneles 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
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperar plantillas por nombre
Recuperar todos los datos sobre dos plantillas llamadas "Linux" y "Windows".
{
"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": "Esta es una plantilla oficial de Linux. Requiere el agente Zabbix 7.4 o superior.\r\n\r\nNotas sobre el descubrimiento del sistema de archivos (FS):\r\n- El sistema de archivos ext4/3/2 reserva espacio para uso privilegiado, normalmente establecido en un 5% por defecto.\r\n- BTRFS asigna por defecto un 10% del volumen para sus propias necesidades.\r\n- Para mitigar posibles desastres, los disparadores de uso del FS se basan en el espacio máximo disponible.\r\n - Fórmula de utilización: 'pused = 100 - 100 * (available / total - free + available)'\r\n- El gráfico de utilización del FS, derivado de prototipos de gráficos, refleja el espacio reservado del FS como la diferencia entre el espacio usado y el disponible del volumen total.\r\n\r\nPuede discutir esta plantilla o dejar comentarios en nuestro foro https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387225-discussion-thread-for-official-zabbix-template-for-linux\r\n\r\nGenerado por la herramienta oficial de plantillas de 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": "## Descripción general\r\n\r\nEsta es una plantilla oficial de Linux. Requiere el agente Zabbix 7.4 o superior.\r\n\r\n#### Notas sobre el descubrimiento del sistema de archivos (FS):\r\n- El FS ext4/3/2 reserva espacio para uso privilegiado, normalmente establecido en un 5% por defecto.\r\n- BTRFS asigna por defecto un 10% del volumen para sus propias necesidades.\r\n- Para mitigar posibles desastres, los disparadores de uso del FS se basan en el espacio máximo disponible.\r\n - Fórmula de utilización: `pused = 100 - 100 * (available / total - free + available)`\r\n- El gráfico de utilización del FS, derivado de prototipos de gráficos, refleja el espacio reservado del FS como la diferencia entre el espacio usado y el disponible del volumen total."
},
{
"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": "Esta es una plantilla oficial de Windows. Requiere el agente Zabbix 7.4 o superior.\r\n\r\nPuede discutir esta plantilla o dejar comentarios en nuestro foro https://www.zabbix.com/forum/zabbix-suggestions-and-feedback/387224-discussion-thread-for-official-zabbix-template-for-windows\r\n\r\nGenerado por la herramienta oficial de plantillas de 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": "## Descripción general\r\n\r\nEsta es una plantilla oficial de Windows. Requiere el agente Zabbix 7.4 o superior."
}
],
"id": 1
}Recuperar grupos de plantillas
Recuperar los grupos de plantillas de los que la plantilla "Linux por agente Zabbix" es miembro.
{
"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 vinculada la plantilla "10001" (Linux por agente Zabbix).
{
"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 plantilla
Recuperar plantillas 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": [
{
"hostid": "10402",
"tags": [
{
"tag": "host-name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Ver también
Fuente
CTemplate::get() en ui/include/classes/api/services/CTemplate.php.