Áú»¢¶Ä²©

This is the documentation page for an unsupported version of Áú»¢¶Ä²©.
Is this not what you were looking for? Switch to the current version or choose one from the drop-down menu.

hostgroup.get

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.

±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ

(object) ±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð²õ d¨¦finissant la sortie souhait¨¦e.

La m¨¦thode prend en charge les param¨¨tres suivants.

±Ê²¹°ù²¹³¾¨¨³Ù°ù±ð Type 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_applications flag Renvoie uniquement les groupes d'h?tes contenant des h?tes avec des applications.
with_graphs flag Renvoie uniquement les groupes d'h?tes contenant des h?tes avec des graphiques.
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_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 la r¨¨gle de d¨¦couverte bas niveau qui a cr¨¦¨¦ le groupe d'h?tes dans la propri¨¦t¨¦ discoveryRule.
selectGroupDiscovery query Renvoie l'objet de d¨¦couverte du groupe d'h?tes dans la propri¨¦t¨¦ groupDiscovery.

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 les h?tes appartenant au groupe d'h?tes dans la propri¨¦t¨¦ hosts.

Supporte count.
selectTemplates query Renvoie les mod¨¨les appartenant au groupe d'h?tes dans la propri¨¦t¨¦ templates.

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.
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 countOutput a ¨¦t¨¦ utilis¨¦.

Exemples

R¨¦cup¨¦ration des donn¨¦es par nom

R¨¦cup¨¦rer toutes les donn¨¦es sur deux groupes d'h?tes nomm¨¦s "Áú»¢¶Ä²© servers" et "Linux servers".

Requ¨ºte :

{
           "jsonrpc": "2.0",
           "method": "hostgroup.get",
           "params": {
               "output": "extend",
               "filter": {
                   "name": [
                       "Áú»¢¶Ä²© servers",
                       "Linux servers"
                   ]
               }
           },
           "auth": "6f38cddc44cfbb6c1bd186f9a220b5a0",
           "id": 1
       }

R¨¦ponse :

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Áú»¢¶Ä²© servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

Voir ¨¦galement

Source

CHostGroup::get() dans frontends/php/include/classes/api/services/CHostGroup.php.