hostgroup.get

Description

integer/array hostgroup.get(object parameters)

La méthode permet de récupérer des groupes d’hôtes selon les paramètres fournis.

Cette méthode est disponible pour les utilisateurs de tout type. Les autorisations d’appel de la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles 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
graphids ID/array Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec les graphiques indiqués.
groupids ID/array Retourne uniquement les groupes d’hôtes correspondant aux ID de groupes d’hôtes indiqués.
hostids ID/array Retourne uniquement les groupes d’hôtes qui contiennent les hôtes indiqués.
maintenanceids ID/array Retourne uniquement les groupes d’hôtes affectés par les maintenances indiquées.
triggerids ID/array Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec les déclencheurs indiqués.
with_graphs boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des graphiques.
with_graph_prototypes boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des prototypes de graphiques.
with_hosts boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes.
with_httptests boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des contrôles web.

Remplace le paramètre with_monitored_httptests.
with_items boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des éléments.

Remplace les paramètres with_monitored_items et with_simple_graph_items.
with_item_prototypes boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des prototypes d’éléments.

Remplace le paramètre with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des prototypes d’éléments activés pour la création et dont le type d’information est numérique.
with_monitored_httptests boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des contrôles web activés.
with_monitored_hosts boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes surveillés.
with_monitored_items boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des éléments activés.

Remplace le paramètre with_simple_graph_items.
with_monitored_triggers boolean Retourne uniquement les groupes d’hôtes qui contiennent 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 boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des éléments numériques.
with_triggers boolean Retourne uniquement les groupes d’hôtes qui contiennent des hôtes avec des déclencheurs.

Remplace le paramètre with_monitored_triggers.
selectDiscoveryRules query Retourne une propriété discoveryRules contenant les règles de découverte qui ont découvert le groupe d’hôtes.
selectGroupDiscoveries query Retourne une propriété groupDiscoveries contenant les objets de découverte de groupes d’hôtes.

Chaque objet de découverte de groupe d’hôtes est un prototype de groupe d’hôtes lié au groupe d’hôtes découvert et possède les propriétés suivantes :
parent_group_prototypeid - (ID) ID du prototype de groupe d’hôtes à partir duquel le groupe d’hôtes a été découvert ;
name - (string) nom du prototype de groupe d’hôtes ;
lastcheck - (timestamp) date et heure de la dernière découverte du groupe d’hôtes ;
ts_delete - (timestamp) date et heure auxquelles le groupe d’hôtes qui n’est plus découvert sera supprimé ;
status - (int) état de découverte du groupe d’hôtes :
0 - (par défaut) le groupe d’hôtes est découvert,
1 - le groupe d’hôtes n’est plus découvert.
selectHostPrototypes query Retourne une propriété hostPrototypes contenant les prototypes d’hôtes qui ont découvert ce groupe d’hôtes.
selectHosts query Retourne une propriété hosts contenant les hôtes appartenant au groupe d’hôtes.

Prend en charge count.
limitSelects integer Limite le nombre d’enregistrements retournés par les sous-sélections.

S’applique aux sous-sélections suivantes :
selectHosts - les résultats seront triés par host.
sortfield string/array Trie le résultat selon les propriétés indiquées.

Valeurs possibles : groupid, name.
countOutput boolean Ces paramètres sont décrits dans le 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
monitored_hosts
(deprecated)		 flag Ce paramètre est obsolète ; veuillez utiliser with_monitored_hosts à la place.
Retourne uniquement les groupes d’hôtes qui contiennent des hôtes surveillés.
real_hosts
(deprecated)		 flag Ce paramètre est obsolète ; veuillez utiliser with_hosts à la place.
Retourne uniquement les groupes d’hôtes qui contiennent des hôtes.

Valeurs de retour

(integer/array) Renvoie 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érez toutes les données concernant deux groupes d’hôtes nommés « Zabbix servers » et « Linux servers ».

Requête:

{
    "jsonrpc": "2.0",
    "method": "hostgroup.get",
    "params": {
        "output": "extend",
        "filter": {
            "name": [
                "Zabbix servers",
                "Linux servers"
            ]
        }
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "flags": "0",
            "uuid": "dc579cd7a1a34222933f24f52a68bcd8"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "flags": "0",
            "uuid": "6f6799aa69e844b4b3918f779f2abf08"
        }
    ],
    "id": 1
}

Voir aussi

Source

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