Se encuentra viendo la documentación de la versión en desarrollo, puede estar incompleta.
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(parámetros del objeto)

El método permite recuperar plantillas según los parámetros dados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración del rol de usuario. Consulte 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 plantillas con los IDs de plantilla indicados.
groupids ID/array Devolver solo plantillas que pertenezcan a los grupos de plantillas indicados.
parentTemplateids ID/array Devolver solo plantillas a las que la plantilla indicada esté vinculada.
hostids ID/array Devolver solo plantillas que estén vinculadas a los equipos/plantillas indicados.
graphids ID/array Devolver solo plantillas que contengan los gráficos indicados.
itemids ID/array Devolver solo plantillas que contengan las métricas indicadas.
triggerids ID/array Devolver solo plantillas que contengan las alertas indicadas.
with_items flag Devolver solo plantillas que tengan métricas.
with_triggers flag Devolver solo plantillas que tengan alertas.
with_graphs flag Devolver solo plantillas que tengan gráficos.
with_httptests flag Devolver solo plantillas que tengan escenarios web.
evaltype integer Reglas para la búsqueda de etiquetas.

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

Valores posibles del operador:
0 - (por defecto) Contiene;
1 - Igual;
2 - No contiene;
3 - No igual;
4 - Existe;
5 - No existe.
selectTags query Devolver las etiquetas de la plantilla en la propiedad tags.
selectHosts query Devolver los equipos que están vinculados a la plantilla en la propiedad hosts.

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

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

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

Admite count.
selectItems query Devolver las métricas de la plantilla en la propiedad items.

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

Admite count.
selectTriggers query Devolver las alertas de la plantilla en la propiedad triggers.

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

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

Admite count.
selectValueMaps query Devolver una propiedad valuemaps con los mapas de valores de la plantilla.
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 indicadas.

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

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

Recuperar plantillas por nombre

Recuperar todos los datos sobre dos plantillas llamadas "Linux" y "Windows".

Solicitud:

{
           "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 Zabbix agent 8.0 o superior.\r\n\r\nNotas sobre el descubrimiento de sistemas 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 de 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 de FS, derivado de prototipos de gráficos, refleja el espacio reservado de 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": "8.0-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 Zabbix agent 8.0 o superior.\r\n\r\n#### Notas sobre el descubrimiento de sistemas 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 de 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 de FS, derivado de prototipos de gráficos, refleja el espacio reservado de 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 Zabbix agent 8.0 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": "8.0-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 Zabbix agent 8.0 o superior."
               }
           ],
           "id": 1
       }

Recuperar grupos de plantillas

Recuperar 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
       }

Recuperar equipos por plantilla

Recuperar los equipos que tienen la plantilla "10001" (Linux por 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
       }

Véase también

Fuente

CTemplate::get() en ui/include/classes/api/services/CTemplate.php.