hostinterface.get

Описание

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

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

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

Параметры

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

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

Параметр Тип Описание
hostids ID/array Возвращать только интерфейсы узлов сети, используемые указанными узлами сети.
interfaceids ID/array Возвращать только интерфейсы узлов сети с указанными ID.
itemids ID/array Возвращать только интерфейсы узлов сети, используемые указанными элементами данных.
triggerids ID/array Возвращать только интерфейсы узлов сети, используемые элементами данных в указанных триггерах.
selectItems query Возвращать свойство items с элементами данных, использующими интерфейс.

Поддерживает count.
selectHosts query Возвращать свойство hosts с массивом узлов сети, использующих интерфейс.
limitSelects integer Ограничивает количество записей, возвращаемых подзапросами.

Применяется к следующим подзапросам:
selectItems.
sortfield string/array Сортировать результат по указанным свойствам.

Возможные значения: interfaceid, dns, ip.
countOutput boolean Эти параметры описаны в справочном комментарии.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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

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

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

Примеры

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

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

Запрос:

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

Ответ:

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

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

Источник

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