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 Type 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.

Überschreibt den Parameter with_monitored_httptests.
with_items boolean Gibt nur Host-Gruppen zurück, die Hosts mit Datenpunkten enthalten.

Ü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.

Ü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.

Ü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.

Überschreibt den Parameter with_monitored_triggers.
selectDiscoveryRules query Gibt eine Eigenschaft discoveryRules 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.

Jedes Host-Gruppen-Erkennungsobjekt ist ein mit der erkannten Host-Gruppe verknüpfter Host-Gruppen-Prototyp und hat die folgenden Eigenschaften:
parent_group_prototypeid - (ID) ID des Host-Gruppen-Prototyps, aus dem die Host-Gruppe erkannt wurde;
name - (string) Name des Host-Gruppen-Prototyps;
ts_delete - (timestamp) Zeitpunkt, zu dem die nicht mehr erkannte Host-Gruppe gelöscht wird;
status - (int) Status der Host-Gruppen-Erkennung:
0 - (Standard) Host-Gruppe ist erkannt,
1 - Host-Gruppe wird nicht mehr erkannt.
selectHostPrototypes query Gibt eine Eigenschaft hostPrototypes mit Host-Prototypen zurück, die diese Host-Gruppe erkannt haben.
selectHosts query Gibt eine Eigenschaft hosts mit den Hosts zurück, die zur Host-Gruppe 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 Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: groupid, name.
countOutput boolean Diese Parameter sind 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
selectGroupDiscoveries query Gibt eine Eigenschaft groupDiscoveries mit den Host-Gruppen-Erkennungsobjekten zurück.

Jedes Host-Gruppen-Erkennungsobjekt ist ein mit der erkannten Host-Gruppe verknüpfter Host-Gruppen-Prototyp.

Diese Abfrage ist veraltet, bitte verwenden Sie stattdessen selectDiscoveryData.

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.