hostinterface.get

Описание

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

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

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

Параметры

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

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

Параметр	Тип	Описание
hostids	строка/массив	Возврат только тех интерфейсов узлов сети, которые используются заданными узлами сети.
interfaceids	строка/массив	Возврат интерфейсов узлов сети только с заданными IDs.
itemids	строка/массив	Возврат только тех интерфейсов узлов сети, которые используются заданными элементами данных.
triggerids	строка/массив	Возврат только тех узлов сети, которые используются элементами данных в заданных триггерах.
selectItems	запрос	Возврат элементов данных, которые используют интерфейс, в свойстве `items`. Поддерживается `count`.
selectHosts	запрос	Возврат узла сети, который использует интерфейс, в виде массива в свойстве `hosts`.
limitSelects	целое число	Ограничение количества записей, возвращаемых подзапросами. Применимо только к следующим подзапросам: `selectItems`.
sortfield	строка/массив	Сортировка результата в соответствии с заданными свойствами. Возможные значения: `interfaceid`, `dns`, `ip`.
countOutput	логический	Эти параметры являются общими для всех методов `get` и они описаны в справочных комментариях.
editable	логический
excludeSearch	логический
filter	объект
limit	целое число
output	запрос
preservekeys	логический
search	объект
searchByAny	логический
searchWildcardsEnabled	логический
sortorder	строка/массив
startSearch	логический

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

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

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

Примеры

Получение интерфейсов узла сети

Получить все данные об интерфейсах, используемых узлом сети "30057".

Запрос:

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

Ответ:

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

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

Источник

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

Documentation