dhost.get

Описание

integer/array dhost.get(параметры объекта)

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

Этот метод доступен для пользователей любого типа. Права доступа вызов метода можно отменить в настройках роли пользователя. См. User roles чтобы получить больше информации.

Параметры

(object) Параметры, определяющие желаемый результат.

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

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

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

(integer/array) Возвращает:

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

Примеры

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

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

Request:

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

Response:

{
        · "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() in ui/include/classes/api/services/CDHost.php.

Documentation