hostgroup.get

Opis

integer/array hostgroup.get(object parameters)

Metoda umożliwia pobranie grup hostów zgodnie z podanymi parametrami.

Metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywołania metody można wyłączyć w ustawieniach ról użytkowników. Zobacz Role użytkowników po więcej informacji.

Parametry

(object) Parametry określające pożądany wynik.

Metoda obsługuje następujące parametry.

Parametr	Typ	Opis
graphids	string/array	Zwróć tylko grupy hostów zawierające hosty lub szablony z danymi wykresami.
groupids	string/array	Zwróć tylko grupy hostów o określonych identyfikatorach grup hostów.
hostids	string/array	Zwróć tylko grupy hostów zawierające określone hosty.
maintenanceids	string/array	Zwróć tylko grupy hostów, które są objęte określonymi utrzymaniem.
monitored_hosts	flag	Zwróć tylko grupy hostów zawierające monitorowane hosty.
real_hosts	flag	Zwróć tylko grupy hostów zawierające hosty.
templated_hosts	flag	Zwróć tylko grupy hostów zawierające szablony.
templateids	string/array	Zwróć tylko grupy hostów zawierające określone szablony.
triggerids	string/array	Zwróć tylko grupy hostów zawierające hosty lub szablony z określonymi wyzwalaczami.
with_graphs	flag	Zwróć tylko grupy hostów zawierające hosty z wykresami.
with_graph_prototypes	flag	Zwróć tylko grupy hostów zawierające hosty z prototypami wykresów.
with_hosts_and_templates	flag	Zwróć tylko grupy hostów zawierające hosty lub szablony.
with_httptests	flag	Zwróć tylko grupy hostów zawierające hosty z testami sieci WWW. Nadpisuje parametr `with_monitored_httptests`.
with_items	flag	Zwróć tylko grupy hostów zawierające hosty lub szablony z pozycjami. Nadpisuje parametry `with_monitored_items` i `with_simple_graph_items`.
with_item_prototypes	flag	Zwróć tylko grupy hostów zawierające hosty z prototypami pozycji. Nadpisuje parametr `with_simple_graph_item_prototypes`.
with_simple_graph_item_prototypes	flag	Zwróć 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	flag	Zwróć tylko grupy hostów zawierające hosty z włączonymi testami sieci WWW.
with_monitored_items	flag	Zwróć tylko grupy hostów zawierające hosty lub szablony z włączonymi pozycjami. Nadpisuje parametr `with_simple_graph_items`.
with_monitored_triggers	flag	Zwróć tylko grupy hostów zawierające hosty z włączonymi wyzwalaczami. Wszystkie elementy używane w wyzwalaczu muszą również być włączone.
with_simple_graph_items	flag	Zwróć tylko grupy hostów zawierające hosty z pozycjami typu liczba.
with_triggers	flag	Zwróć tylko grupy hostów zawierające hosty z wyzwalaczami. Nadpisuje parametr `with_monitored_triggers`.
selectDiscoveryRule	query	Zwróć właściwość discoveryRule z regułą LLD, która utworzyła grupę hostów.
selectGroupDiscovery	query	Zwróć właściwość `groupDiscovery` z obiektem wykrywania grupy hostów. Obiekt wykrywania grupy hostów łączy wykrytą grupę hostów z prototypem grupy hostów i ma następujące właściwości: `groupid` - `(string)` ID odkrytej grupy hostów; `lastcheck` - `(timestamp)` czas ostatniego odkrycia grupy hostów; `name` - `(string)` nazwa prototypu grupy hostów; `parent_group_prototypeid` - `(string)` ID prototypu grupy hostów, z którego została utworzona grupa hostów; `ts_delete` - `(timestamp)` czas, kiedy grupa hostów, która nie jest już wykrywana, zostanie usunięta.
selectHosts	query	Zwróć właściwość hosts z hostami należącymi do grupy hostów. Obsługuje `count`.
selectTemplates	query	Zwróć właściwość templates z szablonami 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`; `selectTemplates` - wyniki będą sortowane według `host`.
sortfield	string/array	Sortuj wynik według podanych właściwości. Możliwe wartości to: `groupid`, `name`.
countOutput	boolean	Te parametry, będące wspólne dla wszystkich metod `get`, są opisane szczegółowo na stronie komentarza referencyjnego.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Zwracane wartości

(integer/array) Zwraca jedną z opcji:

tablicę obiektów;
liczbę pobranych obiektów, jeśli parametr countOutput został wykorzystany.

Przykłady

Pobieranie danych po nazwie

Pobierz wszystkie dane dotyczące dwóch grup hostów o nazwach "Zabbix servers" i "Linux servers".

Zapytanie:

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

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "groupid": "2",
                   "name": "Linux servers",
                   "internal": "0"
               },
               {
                   "groupid": "4",
                   "name": "Zabbix servers",
                   "internal": "0"
               }
           ],
           "id": 1
       }

Zobacz także

Host
Szablon

Źródło

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

Documentation