Table of Contents
hostinterface.get
Description
integer/array hostinterface.get(object parameters)
The method allows to retrieve host interfaces according to the given parameters.
This method is available to users of any type. Permissions to call the method can be revoked in user role settings. See User roles for more information.
Parameters
(object) Parameters defining the desired output.
The method supports the following parameters.
| Parameter | Type | Description |
|---|---|---|
| hostids | ID/array | Return only host interfaces used by the given hosts. |
| interfaceids | ID/array | Return only host interfaces with the given IDs. |
| itemids | ID/array | Return only host interfaces used by the given items. |
| triggerids | ID/array | Return only host interfaces used by items in the given triggers. |
| selectItems | query | Return an items property with the items that use the interface.Supports count. |
| selectHosts | query | Return a hosts property with an array of hosts that use the interface. |
| limitSelects | integer | Limits the number of records returned by subselects. Applies to the following subselects: selectItems. |
| sortfield | string/array | Sort the result by the given properties. Possible values: interfaceid, dns, ip. |
| countOutput | boolean | These parameters being common for all get methods are described in detail in the reference commentary page. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Return values
(integer/array) Returns either:
- an array of objects;
- the count of retrieved objects, if the
countOutputparameter has been used.
Examples
Retrieve host interfaces
Retrieve all data about the interfaces used by host "30057."
{
"jsonrpc": "2.0",
"method": "hostinterface.get",
"params": {
"output": "extend",
"hostids": "30057"
},
"id": 1
}Response:
{
"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
}See also
Source
CHostInterface::get() in ui/include/classes/api/services/CHostInterface.php.