hostinterface.get

Descrizione

integer/array hostinterface.get(object parameters)

Il metodo consente di recuperare le interfacce dell'host in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per chiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Vedere Ruoli utente per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
hostids ID/array Restituisce solo le interfacce host utilizzate dagli host specificati.
interfaceids ID/array Restituisce solo le interfacce host con gli ID specificati.
itemids ID/array Restituisce solo le interfacce host utilizzate dagli item specificati.
triggerids ID/array Restituisce solo le interfacce host utilizzate dagli item nei trigger specificati.
selectItems query Restituisce una proprietà items con gli item che utilizzano l'interfaccia.

Supporta count.
selectHosts query Restituisce una proprietà hosts con un array di host che utilizzano l'interfaccia.
limitSelects integer Limita il numero di record restituiti dalle sottoquery.

Si applica alle seguenti sottoquery:
selectItems.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: interfaceid, dns, ip.
countOutput boolean Questi parametri sono descritti nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recuperare le interfacce del host

Recupera tutti i dati sulle interfacce utilizzate dal host "30057".

Richiesta:

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

Risposta:

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

Guarda anche

Fonte

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