Zabbix Documentation 4.0

3.04.04.4 (current)| In development:5.0 (devel)| Unsupported:1.82.02.22.43.23.44.2Guidelines

User Tools

Site Tools


Sidebar

fr:manual:api:reference:hostgroup:get

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.

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 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 booleanCes 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 “Zabbix servers” et “Linux servers”.

Requête :

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

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "groupid": "2",
            "name": "Linux servers",
            "internal": "0"
        },
        {
            "groupid": "4",
            "name": "Zabbix servers",
            "internal": "0"
        }
    ],
    "id": 1
}

Voir également

Source

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