template.get

Descripción

integer/array template.get(object parameters)

El método permite recuperar templates según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden revocarse en la configuración de roles de usuario. Consulte User roles para obtener más información.

Parámetros

(object) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parameter Type Description
templateids ID/array Devuelve solo templates con los IDs de template indicados.
groupids ID/array Devuelve solo templates que pertenecen a los grupos de templates indicados.
parentTemplateids ID/array Devuelve solo templates a los que está vinculado el template indicado.
hostids ID/array Devuelve solo templates que están vinculados a los hosts/templates indicados.
graphids ID/array Devuelve solo templates que contienen los graphs indicados.
itemids ID/array Devuelve solo templates que contienen los items indicados.
triggerids ID/array Devuelve solo templates que contienen los triggers indicados.
with_items flag Devuelve solo templates que tienen items.
with_triggers flag Devuelve solo templates que tienen triggers.
with_graphs flag Devuelve solo templates que tienen graphs.
with_httptests flag Devuelve solo templates que tienen escenarios web.
evaltype integer Método de evaluación de etiquetas.

Valores posibles:
0 - (predeterminado) Y/O;
2 - O.
tags object/array Devuelve solo templates con las etiquetas indicadas.
Formato: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].
Un array vacío devuelve todos los templates.

Valores posibles de operator:
0 - (predeterminado) Contiene;
1 - Igual a;
2 - No contiene;
3 - No es igual a;
4 - Existe;
5 - No existe.
selectTags query Devuelve las etiquetas del template en la propiedad tags.
selectHosts query Devuelve los hosts que están vinculados al template en la propiedad hosts.

Admite count.
selectTemplateGroups query Devuelve los grupos de templates a los que pertenece el template en la propiedad templategroups.
selectTemplates query Devuelve los templates a los que está vinculado el template indicado en la propiedad templates.

Admite count.
selectParentTemplates query Devuelve los templates que están vinculados al template indicado en la propiedad parentTemplates.

Admite count.
selectHttpTests query Devuelve los escenarios web del template en la propiedad httpTests.

Admite count.
selectItems query Devuelve los items del template en la propiedad items.

Admite count.
selectDiscoveries query Devuelve las detecciones de bajo nivel del template en la propiedad discoveries.

Admite count.
selectTriggers query Devuelve los triggers del template en la propiedad triggers.

Admite count.
selectGraphs query Devuelve los graphs del template en la propiedad graphs.

Admite count.
selectMacros query Devuelve las macros del template en la propiedad macros.
selectDashboards query Devuelve los dashboards del template en la propiedad dashboards.

Admite count.
selectValueMaps query Devuelve una propiedad valuemaps con los mapas de valores del template.
limitSelects integer Limita el número de registros devueltos por las 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 Ordena 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
selectGroups
(deprecated)		 query Este parámetro está obsoleto; utilice selectTemplateGroups en su lugar.
Devuelve los grupos de templates a los que pertenece el template en la propiedad groups.

Valores de retorno

(integer/array) Devuelve cualquiera de los siguientes:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar templates por nombre

Recupere todos los datos sobre dos templates llamados "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
}

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 template

Recupera los templates que tienen 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.