hostinterface.get

Descripció

integer/array hostinterface.get(object parameters)

El mètode permet recuperar interfícies d'equips segons els paràmetres proveïts.

Aquest mètode és disponible per a usuaris de qualsevol mena. Els permisos per cridar al mètode es poden revocar a les configuracions de rols d'usuari. Per a més informació, veieu Rols d'usuari.

Paràmetres

(object) Paràmetres que defineixen la sortida desitjada.

El mètode admet els paràmetres següents.

Paràmetre	Tipus	Descripció
hostids	string/array	Retorna només les interfícies d'equip emprades pels equips donats.
interfaceids	string/array	Retorna només les interfícies d'equip amb els IDs donats.
itemids	string/array	Retorna només les interfícies d'equip emprades pels elements donats.
triggerids	string/array	Retorna només les interfícies d'equip emprades pels triggers donats.
selectItems	query	Retorna una propietat elements que conté els elements que empren la interfície. Admet `count`.
selectHosts	query	Retorna una propietat equips que conté una matriu dels equips que empren la interfície.
limitSelects	integer	Limita el nombre de registres retornats per subconsultes. S'aplica a les subconsultes següents: `selectItems`.
sortfield	string/array	Ordena el resultat per les propietats donades. Els valors possibles són: `interfaceid`, `dns`, `ip`.
countOutput	boolean	Aquests paràmetres, comuns a tots els mètodes `get`, es descriuen als comentaris de referència.
editable	boolean
excludeSearch	boolean
filter	object
limit	integer
output	query
preservekeys	boolean
search	object
searchByAny	boolean
searchWildcardsEnabled	boolean
sortorder	string/array
startSearch	boolean

Valors de retorn

(integer/array) Retorna un d'entre:

una taula d'objectes;
el recompte d'objectes recuperats, si s'empra el paràmetre countOutput.

Exemples

Recuperar les interfícies d'un equip

Recuperar tota la informació de les interfícies emprades per l'equip "30057."

Petició:

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

Resposta:

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

Veieu també

Font

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

Documentation