dhost.get

Opis

integer/array dhost.get(object parameters)

Ta metoda umożliwia pobieranie wykrytych hostów 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
dhostids ID/array Zwraca tylko wykryte hosty o podanych identyfikatorach.
druleids ID/array Zwraca tylko wykryte hosty, które zostały utworzone przez podane reguły wykrywania.
dserviceids ID/array Zwraca tylko wykryte hosty, na których działają podane usługi.
selectDRules query Zwraca właściwość drules zawierającą tablicę reguł wykrywania, które wykryły host.
selectDServices query Zwraca właściwość dservices zawierającą wykryte usługi działające na hoście.

Obsługuje count.
limitSelects integer Ogranicza liczbę rekordów zwracanych przez podzapytania.

Ma zastosowanie do następujących podzapytań:
selectDServices - wyniki zostaną posortowane według dserviceid.
sortfield string/array Sortuje wynik według podanych właściwości.

Możliwe wartości: dhostid, druleid.
countOutput boolean Te parametry są opisane 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 jedną z opcji:

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

Przykłady

Pobierz odkryte hosty według reguły wykrywania

Pobierz wszystkie hosty i odkryte usługi, które uruchamiają, które zostały wykryte przez regułę wykrywania „4”.

Zapytanie:

{
  "jsonrpc": "2.0",
  "method": "dhost.get",
  "params": {
    "output": "extend",
    "selectDServices": "extend",
    "druleids": "4"
  },
  "id": 1
}

Odpowiedź:

{
  "jsonrpc": "2.0",
  "result": [
    {
      "dservices": [
        {
          "dserviceid": "1",
          "dhostid": "1",
          "type": "4",
          "key_": "",
          "value": "",
          "port": "80",
          "status": "0",
          "lastup": "1337697227",
          "lastdown": "0",
          "dcheckid": "5",
          "ip": "192.168.1.1",
          "dns": "station.company.lan"
        }
      ],
      "dhostid": "1",
      "druleid": "4",
      "status": "0",
      "lastup": "1337697227",
      "lastdown": "0"
    },
    {
      "dservices": [
        {
          "dserviceid": "2",
          "dhostid": "2",
          "type": "4",
          "key_": "",
          "value": "",
          "port": "80",
          "status": "0",
          "lastup": "1337697234",
          "lastdown": "0",
          "dcheckid": "5",
          "ip": "192.168.1.4",
          "dns": "john.company.lan"
        }
      ],
      "dhostid": "2",
      "druleid": "4",
      "status": "0",
      "lastup": "1337697234",
      "lastdown": "0"
    },
    {
      "dservices": [
        {
          "dserviceid": "3",
          "dhostid": "3",
          "type": "4",
          "key_": "",
          "value": "",
          "port": "80",
          "status": "0",
          "lastup": "1337697234",
          "lastdown": "0",
          "dcheckid": "5",
          "ip": "192.168.1.26",
          "dns": "printer.company.lan"
        }
      ],
      "dhostid": "3",
      "druleid": "4",
      "status": "0",
      "lastup": "1337697234",
      "lastdown": "0"
    },
    {
      "dservices": [
        {
          "dserviceid": "4",
          "dhostid": "4",
          "type": "4",
          "key_": "",
          "value": "",
          "port": "80",
          "status": "0",
          "lastup": "1337697234",
          "lastdown": "0",
          "dcheckid": "5",
          "ip": "192.168.1.7",
          "dns": "mail.company.lan"
        }
      ],
      "dhostid": "4",
      "druleid": "4",
      "status": "0",
      "lastup": "1337697234",
      "lastdown": "0"
    }
  ],
  "id": 1
}

Zobacz także

Źródło

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