hostinterface.get

Opis

integer/array hostinterface.get(object parameters)

Ta metoda umożliwia pobieranie interfejsów hosta zgodnie z podanymi parametrami.

Ta metoda jest dostępna dla użytkowników dowolnego typu. Uprawnienia do wywoływania tej metody mogą zostać cofnięte w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.

Parametry

(object) Parametry definiujące żądane dane wyjściowe.

Metoda obsługuje następujące parametry.

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

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

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

Możliwe wartości: interfaceid, dns, ip.
countOutput boolean Te parametry opisano w komentarzu referencyjnym.
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:

  • tablicę obiektów;
  • liczbę pobranych obiektów, jeśli został użyty parametr countOutput.

Przykłady

Pobieranie interfejsów hosta

Pobierz wszystkie dane o interfejsach używanych przez host „30057”.

Żądanie:

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

Odpowiedź:

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

Zobacz także

Źródło

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