hostinterface.get

Descripción

integer/array hostinterface.get(object parameters)

El método permite recuperar interfaces de equipos según los parámetros proporcionados.

Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener más información.

Parámetros

(objeto) Parámetros que definen la salida deseada.

El método admite los siguientes parámetros.

Parámetro Tipo Descripción
hostids ID/array Devolver solo las interfaces de host utilizadas por los hosts indicados.
interfaceids ID/array Devolver solo las interfaces de host con los IDs indicados.
itemids ID/array Devolver solo las interfaces de host utilizadas por los items indicados.
triggerids ID/array Devolver solo las interfaces de host utilizadas por los items en los triggers indicados.
selectItems query Devolver una propiedad items con los items que utilizan la interfaz.

Admite count.
selectHosts query Devolver una propiedad hosts con un array de hosts que utilizan la interfaz.
limitSelects integer Limita el número de registros devueltos por subconsultas.

Se aplica a las siguientes subconsultas:
selectItems.
sortfield string/array Ordenar el resultado por las propiedades indicadas.

Valores posibles: interfaceid, dns, ip.
countOutput boolean Estos parámetros se describen en el comentario de referencia.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valores de retorno

(integer/array) Devuelve:

  • un array de objetos;
  • el número de objetos recuperados, si se ha utilizado el parámetro countOutput.

Ejemplos

Recuperar interfaces de equipo

Recuperar 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": "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
}

Véase también

Fuente

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