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 countOutput został 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

Źródło

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

Documentation