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
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| templateids | ID/matriz | Devuelve solo plantillas con los ID de plantilla proporcionados. |
| groupids | ID/matriz | Devuelve sólo las plantillas que pertenecen a los grupos de plantillas dados. |
| parentTemplateids | ID/matriz | Devuelve solo las plantillas a las que está vinculada la plantilla dada. |
| hostids | ID/matriz | Devuelve solo las plantillas que están vinculadas a los equipos/plantillas dados. |
| graphids | ID/array | Devuelve solo las plantillas que contienen los gráficos proporcionados. |
| itemids | ID/array | Devuelve solo las plantillas que contienen las métricas dadas. |
| triggerids | ID/matriz | Devuelve solo las plantillas que contienen los iniciadores dados. |
| with_items | flag | Devuelve sólo las plantillas que tienen métricas. |
| with_triggers | flag | Devuelve sólo las plantillas que tienen iniciadores. |
| with_graphs | flag | Devuelve sólo plantillas que tienen gráficos. |
| with_httptests | flag | Devuelve sólo plantillas que tienen escenarios web. |
| evaltype | entero | Reglas para la búsqueda de etiquetas. Valores posibles: 0 - (predeterminado) Y/O; 2 - O. |
| tags | objeto/matriz | Devuelve solo plantillas con etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda que distinga entre mayúsculas y minúsculas por valor de etiqueta según el valor del operador. Formato: [{"tag": "<tag>", "value": "<value>", " operador": "<operador>"}, ...].Una matriz vacía devuelve todas las plantillas. Valores posibles del operador: 0 - (predeterminado) Contiene; 1 - Igual; 2 - No me gusta; 3 - No igual; 4 - Existe; 5 - No existe. |
| selectTags | query | Devolver etiquetas de plantilla en la propiedad tags. |
| selectHosts | query | Devuelve los equipos que están vinculados a la plantilla en la propiedad hosts.Admite count. |
| selectTemplateGroups | query | Devuelve los grupos de plantillas a los que pertenece la plantilla en la propiedad templategroups. |
| selectTemplates | query | Devuelve las plantillas a las que la plantilla dada está vinculada en la propiedad templates.Admite count. |
| selectParentTemplates | query | Devuelve plantillas que están vinculadas a la plantilla dada en la propiedad parentTemplates.Admite count. |
| selectHttpTests | query | Devuelve los escenarios web de la plantilla en la propiedad httpTests.Admite count. |
| selectItems | query | Devuelve métricas de la plantilla en la propiedad items.Admite count. |
| selectDiscoveries | query | Devuelve descubrimientos de bajo nivel de la plantilla en la propiedad discoveries.Admite count. |
| selectTriggers | query | Devuelve desencadenadores de la plantilla en la propiedad triggers.Admite count. |
| selectGraphs | query | Devuelve gráficos de la plantilla en la propiedad graphs.Admite count. |
| selectMacros | consulta | Devuelve las macros de la plantilla en la propiedad macros. |
| selectDashboards | query | Devuelve paneles de la plantilla en la propiedad dashboards.Admite count. |
| selectValueMaps | query | Devuelve una propiedad valuemaps con mapas de valores de plantilla. |
| 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 nombre;selectHosts: ordenados por host;selectParentTemplates - ordenado por host;selectItems - ordenado por name;selectDiscoveries - ordenado por name;selectTriggers - ordenado por descripción;selectGraphs - ordenado por nombre;selectDashboards - ordenado por nombre. |
| sortfield | string/array | Ordena el resultado por las propiedades dadas. Valores posibles: hostid, host, name, status. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen detalladamente en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | objeto | |
| limit | entero | |
| output | consulta | |
| preservekeys | booleano | |
| search | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | booleano | |
| selectGroups (deprecated) |
query | Este parámetro está en desuso, utilice selectTemplateGroups en su lugar.Devuelve los grupos de plantillas a los que pertenece la plantilla en groups. |
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
Recupere todos los datos sobre dos plantillas denominadas "Linux" y "Windows".
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux",
"Windows"
]
}
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"proxyid": "0",
"host": "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": "Linux",
"flags": "0",
"templateid": "10001",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": "",
"uuid": "282ffe33afc74cccaf1524d9aa9dc502"
},
{
"proxyid": "0",
"host": "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": "Windows",
"flags": "0",
"templateid": "10081",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"tls_psk_identity": "",
"tls_psk": "",
"uuid": "522d17e1834049be879287b7c0518e5d"
}
],
"id": 1
}Recuperando grupos de plantillas
Recupere 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
}Recuperando equipos por plantilla
Recupere equipos que tengan la plantilla "10001" (Linux by 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 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.