Sidebar
fr:manual:api:reference:hostprototype:get
Table of Contents
hostprototype.get
Description
integer/array hostprototype.get(object parameters)
La méthode permet de récupérer des prototypes d’hôte 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 |
|---|---|---|
| hostids | string/array | Renvoie uniquement les prototypes d'hôte avec les identifiants donnés. |
| discoveryids | string/array | Renvoie uniquement les prototypes d'hôte appartenant aux règles de découverte bas niveau données. |
| inherited | boolean | Si défini à true, ne renvoie que les éléments hérités d'un modèle. |
| selectDiscoveryRule | query | Renvoie la règle de découverte bas niveau à laquelle appartient le prototype d'hôte dans la propriété discoveryRule. |
| selectGroupLinks | query | Renvoie les liens de groupe du prototype d'hôte dans la propriété groupLinks. |
| selectGroupPrototypes | query | Renvoie les prototypes de groupe du prototype d'hôte dans la propriété groupPrototypes. |
| selectInventory | query | Renvoie l'inventaire du prototype d'hôte dans la propriété inventory. |
| selectParentHost | query | Renvoie l'hôte auquel appartient le prototype d'hôte dans la propriété parentHost. |
| selectTemplates | query | Renvoie les modèles liés au prototype d'hôte dans la propriété templates. Supporte count. |
| sortfield | string/array | Trie le résultat par les propriétés données. Les valeurs possibles sont : hostid, host, name et 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 prototypes d’hôte d’une règle de découverte bas niveau
Récupérer tous les prototypes d’hôte et leurs liens de groupe et les prototypes de groupe d’une règle de découverte bas niveau.
Requête :
{ "jsonrpc": "2.0", "method": "hostprototype.get", "params": { "output": "extend", "selectGroupLinks": "extend", "selectGroupPrototypes": "extend", "discoveryids": "23554" }, "auth": "038e1d7b1735c6a5436ee9eae095879e", "id": 1 }
Réponse :
{ "jsonrpc": "2.0", "result": [ { "hostid": "10092", "host": "{#HV.UUID}", "status": "0", "name": "{#HV.NAME}", "templateid": "0", "tls_connect": "1", "tls_accept": "1", "tls_issuer": "", "tls_subject": "", "tls_psk_identity": "", "tls_psk": "", "groupLinks": [ { "group_prototypeid": "4", "hostid": "10092", "groupid": "7", "templateid": "0" } ], "groupPrototypes": [ { "group_prototypeid": "7", "hostid": "10092", "name": "{#CLUSTER.NAME}", "templateid": "0" } ] } ], "id": 1 }
Voir également
Source
CHostPrototype::get() dans frontends/php/include/classes/api/services/CHostPrototype.php.