Documentation
Table of Contents
template.get
Descripció
integer/array template.get(object parameters)
El mètode permet recuperar plantilles segons els paràmetres proveïts.
Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.
Paramètres
(object) Paràmetres que defineixen la sortida esperada.
El mètode admet els paràmetres següents.
| Paràmetre | Tipus | Descripció |
|---|---|---|
| templateids | ID/array | Retorna només plantilles amb els ID de plantilla donats. |
| groupids | ID/array | Retorna només els patrons que pertanyen als grups d'equips donats. |
| parentTemplateids | string/array | Retorna només les plantilles que són pares de les plantilles donades. |
| hostids | ID/array | Retorna només patrons relacionats amb els hosts/patrons donats. |
| graphids | ID/array | Retorna només els models que contenen els gràfics donats. |
| itemids | ID/array | Retorna només els models que contenen els elements donats. |
| triggerids | ID/array | Retorna només els patrons que contenen els triggers donats. |
| with_items | flag | Retorna només models amb articles. |
| with_triggers | flag | Retorna només els models que tenen triggers. |
| with_graphs | flag | Retorna només models que contenen gràfics. |
| with_httptests | marca | Retorna només models que tenen escenaris web. |
| evaltype | integer | Regles de cerca d'etiquetes. Valors possibles: 0 - (per defecte) I/O; 2 - O. |
| tags | array/objecte | Retorna només models amb etiquetes donades. Concordança exacta per etiqueta i cerca entre majúscules i minúscules o no per valor de l'etiqueta en funció del valor de l'operador. Format: [{"tag": "<etiqueta>", "valor": "< valor>", " operator": "<operador>"}, ...].Una matriu buida retorna tots els models. Possibles valors d'operador: 0 - (per defecte) Conté; 1 - És igual; 2 - No és com; 3 - No és igual< br>4 - Existeix; 5 - No existeix. |
| selectTags | query | Retorna les etiquetes de plantilla a la propietat etiquetes. |
| selectHosts | query | Retorna els equips vinculats al model a la propietat equips. Admet count. |
| selectTemplateGroups | query | Retorna els grups de plantilles als quals pertany la plantilla a la propietat templategroups. |
| selectTemplates | query | Retorna les plantilles de les quals la plantilla és secundària, a la propietat templates.Admet count. |
| selectParentTemplates | query | Retorna les plantilles de les quals la plantilla n'és pare, a la propietat parentTemplates.Admet count. |
| selectHttpTests | query | Retorna els escenaris web del model a la propietat httpTests. Admet count. |
| selectItems | query | Retorna els elements del model a la propietat elements. Admet count. |
| selectDiscoveries | query | Retorna els descobriments de baix nivell del model a la propietat discoveries.Admet count. |
| selectTriggers | query | Retorna triggers del model a la propietat triggers. Admet count. |
| selectGraphs | query | Retorna gràfics del model a la propietat gràfics. Admet count. |
| selectMacros | query | Retorna macros del model a la propietat macros. |
| selectDashboards | query | Retorna els taulers de control de la plantilla a la propietat taulers de control. Admet count. |
| selectValueMaps | query | Retorna una propietat valuemaps amb taules d'assignació de valors del model. |
| limitSelects | integer | Limita el nombre de registres retornats per subseleccions. S'aplica a les subseleccions següents: selectTemplates - els resultats s'ordenaran per name;< br>selectHosts - ordenats per host; selectParentTemplates - ordenat per host;selectItems - ordenat per name;selectDiscoveries - ordenat per name;selectTriggers - ordenat per description;selectGraphs - ordenat per name;selectDashboards - ordenat per name. |
| sortfield | string/array | Ordena el resultat segons les propietats donades. Els valors possibles són: hostid, host, name, status. |
| countOutput | boolean | Aquests paràmetres es descriuen en detall a la pàgina comentaris de referència. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
| selectGroups (obsolet) | query | Aquest paràmetre és obsolet; si et plau, empra selectTemplateGroups en el seu lloc.Retorna els grups de plantilles als que pertany la plantilla a la propietat groups. |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el paràmetre
countOutput.
Exemples
Recuperar les plantilles per nom
Recupera totes les dades de dues plantilles anomenades "Linux" i "Windows".
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": "extend", "filter": { "host": [ "Linux", "Windows" ] } }, "id": 1 }Resposta:
{ "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 grups de plantilles
Recupera els grups de plantilles d'on la plantilla "Linux amb agent Zabbix" n'és membre.
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": ["hostid"], "selectTemplateGroups": "extend", "filter": { "host": [ "Linux amb agent Zabbix" ] } }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "templateid": "10001", "templategroups": [ { "groupid": "10", "name": "Plantilles/Sistemes operatius", "uuid": "846977d1dfed4968bc5f8bdb363285bc" } ] } ], "id": 1 }Recuperar equips per plantilla
Recupera els equips que tenen la plantilla "10001" (Linux amb agent Zabbix) enllaçada.
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": "templateid", "templateids": "10001", "selectHosts":["hostid", "name"] }, "id": 1 }Resposta:
{ "jsonrpc": "2.0", "result": [ { "templateid": "10001", "hosts": [ { "hostid": "10084", "name": "Zabbix server" }, { "hostid": "10603", "name": "Host 1" }, { "hostid": "10604", "name": "Host 2" } ] } ], "id": 1 }Cercar per etiquetes de plantilla
Cercar les plantilles on l'etiqueta "host-name" sigui igual a "{EQUIP.NOM}".
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": ["hostid"], "selectTags": "extend", "evaltype": 0, "tags": [ { "tag": "Nom d'equip", "value": "{EQUIP.NOM}", "operator": 1 } ] }, "id": 1 }Response:
{ "jsonrpc": "2.0", "result": [ { "hostid": "10402", "tags": [ { "tag": "host-name", "value": "{HOST.NAME}" } ] } ], "id": 1 }Veieu també
Font
CTemplate::get() in ui/include/classes/api/services/CTemplate.php.