hostgroup.get

Beschreibung

integer/array hostgroup.get(object parameters)

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

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.

Parameter

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

Die Methode unterstützt die folgenden Parameter.

Parameter Typ Beschreibung
graphids ID/array Nur Hostgruppen zurückgeben, die Hosts mit den angegebenen Graphen enthalten.
groupids ID/array Nur Hostgruppen mit den angegebenen Hostgruppen-IDs zurückgeben.
hostids ID/array Nur Hostgruppen zurückgeben, die die angegebenen Hosts enthalten.
maintenanceids ID/array Nur Hostgruppen zurückgeben, die von den angegebenen Wartungen betroffen sind.
triggerids ID/array Nur Hostgruppen zurückgeben, die Hosts mit den angegebenen Auslösern enthalten.
with_graphs boolean Nur Hostgruppen zurückgeben, die Hosts mit Graphen enthalten.
with_graph_prototypes boolean Nur Hostgruppen zurückgeben, die Hosts mit Graphprototypen enthalten.
with_hosts boolean Nur Hostgruppen zurückgeben, die Hosts enthalten.
with_httptests boolean Nur Hostgruppen zurückgeben, die Hosts mit Webprüfungen enthalten.

Überschreibt den Parameter with_monitored_httptests.
with_items boolean Nur Hostgruppen zurückgeben, die Hosts mit Datenpunkten enthalten.

Überschreibt die Parameter with_monitored_items und with_simple_graph_items.
with_item_prototypes boolean Nur Hostgruppen zurückgeben, die Hosts mit Datenpunktprototypen enthalten.

Überschreibt den Parameter with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Nur Hostgruppen zurückgeben, die Hosts mit Datenpunktprototypen enthalten, die für die Erstellung aktiviert sind und einen numerischen Informationstyp haben.
with_monitored_httptests boolean Nur Hostgruppen zurückgeben, die Hosts mit aktivierten Webprüfungen enthalten.
with_monitored_hosts boolean Nur Hostgruppen zurückgeben, die überwachte Hosts enthalten.
with_monitored_items boolean Nur Hostgruppen zurückgeben, die Hosts mit aktivierten Datenpunkten enthalten.

Überschreibt den Parameter with_simple_graph_items.
with_monitored_triggers boolean Nur Hostgruppen zurückgeben, die Hosts mit aktivierten Auslösern enthalten. Alle in dem Auslöser verwendeten Datenpunkte müssen ebenfalls aktiviert sein.
with_simple_graph_items boolean Nur Hostgruppen zurückgeben, die Hosts mit numerischen Datenpunkten enthalten.
with_triggers boolean Nur Hostgruppen zurückgeben, die Hosts mit Auslösern enthalten.

Überschreibt den Parameter with_monitored_triggers.
selectDiscoveryRules query Eine Eigenschaft discoveryRules mit den LLD-Regeln zurückgeben, die die Hostgruppe entdeckt haben.
selectGroupDiscoveries query Eine Eigenschaft groupDiscoveries mit den Hostgruppen-Discovery-Objekten zurückgeben.

Jedes Hostgruppen-Discovery-Objekt ist ein mit der entdeckten Hostgruppe verknüpfter Hostgruppenprototyp und hat die folgenden Eigenschaften:
parent_group_prototypeid - (ID) ID des Hostgruppenprototyps, aus dem die Hostgruppe entdeckt wurde;
name - (string) Name des Hostgruppenprototyps;
lastcheck - (timestamp) Zeitpunkt, zu dem die Hostgruppe zuletzt entdeckt wurde;
ts_delete - (timestamp) Zeitpunkt, zu dem die Hostgruppe gelöscht wird, wenn sie nicht mehr entdeckt wird;
status - (int) Status der Hostgruppen-Discovery:
0 - (Standard) Hostgruppe ist entdeckt,
1 - Hostgruppe wird nicht mehr entdeckt.
selectHostPrototypes query Eine Eigenschaft hostPrototypes mit den Hostprototypen zurückgeben, die diese Hostgruppe entdeckt haben.
selectHosts query Eine Eigenschaft hosts mit den Hosts zurückgeben, die zur Hostgruppe gehören.

Unterstützt count.
limitSelects integer Begrenzt die Anzahl der von Unterabfragen zurückgegebenen Datensätze.

Gilt für die folgenden Unterabfragen:
selectHosts - Ergebnisse werden nach host sortiert.
sortfield string/array Das Ergebnis nach den angegebenen Eigenschaften sortieren.

Mögliche Werte: groupid, name.
countOutput boolean Diese Parameter werden in der Referenzkommentierung beschrieben.
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 Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen with_monitored_hosts.
Nur Hostgruppen zurückgeben, die überwachte Hosts enthalten.
real_hosts
(deprecated)		 flag Dieser Parameter ist veraltet, bitte verwenden Sie stattdessen with_hosts.
Nur Hostgruppen zurückgeben, die Hosts enthalten.

Rückgabewerte

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

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

Beispiele

Daten per Namen abrufen

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

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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