[comment]: # translation:outdated [comment]: # ({f8d4c2e5-f8d4c2e5}) # hostgroup.get [comment]: # ({/f8d4c2e5-f8d4c2e5}) [comment]: # ({4c3e9332-08ff22f2}) ### Description `integer/array hostgroup.get(object parameters)` La méthode permet de récupérer des groupes d'hôtes en fonction des paramètres donnés. ::: noteclassic 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](/manual/web_interface/frontend_sections/administration/user_roles) pour plus d'informations. ::: [comment]: # ({/4c3e9332-08ff22f2}) [comment]: # ({674631c3-7f042696}) ### Paramètres `(object)` Paramètres définissant la sortie souhaitée. La méthode prend en charge les paramètres suivants. |Paramètre|[Type](/manual/api/reference_commentary#data_types)|Description| |--|--|------| |graphids|string/array|Renvoie uniquement les groupes d'hôtes contenant des hôtes ou des modèles avec les graphiques donnés.| |groupids|string/array|Renvoie uniquement les groupes d'hôtes avec les ID de groupe d'hôtes donnés.| |hostids|string/array|Renvoie uniquement les groupes d'hôtes contenant les hôtes donnés.| |maintenanceids|string/array|Renvoie uniquement les groupes d'hôtes affectés par les maintenances données.| |monitored\_hosts|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes surveillés.| |real\_hosts|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes.| |templated\_hosts|flag|Renvoie uniquement les groupes d'hôtes contenant des modèles.| |templateids|string/array|Renvoie uniquement les groupes d'hôtes contenant les modèles donnés.| |triggerids|string/array|Renvoie uniquement les groupes d'hôtes contenant des hôtes ou des modèles avec les déclencheurs donnés.| |with\_graphs|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des graphiques.| |with\_graph\_prototypes|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des prototypes de graphique.| |with\_hosts\_and\_templates|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes *ou* des modèles.| |with\_httptests|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des vérifications Web.

Écrase le paramètre `with_monitored_httptests`.| |with\_items|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes ou des modèles avec des éléments.

Écrase les paramètres `with_monitored_items` et `with_simple_graph_items`.| |with\_item\_prototypes|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes ou des modèles avec des prototypes d'élément.

Écrase le paramètre `with_simple_graph_item_prototypes`.| |with\_simple\_graph\_item\_prototypes|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des prototypes d'élément, activés à la création et ayant un type d'information numérique.| |with\_monitored\_httptests|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des surveillances Web activées.| |with\_monitored\_items|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes ou des modèles avec des éléments activés.

Écrase le paramètre `with_simple_graph_items`.| |with\_monitored\_triggers|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des déclencheurs activés. Tous les éléments utilisés dans le déclencheur doivent également être activés.| |with\_simple\_graph\_items|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des éléments numériques.| |with\_triggers|flag|Renvoie uniquement les groupes d'hôtes contenant des hôtes avec des déclencheurs.

Écrase le paramètre `with_monitored_triggers`.| |selectDiscoveryRule|query|Renvoie une propriété [discoveryRule](/manual/api/reference/drule/object) contenant la règle de découverte bas niveau qui a créé le groupe d'hôtes.| |selectGroupDiscovery|query|Renvoie la propriété `groupDiscovery` contenant l'objet de découverte du groupe d'hôtes.

L'objet de découverte de groupe d'hôtes lie un groupe d'hôtes découvert à un prototype de groupe d'hôtes et possède les propriétés suivantes :
`groupid` - `(string)` ID du groupe d'hôtes découvert ;
`lastcheck` - `(timestamp)` heure de la dernière découverte du groupe d'hôtes ;
`name` - `(string)` nom du prototype du groupe d'hôtes ;
`parent_group_prototypeid` - `(string)` ID du prototype du groupe d'hôtes à partir duquel le groupe d'hôtes a été créé ;
`ts_delete` - `(timestamp)` heure à laquelle un groupe d'hôtes qui n'est plus découvert sera supprimé.| |selectHosts|query|Renvoie une propriété [hosts](/manual/api/reference/host/object) contenant les hôtes appartenant au groupe d'hôtes.

Supporte `count`.| |selectTemplates|query|Renvoie une propriété [templates](/manual/api/reference/template/object) contenant les modèles appartenant au groupe d'hôtes.

Supporte `count`.| |limitSelects|integer|Limite le nombre d'enregistrements renvoyés par les sous-requêtes.

S'applique aux sous-requêtes suivantes :
`selectHosts` - les résultats seront triés par `host` ;
`selectTemplates` - les résultats seront triés par `host`.| |sortfield|string/array|Trie le résultat par les propriétés données.

Les valeurs possibles sont : `groupid`, `name`.| |countOutput|boolean|Ces paramètres, communs à toutes les méthodes `get`, sont décrits dans les [commentaires de référence](/manual/api/reference_commentary#common_get_method_parameters).| |editable|boolean|^| |excludeSearch|boolean|^| |filter|object|^| |limit|integer|^| |output|query|^| |preservekeys|boolean|^| |search|object|^| |searchByAny|boolean|^| |searchWildcardsEnabled|boolean|^| |sortorder|string/array|^| |startSearch|boolean|^| [comment]: # ({/674631c3-7f042696}) [comment]: # ({7223bab1-7223bab1}) ### Valeurs retournées `(integer/array)` Retourne soit : - un tableau d'objets ; - le nombre d'objets récupérés, si le paramètre `countOutput` a été utilisé. [comment]: # ({/7223bab1-7223bab1}) [comment]: # ({b41637d2-b41637d2}) ### Exemples [comment]: # ({/b41637d2-b41637d2}) [comment]: # ({03726a90-8ed2756a}) #### Récupération des données par nom Récupérez toutes les données sur deux groupes d'hôtes nommés "Zabbix servers" et "Linux servers". Requête : ```json { "jsonrpc": "2.0", "method": "hostgroup.get", "params": { "output": "extend", "filter": { "name": [ "Zabbix servers", "Linux servers" ] } }, "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0", "id": 1 } ``` Réponse : ```json { "jsonrpc": "2.0", "result": [ { "groupid": "2", "name": "Linux servers", "internal": "0" }, { "groupid": "4", "name": "Zabbix servers", "internal": "0" } ], "id": 1 } ``` [comment]: # ({/03726a90-8ed2756a}) [comment]: # ({2d4e90fe-e5f0abe1}) ### Voir également - [Hôte](/manual/api/reference/host/object#host) - [Modèle](/manual/api/reference/template/object#template) [comment]: # ({/2d4e90fe-e5f0abe1}) [comment]: # ({1e72ea39-1e72ea39}) ### Source CHostGroup::get() dans *ui/include/classes/api/services/CHostGroup.php*. [comment]: # ({/1e72ea39-1e72ea39})