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 sólo las templates con los IDs de template dados. |
| groupids | ID/array | Devolver sólo las templates que pertenecen a los grupos de templates dados. |
| parentTemplateids | ID/array | Devolver sólo las templates a las que está vinculada la template dada. |
| hostids | ID/array | Devolver sólo las templates que están vinculadas a los hosts/templates dados. |
| graphids | ID/array | Devolver sólo las templates que contienen los gráficos dados. |
| itemids | ID/array | Devolver sólo las templates que contienen los items dados. |
| triggerids | ID/array | Devolver sólo las templates que contienen los triggers dados. |
| with_items | flag | Devolver sólo las templates que tienen items. |
| with_triggers | flag | Devolver sólo las templates que tienen triggers. |
| with_graphs | flag | Devolver sólo las templates que tienen gráficos. |
| with_httptests | flag | Devolver sólo las templates que tienen escenarios web. |
| evaltype | integer | Método de evaluación de la etiqueta. Valores posibles: 0 - (por defecto) And/Or; 2 - Or. |
| tags | object/array | Devolver sólo 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. |
| selectHosts | query | Devolver los hosts que están vinculados a la template en la propiedad hosts.Admite 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 está vinculada la template dada en la propiedad templates.Admite count. |
| selectParentTemplates | query | Devolver las templates que están vinculadas a la template dada en la propiedad parentTemplates.Admite count. |
| selectHttpTests | query | Devolver los escenarios web de la template en la propiedad httpTests.Admite count. |
| selectItems | query | Devolver los items de la template en la propiedad items.Admite count. |
| selectDiscoveries | query | Devolver los descubrimientos de bajo nivel de la template en la propiedad discoveries.Admite count. |
| selectTriggers | query | Devolver los triggers de la template en la propiedad triggers.Admite count. |
| selectGraphs | query | Devolver los gráficos de la template en la propiedad graphs.Admite 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.Admite 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;selectDiscoveries - 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 | |
| selectGroups (obsoleto) |
query | Este parámetro está obsoleto, por favor utilice selectTemplateGroups en su lugar.Devuelve los grupos de templates a los que pertenece la template en la propiedad 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.