hostinterface.get

Beschrijving

integer/array hostinterface.get(objectparameters)

De methode maakt het mogelijk om hostinterfaces op te halen volgens de gegeven parameters.

Deze methode is beschikbaar voor gebruikers van elk type. Rechten om de methode aan te roepen, kan worden ingetrokken in de instellingen van de gebruikersrol. Zie Gebruiker rollen 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 door de opgegeven hosts worden gebruikt.
interfaceids	string/array	Geef alleen hostinterfaces terug met de opgegeven IDs.
itemids	string/array	Geef alleen hostinterfaces terug die door de opgegeven items worden gebruikt.
triggerids	string/array	Geef alleen hostinterfaces terug die worden gebruikt door items in de opgegeven triggers.
selectItems	query	Geef een items eigenschap terug met de items die de interface gebruiken. Ondersteunt `count`.
selectHosts	query	Geef een hosts eigenschap terug met een array van hosts die de interface gebruiken.
limitSelects	integer	Beperk het aantal records dat wordt teruggegeven door subselecties. Geldt voor de volgende subselecties: `selectItems`.
sortfield	string/array	Sorteer het resultaat op basis van de opgegeven eigenschappen. Mogelijke waarden zijn: `interfaceid`, `dns`, `ip`.
countOutput	boolean	Deze parameters, die gemeenschappelijk zijn voor alle `get`-methoden, worden in detail beschreven op de referentiecommentaar pagina.
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 door host "30057" worden gebruikt.

Verzoek:

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

Antwoord:

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