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 zur Definition der gewünschten Ausgabe.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
graphids ID/array Gibt nur Hostgruppen zurück, die Hosts mit den angegebenen Graphen enthalten.
groupids ID/array Gibt nur Hostgruppen mit den angegebenen Hostgruppen-IDs zurück.
hostids ID/array Gibt nur Hostgruppen zurück, die die angegebenen Hosts enthalten.
maintenanceids ID/array Gibt nur Hostgruppen zurück, die von den angegebenen Wartungen betroffen sind.
triggerids ID/array Gibt nur Hostgruppen zurück, die Hosts mit den angegebenen Auslösern enthalten.
with_graphs boolean Gibt nur Hostgruppen zurück, die Hosts mit Graphen enthalten.
with_graph_prototypes boolean Gibt nur Hostgruppen zurück, die Hosts mit Graph-Prototypen enthalten.
with_hosts boolean Gibt nur Hostgruppen zurück, die Hosts enthalten.
with_httptests boolean Gibt nur Hostgruppen zurück, die Hosts mit Webprüfungen enthalten.

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

Überschreibt die Parameter with_monitored_items und with_simple_graph_items.
with_item_prototypes boolean Gibt nur Hostgruppen zurück, die Hosts mit Datenpunkt-Prototypen enthalten.

Überschreibt den Parameter with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Gibt nur Hostgruppen 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 Hostgruppen zurück, die Hosts mit aktivierten Webprüfungen enthalten.
with_monitored_hosts boolean Gibt nur Hostgruppen zurück, die überwachte Hosts enthalten.
with_monitored_items boolean Gibt nur Hostgruppen zurück, die Hosts mit aktivierten Datenpunkten enthalten.

Überschreibt den Parameter with_simple_graph_items.
with_monitored_triggers boolean Gibt nur Hostgruppen 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 Hostgruppen zurück, die Hosts mit numerischen Datenpunkten enthalten.
with_triggers boolean Gibt nur Hostgruppen 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, durch die die Hostgruppe ermittelt wurde.
selectGroupDiscoveries query Gibt eine Eigenschaft groupDiscoveries mit den Hostgruppen-Ermittlungsobjekten zurück.

Jedes Hostgruppen-Ermittlungsobjekt ist ein Hostgruppen-Prototyp, der mit der ermittelten Hostgruppe verknüpft ist, und verfügt über die folgenden Eigenschaften:
parent_group_prototypeid - (ID) ID des Hostgruppen-Prototyps, aus dem die Hostgruppe ermittelt wurde;
name - (string) Name des Hostgruppen-Prototyps;
lastcheck - (timestamp) Zeitpunkt, zu dem die Hostgruppe zuletzt ermittelt wurde;
ts_delete - (timestamp) Zeitpunkt, zu dem die nicht mehr ermittelte Hostgruppe gelöscht wird;
status - (int) Status der Hostgruppen-Ermittlung:
0 - (Standard) Hostgruppe wurde ermittelt,
1 - Hostgruppe wird nicht mehr ermittelt.
selectHostPrototypes query Gibt eine Eigenschaft hostPrototypes mit den Host-Prototypen zurück, durch die diese Hostgruppe ermittelt wurde.
selectHosts query Gibt eine Eigenschaft hosts mit den Hosts zurück, 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 Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: groupid, name.
countOutput boolean Diese Parameter werden im Referenzkommentar 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. Verwenden Sie stattdessen with_monitored_hosts.
Gibt nur Hostgruppen zurück, die überwachte Hosts enthalten.
real_hosts
(deprecated)		 flag Dieser Parameter ist veraltet. Verwenden Sie stattdessen with_hosts.
Gibt nur Hostgruppen zurück, 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.