Esta página fue traducida automáticamente. Si detectas un error, selecciónalo y presiona Ctrl+Enter para informarlo a los editores.

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/array Devolver solo las plantillas con los IDs de plantilla dados.
groupids ID/array Devolver solo las plantillas que pertenecen a los grupos de plantillas dados.
parentTemplateids ID/array Devolver solo las plantillas a las que la plantilla dada está vinculada.
hostids ID/array Devolver solo las plantillas que están vinculadas a los hosts/plantillas dados.
graphids ID/array Devolver solo las plantillas que contienen los gráficos dados.
itemids ID/array Devolver solo las plantillas que contienen los elementos dados.
triggerids ID/array Devolver solo las plantillas que contienen las acciones dadas.
with_items flag Devolver solo las plantillas que tienen elementos.
with_triggers flag Devolver solo las plantillas que tienen acciones.
with_graphs flag Devolver solo las plantillas que tienen gráficos.
with_httptests flag Devolver solo las plantillas que tienen escenarios web.
evaltype entero Reglas para la búsqueda de etiquetas.

Valores posibles:
0 - (por defecto) Y/O;
2 - O.
tags objeto/array Devolver solo las plantillas con las etiquetas dadas. Coincidencia exacta por etiqueta y búsqueda sensible o no sensible a mayúsculas/minúsculas por valor de etiqueta dependiendo del valor del operador.
Formato: [{"tag": "<etiqueta>", "value": "<valor>", "operator": "<operador>"}, ...].
Un array vacío devuelve todas las plantillas.

Valores posibles del operador:
0 - (por defecto) Contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas);
1 - Igual (sensible a mayúsculas/minúsculas);
2 - No contiene (coincidencia de subcadena, no sensible a mayúsculas/minúsculas);
3 - No igual (sensible a mayúsculas/minúsculas);
4 - Existe;
5 - No existe.
selectTags consulta Devolver las etiquetas de la plantilla en la propiedad tags.
selectHosts consulta Devolver los hosts que están vinculados a la plantilla en la propiedad hosts.

Admite count.
selectTemplateGroups consulta Devolver los grupos de plantillas a los que pertenece la plantilla en la propiedad templategroups.
selectTemplates consulta Devolver las plantillas a las que la plantilla dada está vinculada en la propiedad templates.

Admite count.
selectParentTemplates consulta Devolver las plantillas que están vinculadas a la plantilla dada en la propiedad parentTemplates.

Admite count.
selectHttpTests consulta Devolver los escenarios web de la plantilla en la propiedad httpTests.

Admite count.
selectItems consulta Devolver los elementos de la plantilla en la propiedad items.

Admite count.
selectDiscoveries consulta Devolver los descubrimientos de bajo nivel de la plantilla en la propiedad discoveries.

Admite count.
selectTriggers consulta Devolver las acciones de la plantilla en la propiedad triggers.

Admite count.
selectGraphs consulta Devolver los gráficos de la plantilla en la propiedad graphs.

Admite count.
selectMacros consulta Devolver las macros de la plantilla en la propiedad macros.
selectDashboards consulta Devolver los paneles de la plantilla en la propiedad dashboards.

Admite count.
selectValueMaps consulta Devolver una propiedad valuemaps con los mapas de valores de la plantilla.
limitSelects entero 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 booleano Estos parámetros se describen en el comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder string/array
startSearch booleano
selectGroups
(obsoleto)
consulta Este parámetro está obsoleto, por favor use selectTemplateGroups en su lugar.
Devuelve los grupos de plantillas a los que pertenece la plantilla en la propiedad groups.

Valores de retorno

(entero/matriz) Devuelve:

  • una matriz de objetos;
  • el recuento de objetos recuperados, si el parámetro countOutput ha sido usado.

Ejemplos

Recuperar plantillas por nombre

Recupere todos los datos sobre dos plantillas denominadas "Linux" y "Windows".

Solicitud:

{
           "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".

Solicitud:

{
           "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.

Solicitud:

{
           "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}".

Solicitud:

{
           "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.