Documentation
Table of Contents
discoveryrule.get
Opis
integer/array discoveryrule.get(object parameters)
Metoda pozwala na pobieranie reguł LLD zgodnie z podanymi parametrami.
Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania metody można odebrać w ustawieniach roli użytkownika. Zobacz Role użytkownika po więcej informacji.
Parametry
(object) Parametry definiujące pożądany wynik.
Metoda obsługuje następujące parametry.
| Parametr | Typ | Opis |
|---|---|---|
| itemids | string/array | Zwraca tylko reguły LLD o podanych identyfikatorach ID. |
| groupids | string/array | Zwraca tylko reguły LLD należące do hostów z podanych grup. |
| hostids | string/array | Zwraca tylko reguły LLD należące do podanych hostów. |
| inherited | boolean | Jeśli ustawione na true zwraca tylko reguły LLD odziedziczone z szablonu. |
| interfaceids | string/array | Zwraca tylko reguły LLD, które używają podanych interfejsów hosta. |
| monitored | boolean | Jeśli ustawione na true zwraca tylko włączone reguły LLD należące do monitorowanych hostów. |
| templated | boolean | Jeśli ustawione na true zwraca tylko reguły LLD należące do szablonów. |
| templateids | string/array | Zwraca tylko reguły LLD należące do podanych szablonów. |
| selectFilter | query | Zwraca właściwość filtra z danymi filtra używanego przez regułę LLD. |
| selectGraphs | query | Zwraca właściwość wykresu z prototypami wykresów należącymi do reguły LLD. Obsługuje count. |
| selectHostPrototypes | query | Zwraca właściwość prototypów hosta z prototypami hostów należącymi do reguły LLD. Obsługuje count. |
| selectHosts | query | Zwraca właściwość hostów z tablicą hostów, do których należy reguła LLD. |
| selectItems | query | Zwraca właściwość pozycji z prototypami elementów należącymi do reguły LLD. Obsługuje count. |
| selectTriggers | query | Zwraca właściwość wyzwalaczy z prototypami wyzwalaczy należącymi do reguły LLD. Obsługuje count. |
| selectLLDMacroPaths | queryZwraca właściwość lld_macro_paths z listą makr LLD i ścieżek do wartości przypisanych do każdego odpowiedniego makra. | |
| selectPreprocessing | query | Zwraca właściwość preprocessing z opcjami wstępnego przetwarzania reguły LLD. |
| selectOverrides | query | Zwraca właściwość lld_rule_overrides z listą nadpisań filtrów, warunków i operacji wykonywanych na obiektach prototypowych. |
| filter | object | Zwraca tylko te wyniki, które dokładnie pasują do podanego filtra. Akceptuje tablicę, w której klucze są nazwami właściwości, a wartości są albo pojedynczą wartością, albo tablicą wartości do dopasowania. Obsługuje dodatkowe filtry: host - techniczna nazwa hosta, do którego należy reguła LLD. |
| limitSelects | integer | Ogranicza liczbę rekordów zwracanych przez podzapytania. Dotyczy następujących podzapytań: selctItems;selectGraphs;selectTriggers. |
| sortfield | string/array | Sortuj wynik według podanych właściwości. Możliwe wartości to: itemid, name, key_, delay, type i status. |
| countOutput | boolean | Parametry te są wspólne dla wszystkich metod get i są szczegółowo opisane w komentarzu referencyjnym. |
| editable | boolean | |
| excludeSearch | boolean | |
| 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
countOutputzostał wykorzystany.
Przykłady
Pobieranie reguł wykrywania z hosta
Pobierz wszystkie reguły wykrywania dla określonego ID hosta.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": "extend",
"hostids": "10202"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "27425",
"type": "0",
"snmp_oid": "",
"hostid": "10202",
"name": "Network interface discovery",
"key_": "net.if.discovery",
"delay": "1h",
"status": "0",
"trapper_hosts": "",
"templateid": "22444",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "119",
"description": "Discovery of network interfaces as defined in global regular expression \"Network interfaces for discovery\".",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": []
},
{
"itemid": "27426",
"type": "0",
"snmp_oid": "",
"hostid": "10202",
"name": "Mounted filesystem discovery",
"key_": "vfs.fs.discovery",
"delay": "1h",
"status": "0",
"trapper_hosts": "",
"templateid": "22450",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "119",
"description": "Discovery of file systems of different types as defined in global regular expression \"File systems for discovery\".",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "",
"query_fields": [],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": [],
"retrieve_mode": "0",
"request_method": "0",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": []
}
],
"id": 1
}Pobieranie warunków filtra
Pobierz nazwę reguły LLD „24681” i jej warunki filtrowania. Filtr używa operatora logicznego typu „i”, więc właściwość formula jest pusta, a formuła eval_formula jest generowana automatycznie.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": ["name"],
"selectFilter": "extend",
"itemids": ["24681"]
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "24681",
"name": "Filtered LLD rule",
"filter": {
"evaltype": "1",
"formula": "",
"conditions": [
{
"macro": "{#MACRO1}",
"value": "@regex1",
"operator": "8",
"formulaid": "A"
},
{
"macro": "{#MACRO2}",
"value": "@regex2",
"operator": "9",
"formulaid": "B"
},
{
"macro": "{#MACRO3}",
"value": "",
"operator": "12",
"formulaid": "C"
},
{
"macro": "{#MACRO4}",
"value": "",
"operator": "13",
"formulaid": "D"
}
],
"eval_formula": "A and B and C and D"
}
}
],
"id": 1
}Pobieranie reguły LLD według adresu URL
Pobierz regułę LLD dla hosta według wartości pola adresu URL reguły. Obsługiwane jest tylko dokładne dopasowanie ciągu adresu URL zdefiniowanego dla reguły LLD.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"hostids": "10257",
"filter": {
"type": 19,
"url": "http://127.0.0.1/discoverer.php"
}
},
"id": 39,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": [
{
"itemid": "28336",
"type": "19",
"snmp_oid": "",
"hostid": "10257",
"name": "API HTTP agent",
"key_": "api_discovery_rule",
"delay": "5s",
"status": "0",
"trapper_hosts": "",
"templateid": "0",
"valuemapid": "0",
"params": "",
"ipmi_sensor": "",
"authtype": "0",
"username": "",
"password": "",
"publickey": "",
"privatekey": "",
"interfaceid": "5",
"description": "",
"lifetime": "30d",
"jmx_endpoint": "",
"master_itemid": "0",
"timeout": "3s",
"url": "http://127.0.0.1/discoverer.php",
"query_fields": [
{
"mode": "json"
},
{
"elements": "2"
}
],
"posts": "",
"status_codes": "200",
"follow_redirects": "1",
"post_type": "0",
"http_proxy": "",
"headers": {
"X-Type": "api",
"Authorization": "Bearer mF_A.B5f-2.1JcM"
},
"retrieve_mode": "0",
"request_method": "1",
"ssl_cert_file": "",
"ssl_key_file": "",
"ssl_key_password": "",
"verify_peer": "0",
"verify_host": "0",
"allow_traps": "0",
"uuid": "",
"state": "0",
"error": "",
"parameters": []
}
],
"id": 39
}Pobieranie reguły LLD z nadpisaniami
Pobierz jedną regułę LLD, która ma różne ustawienia nadpisania.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "discoveryrule.get",
"params": {
"output": ["name"],
"itemids": "30980",
"selectOverrides": ["name", "step", "stop", "filter", "operations"]
},
"id": 39,
"auth": "d678e0b85688ce578ff061bd29a20d3b"
}Odpowiedź:
{
"jsonrpc": "2.0",
"result": [
{
"name": "Discover database host",
"overrides": [
{
"name": "Discover MySQL host",
"step": "1",
"stop": "1",
"filter": {
"evaltype": "2",
"formula": "",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mysqld\\.service$",
"formulaid": "A"
},
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^mariadb\\.service$",
"formulaid": "B"
}
],
"eval_formula": "A or B"
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optag": [
{
"tag": "Database",
"value": "MySQL"
}
],
"optemplate": [
{
"templateid": "10170"
}
]
}
]
},
{
"name": "Discover PostgreSQL host",
"step": "2",
"stop": "1",
"filter": {
"evaltype": "0",
"formula": "",
"conditions": [
{
"macro": "{#UNIT.NAME}",
"operator": "8",
"value": "^postgresql\\.service$",
"formulaid": "A"
}
],
"eval_formula": "A"
},
"operations": [
{
"operationobject": "3",
"operator": "2",
"value": "Database host",
"opstatus": {
"status": "0"
},
"optag": [
{
"tag": "Database",
"value": "PostgreSQL"
}
],
"optemplate": [
{
"templateid": "10263"
}
]
}
]
}
]
}
],
"id": 39
}Zobacz także
Źródło
CDiscoveryRule::get() w ui/include/classes/api/services/CDiscoveryRule.php.