hostinterface.get

Beschrijving

integer/array hostinterface.get(object parameters)

Deze methode maakt het mogelijk om hostinterfaces op te halen volgens de opgegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen kunnen worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruikersrollen voor meer informatie.

Parameters

(object) Parameters die de gewenste uitvoer definiëren.

De methode ondersteunt de volgende parameters.

Parameter	Type	Beschrijving
hostids	string/array	Geef alleen hostinterfaces terug die worden gebruikt door de opgegeven hosts.
interfaceids	string/array	Geef alleen hostinterfaces terug met de opgegeven ID's.
itemids	string/array	Geef alleen hostinterfaces terug die worden gebruikt door de opgegeven items.
triggerids	string/array	Geef alleen hostinterfaces terug die worden gebruikt door items in de opgegeven triggers.
selectItems	query	Geef een eigenschap items terug met de items die de interface gebruiken. Ondersteunt `count`.
selectHosts	query	Geef een eigenschap hosts terug met een reeks hosts die de interface gebruiken.
limitSelects	integer	Beperkt het aantal records dat wordt teruggegeven door subselects. Geldt voor de volgende subselects: `selectItems`.
sortfield	string/array	Sorteer het resultaat op de opgegeven eigenschappen. Mogelijke waarden: `interfaceid`, `dns`, `ip`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven op de pagina referentiecommentaar.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Retourwaarden

(integer/array) Retourneert ofwel:

een reeks objecten;
het aantal opgehaalde objecten, als de countOutput parameter heeft gebruikt.

Voorbeelden

Hostinterfaces ophalen

Haal alle gegevens op over de interfaces die worden gebruikt door host "30057."

Aanvraag:

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

Reactie:

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

Zie ook

Host
Item

Bron

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

Documentation