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 Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec les graphiques donnés.
groupids ID/array Retourner uniquement les groupes d'hôtes avec les ID de groupes d'hôtes donnés.
hostids ID/array Retourner uniquement les groupes d'hôtes qui contiennent les hôtes donnés.
maintenanceids ID/array Retourner uniquement les groupes d'hôtes qui sont affectés par les maintenances données.
triggerids ID/array Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec les déclencheurs donnés.
with_graphs boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des graphiques.
with_graph_prototypes boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des prototypes de graphiques.
with_hosts boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes.
with_httptests boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des scénarios web.

Remplace le paramètre with_monitored_httptests.
with_items boolean Retourner 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 Retourner 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 Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des prototypes d'éléments, qui sont activés pour la création et ont un type d'information numérique.
with_monitored_httptests boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des scénarios web activés.
with_monitored_hosts boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes surveillés.
with_monitored_items boolean Retourner 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 Retourner 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 Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des éléments numériques.
with_triggers boolean Retourner uniquement les groupes d'hôtes qui contiennent des hôtes avec des déclencheurs.

Remplace le paramètre with_monitored_triggers.
selectDiscoveryRules query Retourner une propriété discoveryRules avec les règles LLD qui ont découvert le groupe d'hôtes.
selectDiscoveryData query Retourner une propriété discoveryData avec 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 ;
ts_delete - (timestamp) heure à laquelle le groupe d'hôtes qui n'est plus découvert sera supprimé ;
status - (int) statut 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 Retourner une propriété hostPrototypes avec les prototypes d'hôtes qui ont découvert ce groupe d'hôtes.
selectHosts query Retourner une propriété hosts avec les hôtes qui appartiennent au groupe d'hôtes.

Prend en charge count.
limitSelects integer Limite le nombre d'enregistrements renvoyé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 Trier le résultat selon les propriétés donné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
selectGroupDiscoveries query Retourner une propriété groupDiscoveries avec 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.

Cette requête est obsolète, veuillez utiliser selectDiscoveryData à la place.

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.