Sidebar
fr:manual:api:reference:template:get
Table of Contents
template.get
Description
integer/array template.get(object parameters)
La méthode permet de récupérer des modèles en fonction des paramètres donnés.
Paramètres
(object) Paramètres définissant la sortie souhaitée.
La méthode prend en charge les paramètres suivants.
| Paramètre | Type | Description |
|---|---|---|
| templateids | string/array | Renvoie uniquement les modèles avec les ID de modèle donnés. |
| groupids | string/array | Renvoie uniquement les modèles appartenant aux groupes d'hôtes donnés. |
| parentTemplateids | string/array | Renvoie uniquement les modèles qui sont les enfants des modèles donnés. |
| hostids | string/array | Renvoie uniquement les modèles liés aux hôtes donnés. |
| graphids | string/array | Renvoie uniquement les modèles contenant les graphiques donnés. |
| itemids | string/array | Renvoie uniquement les modèles contenant les éléments donnés. |
| triggerids | string/array | Renvoie uniquement les modèles contenant les déclencheurs donnés. |
| with_items | flag | Renvoie uniquement les modèles contenant des éléments. |
| with_triggers | flag | Renvoie uniquement les modèles qui ont des déclencheurs. |
| with_graphs | flag | Renvoie uniquement les modèles comportant des graphiques. |
| with_httptests | flag | Renvoie uniquement les modèles comportant des scénarios Web. |
| selectGroups | query | Renvoie les groupes d'hôtes auxquels le modèle appartient dans la propriété groups. |
| selectHosts | query | Renvoie les hôtes liés au modèle dans la propriété hosts. Prend en charge count. |
| selectTemplates | query | Renvoie les modèles enfants dans la propriété templates. Prend en charge count. |
| selectParentTemplates | query | Renvoie les modèles parents dans la propriété parentTemplates. Prend en charge count. |
| selectHttpTests | query | Renvoie les scénarios Web du modèle dans la propriété httpTests. Prend en charge count. |
| selectItems | query | Renvoie les éléments du modèle dans la propriété items. Prend en charge count. |
| selectDiscoveries | query | Renvoyez les découvertes de bas niveau du modèle dans la propriété discoveries. Prend en charge count. |
| selectTriggers | query | Renvoie les déclencheurs du modèle dans la propriété triggers. Prend en charge count. |
| selectGraphs | query | Renvoie les graphiques du modèle dans la propriété graphs. Prend en charge count. |
| selectApplications | query | Revoie les applications à partir du modèle dans la propriété applications. Prend en charge count. |
| selectMacros | query | Renvoie les macros du modèle dans la propriété macros. |
| selectScreens | query | Renvoie les écrans du modèle dans la propriété screens. Prend en charge count. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-requêtes. S'applique aux sous-requêtes suivantes : selectTemplates - les résultats seront triés par name ; selectHosts - triés par host ; selectParentTemplates - triés par host ; selectItems - triés par name ; selectDiscoveries - triés par name ; selectTriggers - triés par description ; selectGraphs - triés par name ; selectApplications - triés par name ; selectScreens - triés par name. |
| sortfield | string/array | Trie le résultat en fonction des propriétés données. Valeurs possibles : hostid, host, name, status. |
| countOutput | boolean | Ces paramètres, communs à toutes les méthodes “get”, sont décrits dans les commentaires de référence. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean | |
Valeurs retournées
(integer/array) Retourne soit :
- un tableau d'objets ;
- le nombre d'objets récupérés, si le paramètre
countOutputa été utilisé.
Exemples
Récupération des modèles par nom
Récupération de toutes les données sur deux modèles nommés “Template OS Linux” et “Template OS Windows”.
Requête :
{ "jsonrpc": "2.0", "method": "template.get", "params": { "output": "extend", "filter": { "host": [ "Template OS Linux", "Template OS Windows" ] } }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "proxy_hostid": "0", "host": "Template OS 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": "Template OS Linux", "flags": "0", "templateid": "10001", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "tls_psk_identity": "", "tls_psk": "" }, { "proxy_hostid": "0", "host": "Template OS 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": "Template OS Windows", "flags": "0", "templateid": "10081", "description": "", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "tls_psk_identity": "", "tls_psk": "" } ], "id": 1 }
Voir également
Source
CTemplate::get() dans frontends/php/include/classes/api/services/CTemplate.php.