Documentation
Table of Contents
hostprototype.get
Opis
integer/array hostprototype.get(object parameters)
Metoda umo?liwia pobranie prototyp¨®w host¨®w 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 aby uzyska? wi?cej informacji.
Parametry
(object) Parametry definiuj?ce po??dany wynik.
Metoda obs?uguje nast?puj?ce parametry.
| Parametr | Typ | Opis |
|---|---|---|
| hostids | string/array | Zwr¨®? tylko prototypy host¨®w o podanych ID. |
| discoveryids | string/array | Zwr¨®? tylko prototypy host¨®w nale??ce do podanych regu? LLD. |
| inherited | boolean | Je?li ustawione na true, zwr¨®? tylko pozycje dziedziczone z szablonu. |
| selectDiscoveryRule | query | Zwr¨®? w?a?ciwo?? discoveryRule z regu?? LLD, do kt¨®rej nale?y prototyp hosta. |
| selectInterfaces | query | Zwr¨®? w?a?ciwo?? interfaces z indywidualnymi interfejsami prototypu hosta. |
| selectGroupLinks | query | Zwr¨®? w?a?ciwo?? groupLinks z powi?zaniami grup prototyp¨®w host¨®w. |
| selectGroupPrototypes | query | Zwr¨®? w?a?ciwo?? groupPrototypes z prototypami grup host¨®w. |
| selectMacros | query | Zwr¨®? w?a?ciwo?? macros z makrami prototypu hosta. |
| selectParentHost | query | Zwr¨®? w?a?ciwo?? parentHost z hostem, do kt¨®rego nale?y prototyp hosta. |
| selectTags | query | Zwr¨®? w?a?ciwo?? tags z znacznikami prototypu hosta. |
| selectTemplates | query | Zwr¨®? w?a?ciwo?? templates z szablonami powi?zanymi z prototypem hosta. Obs?uguje count. |
| sortfield | string/array | Sortuj wyniki wed?ug podanych w?a?ciwo?ci. Mo?liwe warto?ci to: hostid, host, name i status. |
| countOutput | boolean | Te parametry, b?d?c powszechnymi dla wszystkich metod get, s? szczeg¨®?owo opisane 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
countOutputzosta? wykorzystany.
Przyk?ady
Pobieranie prototyp¨®w host¨®w z regu?y LLD
Pobierz wszystkie prototypy host¨®w, ich ??cza grupowe, prototypy grup oraz znaczniki z regu?y LLD.
Zapytanie:
{
"jsonrpc": "2.0",
"method": "hostprototype.get",
"params": {
"output": "extend",
"selectInterfaces": "extend",
"selectGroupLinks": "extend",
"selectGroupPrototypes": "extend",
"selectTags": "extend",
"discoveryids": "23554"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Odpowied?:
{
"jsonrpc": "2.0",
"result": [
{
"hostid": "10092",
"host": "{#HV.UUID}",
"name": "{#HV.UUID}",
"status": "0",
"templateid": "0",
"discover": "0",
"custom_interfaces": "1",
"inventory_mode": "-1",
"groupLinks": [
{
"group_prototypeid": "4",
"hostid": "10092",
"groupid": "7",
"templateid": "0"
}
],
"groupPrototypes": [
{
"group_prototypeid": "7",
"hostid": "10092",
"name": "{#CLUSTER.NAME}",
"templateid": "0"
}
],
"tags": [
{
"tag": "Datacenter",
"value": "{#DATACENTER.NAME}"
},
{
"tag": "Instance type",
"value": "{#INSTANCE_TYPE}"
}
],
"interfaces": [
{
"main": "1",
"type": "2",
"useip": "1",
"ip": "127.0.0.1",
"dns": "",
"port": "161",
"details": {
"version": "2",
"bulk": "1",
"community": "{$SNMP_COMMUNITY}"
}
}
]
}
],
"id": 1
}Zobacz tak?e
?°ù¨®»å?´Ç
CHostPrototype::get() w ui/include/classes/api/services/CHostPrototype.php.