hostinterface.get

Descripción

integer/array hostinterface.get(object parameters)

Este procedimiento nos permite recuperar las interfaces de equipo según los parámetros dados.

Este método está disponible para todo tipo de usuarios. Los permisos para invocar este procedimiento pueden ser revocados en los roles de usuario. Ver Roles de usuario para más información.

Parámetros

(object) Los parámetros que definen la salida deseada.

Este procedimiento soporta los siguientes parámetros.

Parámetro Tipo Descripción
hostids ID/matriz Devuelve sólo las interfaces de equipo de la IDs dadas.
interfaceids ID/matriz Devuelve sólo interfaces de equipo con los ID proporcionados.
itemids ID/matriz Devuelve sólo las interfaces del equipo usadas por las métricas dadas.
triggerids string/array Devuelve sólo las interfaces de equipo usadas por las métricas en los iniciadores dados.
selectItems consulta Devuelve una propiedad items con las métricas que usa la interfaz.

Soporta count
selectHosts consulta Devuelve una propiedad hosts con una matriz de equipos que usan la interfaz.
limitSelects entero Limita el numero de registros devueltos por subconsultas.

Se aplica en las siguientes subconsultas:
selectItems.
sortfield cadena/matriz Ordena el resultado por las propiedad dadas.

Los posibles valores son: interfaceid, dns, ip.
countOutput booleano Estos parámetros son comunes para todos los procedimientos get están descritos en detalle en la página comentario de referencia.
editable booleano
excludeSearch booleano
filter objeto
limit entero
output consulta
preservekeys booleano
search objeto
searchByAny booleano
searchWildcardsEnabled booleano
sortorder cadena/matriz
startSearch boobleano

Valores de devueltos

(integer/array) Returns either:

  • una matriz de objetos;
  • la suma de los objetos devueltos, si el parámetros countOutput está siendo usado

Ejemplos

Recuperar interfaces de equipo

Recupere todos los datos sobre las interfaces utilizadas por el equipo "30057".

Solicitud:

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

Respuesta:

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

Ver también

Fuente

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