hostinterface.get

Beschreibung

integer/array hostinterface.get(object parameters)

Diese Methode ermöglicht es, Host-Schnittstellen entsprechend den angegebenen Parametern abzurufen.

Diese Methode ist für Benutzer aller Typen verfügbar. Die Berechtigungen zum Aufrufen der Methode können in den Einstellungen der Benutzerrolle entzogen werden. Weitere Informationen finden Sie unter Benutzerrollen.

Parameter

(object) Parameter, die die gewünschte Ausgabe definieren.

Die Methode unterstützt die folgenden Parameter.

Parameter Type Beschreibung
hostids ID/array Gibt nur Host-Schnittstellen zurück, die von den angegebenen Hosts verwendet werden.
interfaceids ID/array Gibt nur Host-Schnittstellen mit den angegebenen IDs zurück.
itemids ID/array Gibt nur Host-Schnittstellen zurück, die von den angegebenen Datenpunkten verwendet werden.
triggerids ID/array Gibt nur Host-Schnittstellen zurück, die von Datenpunkten in den angegebenen Auslösern verwendet werden.
selectItems query Gibt eine Eigenschaft items mit den Datenpunkten zurück, die die Schnittstelle verwenden.

Unterstützt count.
selectHosts query Gibt eine Eigenschaft hosts mit einem Array von Hosts zurück, die die Schnittstelle verwenden.
limitSelects integer Begrenzt die Anzahl der Datensätze, die von Unterabfragen zurückgegeben werden.

Gilt für die folgenden Unterabfragen:
selectItems.
sortfield string/array Sortiert das Ergebnis nach den angegebenen Eigenschaften.

Mögliche Werte: interfaceid, dns, ip.
countOutput boolean Diese Parameter werden im Referenzkommentar beschrieben.
editable boolean
excludeSearch boolean
filter object
limit integer
output query
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

Rückgabewerte

(integer/array) Kann die folgenden Dinge zurück geben:

  • ein Array von Objekten;
  • die Anzahl der abgerufenen Objekte, wenn der Parameter countOutput verwendet wurde.

Beispiele

Host-Schnittstellen abrufen

Rufen Sie alle Daten zu den Schnittstellen ab, die vom Host „30057“ verwendet werden.

Anfrage:

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

Antwort:

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

Siehe auch

Quelle

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