dhost.get

Описание

целое число/массив dhost.get(объект параметры)

Этот метод позволяет получать обнаруженные узлы сети в соответствии с заданными параметрами.

Параметры

(объект) Параметры задают желаемый вывод.

Этот метод поддерживает следующие параметры.

Параметр	Тип	Описание
dhostids	строка/массив	Возврат обнаруженных узлов сети только с заданными ID.
druleids	строка/массив	Возврат только тех обнаруженных узлов сети, которые были созданы заданными правилами обнаружения.
dserviceids	строка/массив	Возврат только тех обнаруженных узлов сети, на которых работают заданные сервисы.
selectDRules	запрос	Возврат правила обнаружения, которое нашло узел сети, в виде массива в свойстве `drules`.
selectDServices	запрос	Возврат обнаруженных сервисов, которые работают на узле сети, в свойстве `dservices`. Поддерживает `count`.
limitSelects	целое число	Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: `selectDServices` - все результаты сортируются по `dserviceid`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `dhostid` и `druleid`.
countOutput	флаг	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	флаг
filter	объект
limit	целое число
nodeids	строка/массив
output	запрос
preservekeys	флаг
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	флаг

Возвращаемые значения

(целое число/массив) Возвращает либо:

массив объектов;
количество найденных объектов, если используется параметр countOutput.

Примеры

Получение обнаруженных узлов сети по правилу обнаружения

Получение всех узлов сети и обнаруженных работающих сервисов, которые были найдены при помощи правила обнаружения "4".

Запрос:

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

Ответ:

{
           "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
       }

Смотрите также

Исходный код

CDHost::get() в frontends/php/api/classes/CDHost.php.

Documentation