On this page
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 wyjście.
Metoda obsługuje następujące parametry.
| Parameter | Type | Description |
|---|---|---|
| graphids | ID/array | Zwracaj tylko grupy hostów, które zawierają hosty z podanymi wykresami. |
| groupids | ID/array | Zwracaj tylko grupy hostów z podanymi identyfikatorami grup hostów. |
| hostids | ID/array | Zwracaj tylko grupy hostów, które zawierają podane hosty. |
| maintenanceids | ID/array | Zwracaj tylko grupy hostów, na które wpływają podane okresy konserwacji. |
| triggerids | ID/array | Zwracaj tylko grupy hostów, które zawierają hosty z podanymi wyzwalaczami. |
| with_graphs | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z wykresami. |
| with_graph_prototypes | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z prototypami wykresów. |
| with_hosts | boolean | Zwracaj tylko grupy hostów, które zawierają hosty. |
| with_httptests | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z testami WWW. Ma pierwszeństwo przed parametrem with_monitored_httptests. |
| with_items | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z pozycjami. Ma pierwszeństwo przed parametrami with_monitored_items i with_simple_graph_items. |
| with_item_prototypes | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z prototypami pozycji. Ma pierwszeństwo przed parametrem with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z prototypami pozycji, które są włączone do tworzenia i mają numeryczny typ informacji. |
| with_monitored_httptests | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z włączonymi testami WWW. |
| with_monitored_hosts | boolean | Zwracaj tylko grupy hostów, które zawierają monitorowane hosty. |
| with_monitored_items | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z włączonymi pozycjami. Ma pierwszeństwo przed parametrem with_simple_graph_items. |
| with_monitored_triggers | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z włączonymi wyzwalaczami. Wszystkie pozycje używane w wyzwalaczu muszą być również włączone. |
| with_simple_graph_items | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z numerycznymi pozycjami. |
| with_triggers | boolean | Zwracaj tylko grupy hostów, które zawierają hosty z wyzwalaczami. Ma pierwszeństwo przed parametrem with_monitored_triggers. |
| selectDiscoveryRules | query | Zwraca właściwość discoveryRules z regułami LLD, które wykryły grupę hostów. |
| 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 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;lastcheck - (timestamp) czas, kiedy grupa hostów została ostatnio wykryta;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 została 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 są opisane 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 | |
| monitored_hosts (deprecated) |
flag | Ten parametr jest przestarzały, użyj zamiast niego with_monitored_hosts.Zwracaj tylko grupy hostów, które zawierają monitorowane hosty. |
| real_hosts (deprecated) |
flag | Ten parametr jest przestarzały, użyj zamiast niego with_hosts.Zwracaj tylko grupy hostów, które zawierają hosty. |
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”.
{
"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.