Documentation
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.
Cette méthode est disponible à tous les types d'utilisateurs. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres du le rôle d'utilisateur. Voir Rôles Utilisateur pour plus d'informations.
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 qui appartiennent aux groupes d'hôtes donnés. |
| parentTemplateids | string/array | Renvoie uniquement les modèles qui sont parents des modèles donnés. |
| hostids | string/array | Renvoie uniquement les modèles liés aux hôtes/modèles donnés. |
| graphids | string/array | Renvoie uniquement les modèles contenant les graphiques donnés. |
| itemids | string/array | Renvoie uniquement les modèles qui contiennent 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 contenant des graphiques. |
| with_httptests | flag | Renvoie uniquement les modèles qui ont des scénarios Web. |
| evaltype | integer | Règles de recherche de tags. Valeurs possibles : 0 - (par défaut) Et/Ou ; 2 - Ou. |
| tags | array/object | Renvoie uniquement les modèles avec des tags donnés. Correspondance exacte par tag et recherche sensible ou insensible à la casse par valeur de tag en fonction de la valeur de l'opérateur. Format : [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Un tableau vide renvoie tous les modèles. Valeurs d'opérateur possibles : 0 - (par défaut) Contient ; 1 - Égal à ; 2 - Pas comme ; 3 - Pas égal< br>4 - Existe ; 5 - N'existe pas. |
| selectGroups | query | Renvoie les groupes d'hôtes auxquels le modèle appartient dans la propriété groups. |
| selectTags | query | Renvoie les tags de modèle dans la propriété tags. |
| 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 dont le modèle est un enfant, dans la propriété templates.Prend en charge count. |
| selectParentTemplates | query | Renvoyer les modèles dont le modèle est un parent, 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 | Renvoie 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. |
| selectMacros | query | Renvoie les macros du modèle dans la propriété macros. |
| selectDashboards | query | Renvoie les tableaux de bord du modèle dans la propriété dashboards. Prend en charge count. |
| selectValueMaps | query | Renvoie une propriété valuemaps avec des tables de correspondance de valeurs du modèle. |
| limitSelects | integer | Limite le nombre d'enregistrements renvoyés par les sous-sélections. S'applique aux sous-sélections suivantes : selectTemplates - les résultats seront triés par name ;selectHosts - triés par host ; selectParentTemplates - trié par host;selectItems - trié par name;selectDiscoveries - trié par name;selectTriggers - trié par description;selectGraphs - triés par name;selectDashboards - triés par name. |
| sortfield | string/array | Triez le résultat selon les propriétés données. Les valeurs possibles sont : hostid, host, name, status. |
| countOutput | boolean | Ces paramètres communs à toutes les méthodes get sont décrits en détail dans la page de commentaire 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érez toutes les données sur deux modèles nommés "Linux" et "Windows".
Requête :
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "extend",
"filter": {
"host": [
"Linux",
"Windows"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"proxy_hostid": "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"
},
{
"proxy_hostid": "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
}Retrieving template groups
Retrieve template groups that the template "Linux by Zabbix agent" is a member of.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTemplateGroups": "extend",
"filter": {
"host": [
"Linux by Zabbix agent"
]
}
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"templategroups": [
{
"groupid": "10",
"name": "Templates/Operating systems",
"uuid": "846977d1dfed4968bc5f8bdb363285bc"
}
]
}
],
"id": 1
}Retrieving hosts by template
Retrieve hosts that have the "10001" (Linux by Zabbix agent) template linked to them.
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": "templateid",
"templateids": "10001",
"selectHosts": ["hostid", "name"]
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Zabbix server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Recherche par tags de modèle
Récupérez les modèles dont le tag "Host name"" est égale à "{HOST.NAME}".
Requête :
{
"jsonrpc": "2.0",
"method": "template.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}",
"operator": 1
}
]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Réponse :
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10402",
"tags": [
{
"tag": "Host name",
"value": "{HOST.NAME}"
}
]
}
],
"id": 1
}Voir également
Source
CTemplate::get() dans ui/include/classes/api/services/CTemplate.php.