hostinterface.get

Opis

integer/array hostinterface.get(object parameters)

Metoda umożliwia pobranie interfejsów hosta zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do jej wywołania mogą zostać cofnięte w ustawieniach ról użytkownika. Zobacz Role użytkowników , aby uzyskać więcej informacji.

Parametry

(object) Parametry definiujące żądany wynik.

Metoda obsługuje następujące parametry.

Parametr Typ Opis
hostids string/array Zwróć tylko interfejsy hosta używane przez podane hosty.
interfaceids string/array Zwróć tylko interfejsy hosta o podanych identyfikatorach.
itemids string/array Zwróć tylko interfejsy hosta używane przez podane pozycje.
triggerids string/array Zwróć tylko interfejsy hosta używane przez pozycje w podanych wyzwalaczach.
selectItems query Zwróć właściwość items z pozycjami, które używają interfejsu.

Obsługuje count.
selectHosts query Zwróć właściwość hosts z tablicą hostów, które używają interfejsu.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Dotyczy następujących podzapytań:
selectItems.
sortfield string/array Sortuj wyniki według podanych właściwości.

Dopuszczalne wartości to: interfaceid, dns, ip.
countOutput boolean Te parametry, wspólne 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

Pobierz interfejsy hosta

Pobierz wszystkie dane dotyczące interfejsów używanych przez hosta "30057."

Zapytanie:

{
           "jsonrpc": "2.0",
           "method": "hostinterface.get",
           "params": {
               "output": "extend",
               "hostids": "30057"
           },
           "auth": "038e1d7b1735c6a5436ee9eae095879e",
           "id": 1
       }

Odpowiedź:

{
           "jsonrpc": "2.0",
           "result": [
               {
                   "interfaceid": "50039",
                   "hostid": "30057",
                   "main": "1",
                   "type": "1",
                   "useip": "1",
                   "ip": "::1",
                   "dns": "",
                   "port": "10050",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": []
               },
               {
                   "interfaceid": "55082",
                   "hostid": "30057",
                   "main": "0",
                   "type": "1",
                   "useip": "1",
                   "ip": "127.0.0.1",
                   "dns": "",
                   "port": "10051",
                   "available": "0",
                   "error": "",
                   "errors_from": "0",
                   "disable_until": "0",
                   "details": {
                       "version": "2",
                       "bulk": "0",
                       "community": "{$SNMP_COMMUNITY}"
                   }
               }
           ],
           "id": 1
       }

Zobacz także

Źródło

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