hostgroup.get

Opis

integer/array hostgroup.get(object parameters)

Ta metoda umożliwia pobieranie grup hostów zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
graphids ID/array Zwraca tylko grupy hostów zawierające hosty z podanymi wykresami.
groupids ID/array Zwraca tylko grupy hostów o podanych identyfikatorach grup hostów.
hostids ID/array Zwraca tylko grupy hostów zawierające podane hosty.
maintenanceids ID/array Zwraca tylko grupy hostów, na które wpływają podane okresy konserwacji.
triggerids ID/array Zwraca tylko grupy hostów zawierające hosty z podanymi wyzwalaczami.
with_graphs boolean Zwraca tylko grupy hostów zawierające hosty z wykresami.
with_graph_prototypes boolean Zwraca tylko grupy hostów zawierające hosty z prototypami wykresów.
with_hosts boolean Zwraca tylko grupy hostów zawierające hosty.
with_httptests boolean Zwraca tylko grupy hostów zawierające hosty z testami WWW.

Nadpisuje parametr with_monitored_httptests.
with_items boolean Zwraca tylko grupy hostów zawierające hosty z pozycjami.

Nadpisuje parametry with_monitored_items i with_simple_graph_items.
with_item_prototypes boolean Zwraca tylko grupy hostów zawierające hosty z prototypami pozycji.

Nadpisuje parametr with_simple_graph_item_prototypes.
with_simple_graph_item_prototypes boolean Zwraca tylko grupy hostów zawierające hosty z prototypami pozycji, które są włączone do tworzenia i mają numeryczny typ informacji.
with_monitored_httptests boolean Zwraca tylko grupy hostów zawierające hosty z włączonymi testami WWW.
with_monitored_hosts boolean Zwraca tylko grupy hostów zawierające monitorowane hosty.
with_monitored_items boolean Zwraca tylko grupy hostów zawierające hosty z włączonymi pozycjami.

Nadpisuje parametr with_simple_graph_items.
with_monitored_triggers boolean Zwraca tylko grupy hostów zawierające hosty z włączonymi wyzwalaczami. Wszystkie pozycje używane w wyzwalaczu również muszą być włączone.
with_simple_graph_items boolean Zwraca tylko grupy hostów zawierające hosty z numerycznymi pozycjami.
with_triggers boolean Zwraca tylko grupy hostów zawierające hosty z wyzwalaczami.

Nadpisuje parametr with_monitored_triggers.
selectDiscoveryRules query Zwraca właściwość discoveryRules z regułami LLD, które wykryły grupę hostów.
selectDiscoveryData query Zwraca właściwość discoveryData z obiektami wykrywania grup hostów.

Każdy obiekt wykrywania grupy hostów jest prototypem grupy hostów powiązanym z wykrytą grupą hostów i ma następujące właściwości:
parent_group_prototypeid - (ID) identyfikator prototypu grupy hostów, z którego wykryto grupę hostów;
name - (string) nazwa prototypu grupy hostów;
ts_delete - (timestamp) czas, po którym grupa hostów, która nie jest już wykrywana, zostanie usunięta;
status - (int) status wykrywania grupy hostów:
0 - (domyślnie) grupa hostów jest wykryta,
1 - grupa hostów nie jest już wykrywana.
selectHostPrototypes query Zwraca właściwość hostPrototypes z prototypami hostów, które wykryły tę grupę hostów.
selectHosts query Zwraca właściwość hosts z hostami należącymi do grupy hostów.

Obsługuje count.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań:
selectHosts - wyniki będą sortowane według host.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: groupid, name.
countOutput boolean Te parametry opisano w komentarzu referencyjnym.
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 Zwraca właściwość groupDiscoveries z obiektami wykrywania grup hostów.

Każdy obiekt wykrywania grupy hostów jest prototypem grupy hostów powiązanym z wykrytą grupą hostów.

To zapytanie jest przestarzałe; zamiast niego użyj selectDiscoveryData.

Zwracane wartości

(integer/array) Zwraca:

  • tablicę obiektów
  • liczbę pobranych obiektów, jeśli użyto parametru countOutput

Przykłady

Pobieranie danych według nazwy

Pobierz wszystkie dane o dwóch grupach hostów o nazwach „Zabbix servers” i „Linux servers”.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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