[comment]: # translation:outdated

[comment]: # ({f8d4c2e5-f8d4c2e5})
# hostgroup.get

[comment]: # ({/f8d4c2e5-f8d4c2e5})

[comment]: # ({20294517-08ff22f2})
### Beschreibung

`integer/array hostgroup.get(object parameters)`

Mit dieser Methode können Host-Gruppen entsprechend den angegebenen Parametern abgerufen werden.

::: noteclassic
Diese Methode ist für Benutzer aller Typen verfügbar.
Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden.
Weitere Informationen finden Sie unter [User roles](/manual/web_interface/frontend_sections/users/user_roles).
:::

[comment]: # ({/20294517-08ff22f2})

[comment]: # ({5291ff51-7f042696})
### Parameter

`(object)` Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

|Parameter|[Type](/manual/api/reference_commentary#data-types)|Beschreibung|
|--|--|------|
|graphids|ID/array|Gibt nur Host-Gruppen zurück, die Hosts mit den angegebenen Graphen enthalten.|
|groupids|ID/array|Gibt nur Host-Gruppen mit den angegebenen Host-Gruppen-IDs zurück.|
|hostids|ID/array|Gibt nur Host-Gruppen zurück, die die angegebenen Hosts enthalten.|
|maintenanceids|ID/array|Gibt nur Host-Gruppen zurück, die von den angegebenen Wartungen betroffen sind.|
|triggerids|ID/array|Gibt nur Host-Gruppen zurück, die Hosts mit den angegebenen Auslösern enthalten.|
|with\_graphs|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Graphen enthalten.|
|with\_graph\_prototypes|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Graph-Prototypen enthalten.|
|with\_hosts|boolean|Gibt nur Host-Gruppen zurück, die Hosts enthalten.|
|with\_httptests|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Web-Prüfungen enthalten.<br><br>Überschreibt den Parameter `with_monitored_httptests`.|
|with\_items|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Datenpunkten enthalten.<br><br>Überschreibt die Parameter `with_monitored_items` und `with_simple_graph_items`.|
|with\_item\_prototypes|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Datenpunkt-Prototypen enthalten.<br><br>Überschreibt den Parameter `with_simple_graph_item_prototypes`.|
|with\_simple\_graph\_item\_prototypes|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Datenpunkt-Prototypen enthalten, die für die Erstellung aktiviert sind und einen numerischen Informationstyp haben.|
|with\_monitored\_httptests|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit aktivierten Web-Prüfungen enthalten.|
|with\_monitored\_hosts|boolean|Gibt nur Host-Gruppen zurück, die überwachte Hosts enthalten.|
|with\_monitored\_items|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit aktivierten Datenpunkten enthalten.<br><br>Überschreibt den Parameter `with_simple_graph_items`.|
|with\_monitored\_triggers|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit aktivierten Auslösern enthalten. Alle im Auslöser verwendeten Datenpunkte müssen ebenfalls aktiviert sein.|
|with\_simple\_graph\_items|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit numerischen Datenpunkten enthalten.|
|with\_triggers|boolean|Gibt nur Host-Gruppen zurück, die Hosts mit Auslösern enthalten.<br><br>Überschreibt den Parameter `with_monitored_triggers`.|
|selectDiscoveryRules|query|Gibt eine Eigenschaft [`discoveryRules`](/manual/api/reference/discoveryrule/object) mit den LLD-Regeln zurück, die die Host-Gruppe erkannt haben.|
|selectDiscoveryData|query|Gibt eine Eigenschaft `discoveryData` mit den Host-Gruppen-Erkennungsobjekten zurück.<br><br>Jedes Host-Gruppen-Erkennungsobjekt ist ein mit der erkannten Host-Gruppe verknüpfter Host-Gruppen-Prototyp und hat die folgenden Eigenschaften:<br>`parent_group_prototypeid` - `(ID)` ID des Host-Gruppen-Prototyps, aus dem die Host-Gruppe erkannt wurde;<br>`name` - `(string)` Name des Host-Gruppen-Prototyps;<br>`ts_delete` - `(timestamp)` Zeitpunkt, zu dem die nicht mehr erkannte Host-Gruppe gelöscht wird;<br>`status` - `(int)` Status der Host-Gruppen-Erkennung:<br>0 - *(Standard)* Host-Gruppe ist erkannt,<br>1 - Host-Gruppe wird nicht mehr erkannt.|
|selectHostPrototypes|query|Gibt eine Eigenschaft [`hostPrototypes`](/manual/api/reference/hostprototypes/object) mit Host-Prototypen zurück, die diese Host-Gruppe erkannt haben.|
|selectHosts|query|Gibt eine Eigenschaft [`hosts`](/manual/api/reference/host/object) mit den Hosts zurück, die zur Host-Gruppe gehören.<br><br>Unterstützt `count`.|
|limitSelects|integer|Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.<br><br>Gilt für die folgenden Unterabfragen:<br>`selectHosts` - Ergebnisse werden nach `host` sortiert.|
|sortfield|string/array|Sortiert das Ergebnis nach den angegebenen Eigenschaften.<br><br>Mögliche Werte: `groupid`, `name`.|
|countOutput|boolean|Diese Parameter sind in der [Referenzkommentierung](/manual/api/reference_commentary#common-get-method-parameters) beschrieben.|
|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|Gibt eine Eigenschaft `groupDiscoveries` mit den Host-Gruppen-Erkennungsobjekten zurück.<br><br>Jedes Host-Gruppen-Erkennungsobjekt ist ein mit der erkannten Host-Gruppe verknüpfter Host-Gruppen-Prototyp.<br><br>Diese Abfrage ist **veraltet**, bitte verwenden Sie stattdessen `selectDiscoveryData`.|

[comment]: # ({/5291ff51-7f042696})

[comment]: # ({07ca11ca-7223bab1})
### Rückgabewerte

`(integer/array)` Gibt entweder Folgendes zurück:

-   ein Array von Objekten
-   die Anzahl der abgerufenen Objekte, wenn der Parameter `countOutput` verwendet wurde

[comment]: # ({/07ca11ca-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Beispiele

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({6271b06c-8ed2756a})
#### Daten per Namen abrufen

Rufen Sie alle Daten zu zwei Host-Gruppen mit den Namen „Zabbix servers“ und „Linux servers“ ab.

[Anfrage](/manual/api#performing-requests):

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

Antwort:

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

[comment]: # ({/6271b06c-8ed2756a})

[comment]: # ({6a994b89-e5f0abe1})
### Siehe auch

-   [Host](/manual/api/reference/host/object#host)

[comment]: # ({/6a994b89-e5f0abe1})

[comment]: # ({1e72ea39-1e72ea39})
### Quelle

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

[comment]: # ({/1e72ea39-1e72ea39})
