Documentation
Table of Contents
- host.get
- Opis
- Parametry
- Zwracane warto?ci
- Przyk?ady
- Pobieranie danych wed?ug nazwy
- Pobieranie grup host¨®w
- Pobieranie powi?zanych szablon¨®w
- Pobieranie host¨®w wed?ug szablonu
- Wyszukiwanie wed?ug danych inwentarza hosta
- Wyszukiwanie wed?ug tag¨®w hosta
- Wyszukiwanie hosta z znacznikami oraz tagami szablon¨®w
- Wyszukiwanie host¨®w wed?ug powagi problemu
- Zobacz tak?e
- ?°ù¨®»å?´Ç
host.get
Opis
integer/array host.get(object parameters)
Metoda umo?liwia pobranie host¨®w zgodnie z podanymi parametrami.
Ta metoda jest dost?pna dla u?ytkownik¨®w dowolnego typu. Uprawnienia do wywo?ywania metody mog? zosta? cofni?te w ustawieniach r¨®l u?ytkownika. Zobacz Role u?ytkownika aby uzyska? wi?cej informacji.
Parametry
(object) Parametry definiuj?ce po??dany wynik.
Metoda obs?uguje nast?puj?ce parametry.
| Parametr | Typ | Opis |
|---|---|---|
| groupids | string/array | Zwr¨®? tylko hosty, kt¨®re nale?? do okre?lonych grup. |
| dserviceids | string/array | Zwr¨®? tylko hosty, kt¨®re s? powi?zane z danymi wykrytymi us?ugami. |
| graphids | string/array | Zwr¨®? tylko hosty, kt¨®re maj? podane wykresy. |
| hostids | string/array | Zwr¨®? tylko hosty o podanych identyfikatorach host¨®w. |
| httptestids | string/array | Zwr¨®? tylko hosty, kt¨®re maj? podane testy sieci www. |
| interfaceids | string/array | Zwr¨®? tylko hosty, kt¨®re korzystaj? z podanych interfejs¨®w. |
| itemids | string/array | Zwr¨®? tylko hosty, kt¨®re maj? podane pozycje. |
| maintenanceids | string/array | Zwr¨®? tylko hosty, kt¨®re s? obj?te podanymi okresami utrzymania. |
| monitored_hosts | flag | Zwr¨®? tylko monitorowane hosty. |
| proxy_hosts | flag | Zwr¨®? tylko proxy. |
| proxyids | string/array | Zwr¨®? tylko hosty monitorowane przez podane serwery proxy. |
| templated_hosts | flag | Zwr¨®? zar¨®wno hosty, jak i szablony. |
| templateids | string/array | Zwr¨®? tylko hosty, kt¨®re s? powi?zane z podanymi szablonami. |
| triggerids | string/array | Zwr¨®? tylko hosty, kt¨®re maj? podane wyzwalacze. |
| with_items | flag | Zwr¨®? tylko hosty, kt¨®re posiadaj? pozycj?. Nadpisuje parametry with_monitored_items i with_simple_graph_items. |
| with_item_prototypes | flag | Zwr¨®? tylko hosty, kt¨®re maj? prototypy pozycje. Nadpisuje parametr with_simple_graph_item_prototypes. |
| with_simple_graph_item_prototypes | flag | Zwr¨®? tylko hosty, kt¨®re posiadaj? prototypy pozycji, kt¨®re s? w??czone podczas tworzenia i maj? typ informacji typu liczba. |
| with_graphs | flag | Zwr¨®? tylko hosty, kt¨®re posiadaj? wykresy. |
| with_graph_prototypes | flag | Zwr¨®? tylko hosty, kt¨®re posiadaj? prototypy wykres¨®w. |
| with_httptests | flag | Zwr¨®? tylko hosty, kt¨®re posiadaj? testy sieci www. Nadpisuje parametr with_monitored_httptests. |
| with_monitored_httptests | flag | Zwr¨®? tylko hosty, kt¨®re maj? w??czone testy sieci www. |
| with_monitored_items | flag | Zwr¨®? tylko hosty, kt¨®re maj? w??czone pozycje. Zast?puje parametr with_simple_graph_items. |
| with_monitored_triggers | flag | Zwr¨®? tylko hosty, kt¨®re maj? w??czone wyzwalacze. Wszystkie pozycje u?yte w wyzwalaczu musz? r¨®wnie? by? w??czone. |
| with_simple_graph_items | flag | Zwr¨®? tylko hosty, kt¨®re maj? pozycje z typem informacji typu liczba. |
| with_triggers | flag | Zwr¨®? tylko hosty, kt¨®re maj? wyzwalacze. Nadpisuje parametr with_monitored_triggers. |
| withProblemsSuppressed | boolean | Zwr¨®? hosty, kt¨®re maj? wstrzymane problemy. Mo?liwe warto?ci: null - (domy?lnie) wszystkie hosty;true - tylko hosty z wstrzymanymi problemami;false - tylko hosty z niewstrzymanymi problemami. |
| evaltype | integer | Regu?y wyszukiwania znacznik¨®w. Mo?liwe warto?ci: 0 - (domy?lnie) And/Or; 2 - Or. |
| severities | integer/array | Zwr¨®? hosty, kt¨®re maj? tylko problemy o podanych poziomach. Dotyczy tylko sytuacji, gdy obiekt problemu to wyzwalacz. |
| tags | object/array | Zwr¨®? tylko hosty z podanymi znacznikami. Dok?adne dopasowanie wed?ug tagu oraz wyszukiwanie z uwzgl?dnieniem wielko?ci liter lub bez, w zale?no?ci od warto?ci operatora. Format: [{"tag": "<tag>", "value": "<value>", "operator": "<operator>"}, ...].Pusta tablica zwraca wszystkie hosty. Mo?liwe warto?ci operatora: 0 - (domy?lnie) Zawiera; 1 - Jest R¨®wny; 2 - Nie zawiera; 3 - Nie jest r¨®wny 4 - Istnieje; 5 - Nie istnieje. |
| inheritedTags | boolean | Zwr¨®? hosty, kt¨®re maj? podane znaczniki tak?e we wszystkich powi?zanych szablonach. Domy?lnie:Mo?liwe warto?ci: true - powi?zane szablony musz? r¨®wnie? mie? podane znaczniki;false - (domy?lnie) tagi szablon¨®w s? ignorowane. |
| selectDiscoveries | query | Zwr¨®? w?a?ciwo?? discoveries z regu?ami wykrywania niskopoziomowego host¨®w. Obs?uguje count. |
| selectDiscoveryRule | query | Zwr¨®? w?a?ciwo?? discoveryRule z regu?ami wykrywania niskopoziomowego, kt¨®ra utworzy?a hosta (z prototypu hosta w monitorowaniu VMware). |
| selectGraphs | query | Zwr¨®? w?a?ciwo?? graphs z wykresami host¨®w. Obs?uguje count. |
| selectGroups | query | Zwr¨®? w?a?ciwo?? groups z danymi grup host¨®w, do kt¨®rych nale?y host. |
| selectHostDiscovery | query | Zwr¨®? w?a?ciwo?? hostDiscovery z danymi obiektu wykrywania hosta.Obiekt wykrywania hosta ??czy wykryty host z prototypem hosta lub prototypami host¨®w z regu?? LLD i ma nast?puj?ce w?a?ciwo?ci: host - (string) host prototypu hosta;hostid - (string) ID wykrytego hosta lub prototypu hosta;parent_hostid - (string) ID prototypu hosta, z kt¨®rego zosta? utworzony host;parent_itemid - (string) ID regu?y LLD, kt¨®ra utworzy?a odkryty host;lastcheck - (timestamp) czas ostatniego odkrycia hosta;ts_delete - (timestamp) czas, kiedy host, kt¨®ry nie jest ju? odkrywany, zostanie usuni?ty. |
| selectHttpTests | query | Zwr¨®? w?a?ciwo?? httpTests z scenariuszami sieci www hosta. Obs?uguje count. |
| selectInterfaces | query | Zwr¨®? w?a?ciwo?? interfaces z interfejsami hosta. Obs?uguje count. |
| selectInventory | query | Zwr¨®? w?a?ciwo?? inventory z danymi inwentarza hosta. |
| selectItems | query | Zwr¨®? w?a?ciwo?? items z pozycjami hosta. Obs?uguje count. |
| selectMacros | query | Zwr¨®? w?a?ciwo?? macros z makrami hosta. |
| selectParentTemplates | query | Zwr¨®? w?a?ciwo?? parentTemplates z szablonami, do kt¨®rych jest pod??czony host. Obs?uguje count. |
| selectDashboards | query | Zwr¨®? w?a?ciwo?? dashboards. Obs?uguje count. |
| selectTags | query | Zwr¨®? w?a?ciwo?? tags z znacznikami hosta. |
| selectInheritedTags | query | Zwr¨®? w?a?ciwo?? inheritedTags z znacznikami, kt¨®re s? we wszystkich szablonach powi?zanych z hostem. |
| selectTriggers | query | Zwr¨®? w?a?ciwo?? triggers z wyzwalaczami hosta. Obs?uguje count. |
| selectValueMaps | query | Zwr¨®? w?a?ciwo?? valuemaps z mapami warto?ci hosta. |
| filter | object | Zwr¨®? tylko te wyniki, kt¨®re dok?adnie pasuj? do podanego filtra. Akceptuje tablic?, gdzie klucze to nazwy w?a?ciwo?ci, a warto?ci to pojedyncza warto?? lub tablica warto?ci do por¨®wnania. Pozwala na filtrowanie wed?ug w?a?ciwo?ci interfejsu. Nie dzia?a dla p¨®l text. |
| limitSelects | integer | Ogranicza liczb? zwracanych rekord¨®w poprzez podzapytania. Dotyczy nast?puj?cych podzapyta¨½: selectParentTemplates - wyniki b?d? posortowane wed?ug host;selectInterfaces;selectItems - posortowane wed?ug name;selectDiscoveries - posortowane wed?ug name;selectTriggers - posortowane wed?ug description;selectGraphs - posortowane wed?ug name;selectDashboards - posortowane wed?ug name. |
| search | object | Zwr¨®? wyniki, kt¨®re pasuj? do podanego wzorca (bez uwzgl?dniania wielko?ci liter). Akceptuje tablic?, gdzie klucze to nazwy w?a?ciwo?ci, a warto?ci to ci?gi znak¨®w do wyszukania. Je?li nie podano dodatkowych opcji, to zostanie wykonane wyszukiwanie LIKE "%¡%".Pozwala na wyszukiwanie wed?ug w?a?ciwo?ci interfejsu. Dzia?a tylko dla p¨®l typu znak i tekst. |
| searchInventory | object | Zwr¨®? tylko hosty, kt¨®re maj? dane inwentarza pasuj?ce do podanego wyszukiwania za pomoc? symboli wildcard. Parametr ten wp?ywa na te same dodatkowe parametry co search. |
| sortfield | string/array | Sortuj wynik wed?ug podanych w?a?ciwo?ci. Mo?liwe warto?ci to: hostid, host, name, status. |
| countOutput | boolean | Te parametry wsp¨®lne dla wszystkich metod get s? szczeg¨®?owo opisane w komentarzu referencyjnym. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| 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
countOutputzosta? wykorzystany.
Przyk?ady
Pobieranie danych wed?ug nazwy
Pobierz wszystkie dane o dw¨®ch hostach o nazwach "Áú»¢¶Ä²© server" i "Linux server".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"filter": {
"host": [
"Áú»¢¶Ä²© server",
"Linux server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10160",
"proxy_hostid": "0",
"host": "Áú»¢¶Ä²© server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Áú»¢¶Ä²© server",
"flags": "0",
"description": "The Áú»¢¶Ä²© monitoring server.",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1"
},
{
"hostid": "10167",
"proxy_hostid": "0",
"host": "Linux server",
"status": "0",
"lastaccess": "0",
"ipmi_authtype": "-1",
"ipmi_privilege": "2",
"ipmi_username": "",
"ipmi_password": "",
"maintenanceid": "0",
"maintenance_status": "0",
"maintenance_type": "0",
"maintenance_from": "0",
"name": "Linux server",
"flags": "0",
"description": "",
"tls_connect": "1",
"tls_accept": "1",
"tls_issuer": "",
"tls_subject": "",
"inventory_mode": "1"
}
],
"id": 1
}Pobieranie grup host¨®w
Pobierz nazwy grup, do kt¨®rych nale?y host "Áú»¢¶Ä²© server", bez szczeg¨®?owych informacji o samym ho?cie.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectGroups": "extend",
"filter": {
"host": [
"Áú»¢¶Ä²© server"
]
}
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 2
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"groups": [
{
"groupid": "2",
"name": "Linux servers",
"internal": "0",
"flags": "0"
},
{
"groupid": "4",
"name": "Áú»¢¶Ä²© servers",
"internal": "0",
"flags": "0"
}
]
}
],
"id": 2
}Pobieranie powi?zanych szablon¨®w
Pobierz identyfikatory i nazwy szablon¨®w powi?zanych z hostem "10084".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectParentTemplates": [
"templateid",
"name"
],
"hostids": "10084"
},
"id": 1,
"auth": "70785d2b494a7302309b48afcdb3a401"
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"parentTemplates": [
{
"name": "Linux",
"templateid": "10001"
},
{
"name": "Áú»¢¶Ä²© Server",
"templateid": "10047"
}
]
}
],
"id": 1
}Pobieranie host¨®w wed?ug szablonu
Pobierz hosty, kt¨®re s? powi?zane z szablonem "10001" (Linux by Áú»¢¶Ä²© agent).
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid", "name"],
"templateids": "10001"
},
"auth": "70785d2b494a7302309b48afcdb3a401",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"templateid": "10001",
"hosts": [
{
"hostid": "10084",
"name": "Áú»¢¶Ä²© server"
},
{
"hostid": "10603",
"name": "Host 1"
},
{
"hostid": "10604",
"name": "Host 2"
}
]
}
],
"id": 1
}Wyszukiwanie wed?ug danych inwentarza hosta
Pobierz hosty zawieraj?ce "Linux" w polu "OS" inwentarza hosta.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": [
"host"
],
"selectInventory": [
"os"
],
"searchInventory": {
"os": "Linux"
}
},
"id": 2,
"auth": "7f9e00124c75e8f25facd5c093f3e9a0"
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10084",
"host": "Áú»¢¶Ä²© server",
"inventory": {
"os": "Linux Ubuntu"
}
},
{
"hostid": "10107",
"host": "Linux server",
"inventory": {
"os": "Linux Mint"
}
}
],
"id": 1
}Wyszukiwanie wed?ug tag¨®w hosta
Pobierz hosty, kt¨®re maj? znacznik "Host name" r¨®wny "Linux server".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["hostid"],
"selectTags": "extend",
"evaltype": 0,
"tags": [
{
"tag": "Host name",
"value": "Linux server",
"operator": 1
}
]
},
"auth": "7f9e00124c75e8f25facd5c093f3e9a0",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10085",
"tags": [
{
"tag": "Host name",
"value": "Linux server"
},
{
"tag": "OS",
"value": "RHEL 7"
}
]
}
],
"id": 1
}Pobierz hosty, kt¨®re posiadaj? te tagi nie tylko na poziomie hosta, ale tak?e w ich powi?zanych szablonach nadrz?dnych.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"tags": [{"tag": "A", "value": "1", "operator": "0"}],
"inheritedTags": true
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10623",
"name": "PC room 1"
},
{
"hostid": "10601",
"name": "Office"
}
],
"id": 1
}Wyszukiwanie hosta z znacznikami oraz tagami szablon¨®w
Pobierz hosta z tagami oraz wszystkimi znacznikami, kt¨®re s? powi?zane ze szablonami nadrz?dnymi.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"hostids": 10502,
"selectTags": ["tag", "value"],
"selectInheritedTags": ["tag", "value"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10502",
"name": "Desktop",
"tags": [
{
"tag": "A",
"value": "1"
}
],
"inheritedTags": [
{
"tag": "B",
"value": "2"
}
]
}
],
"id": 1
}Wyszukiwanie host¨®w wed?ug powagi problemu
Pobierz hosty, kt¨®re maj? problemy na poziomie "Disaster".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": 5
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
Pobierz hosty, kt¨®re maj? problemy na poziomie "?redni" oraz "Wysoki".
Zapytanie:
{
"jsonrpc": "2.0",
"method": "host.get",
"params": {
"output": ["name"],
"severities": [3, 4]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "20170",
"name": "Database"
},
{
"hostid": "20183",
"name": "workstation"
}
],
"id": 1
}Zobacz tak?e
?°ù¨®»å?´Ç
CHost::get() w ui/include/classes/api/services/CHost.php.