interfaceGetList

Mit der Aktion interfaceGetList kann man eine Liste von Interfaces anfordern.

Geliefert werden die Daten im interfaces Block

Beispiel

Anfrage:

{
	"action": "interfacesGetList"
}

Antwort (stark gekürzt):

{
	"action": "interfaceGetList",
	"interfaces": [
		{
			"deviceId": 8,
			"deviceTypeId": 23,
			"ifIndex": "3",
			"description": "lo",
			"mibTypeId": 24,
			"lastUpdateUtcMs": "1636201970000"
		},
		{
			"deviceId": 11,
			"deviceTypeId": 6,
			"ifIndex": "2",
			"description": "eno1 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
			"mibTypeId": 6,
			"speedMbs": "1000",
			"lastUpdateUtcMs": "1636201970000"
		},
		{
			"deviceId": 11,
			"deviceTypeId": 6,
			"ifIndex": "3",
			"description": "eno2 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
			"mibTypeId": 6,
			"isAdminDown": true,
			"isOperationDown": true,
			"lastUpdateUtcMs": "1636201970000"
		}
	]
}

Parameter

Man kann die Ausgabe durch Parameter beeinflussen, entweder man kann sie erweitern oder verringern.

Parameter Name Datentyp Default Beschreibung
.actionParameter.filterDeviceIdByIds Liste von Integer [] Eine Liste von Geräte IDs die ausgegeben werden soll
.actionParameter.filterDeviceTypeIdByIds Liste von Integer [] Eine Liste von Gerätetypen IDs die ausgegeben werden soll
.actionParameter.filterInterfaceByMibTypes Liste von Integer [] Eine Liste von MIB Typen die ausgegeben werden soll
.actionParameter.filterInterfaceByAdminState String - Kann entweder UP oder DOWN sein, sofern eine Filterung erwünscht ist
.actionParameter.filterInterfaceByOperationState String - Kann entweder UP oder DOWN sein, sofern eine Filterung erwünscht ist
.actionParameter.filterInterfaceByDescriptionMatch String - Filtert Interfaces mit einer Description. Der Text wird case-insensitive gesucht. Kein RegEx !
.actionParameter.includeDeviceType Boolean false Gibt den Gerätetyp für jedes Interface mit aus
.actionParameter.includeDevice Boolean false Gibt die Geräteinformationen für jedes Interface mit aus

Bitte beachten: Mehrere Filter zusammen in einer Anfrage sind immer im AND Modus. Für ein ODER müssen mehrere Anfragen gemacht werden.

Bitte weiterhin beachten, dass wenn man alles Included und nichts filtert, die Ausgabe gewaltige Ausmaße annehmen kann.

Beispiel mit Filtern und Includes

Im folgenden Beispiel werden mehrere Action-Parameter kombiniert. Die einzelne Beispiel-Auslistung wäre schlichtweg zu viel. Daher gibt es nur ein Beispiel, wo mehr oder weniger alles angezeigt wird.

Anfrage:

{
	"action": "interfaceGetList",
	"actionParameter": {
		"filterDeviceIdByIds": [
			11
		],
		"includeDeviceType": true,
		"includeDevice": true
	}
}

Antwort (sehr stark gekürzt):

{
	"action": "interfaceGetList",
	"actionParameter": {
		"filterDeviceIdByIds": [
			11
		],
		"includeDevice": true,
		"includeDeviceType": true
	},
	"interfaces": [
		{
			"deviceId": 11,
			"deviceTypeId": 6,
			"ifIndex": "2",
			"description": "eno1 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
			"mibTypeId": 6,
			"speedMbs": "1000",
			"lastUpdateUtcMs": "1636201970000",
			"deviceType": {
				"id": 6,
				"name": "UNIX CorvusCore",
				"description": "UNIX mit CorvusCore und NET-SNMP"
			},
			"device": {
				"id": 11,
				"name": "corvus Frankfurt",
				"ip": "10.10.10.10"
			}
		},
		{
			"deviceId": 11,
			"deviceTypeId": 6,
			"ifIndex": "3",
			"description": "eno2 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
			"mibTypeId": 6,
			"isAdminDown": true,
			"isOperationDown": true,
			"lastUpdateUtcMs": "1636201970000",
			"deviceType": {
				"id": 6,
				"name": "UNIX CorvusCore",
				"description": "UNIX mit CorvusCore und NET-SNMP"
			},
			"device": {
				"id": 11,
				"name": "corvus Frankfurt",
				"ip": "10.10.10.10"
			}
		}
	]
}

Antwort Datenfelder

Hier eine vollständige Beschreibung aller möglichen Datenfelder der Antwort

Parameter Name Datentyp Beschreibung
.interfaces Liste Liste aller gefundenen Interfaces
.interfaces[].ifIndex Integer Der Interface Index mit dem das Interface auf dem Gerät identifiziert wird
.interfaces[].description String Die Interface Beschreibung
.interfaces[].mibTypeId Integer Der MIB Type des Interfaces (siehe IANA IfType)
.interfaces[].isAdminDown Boolean Wenn das Interface Admin-Down ist, ist dieser Wert gesetzt
.interfaces[].isOperationDown Boolean Wenn das Interface Operation-Down ist, ist dieser Wert gesetzt
.interfaces[].speedMps Long Die Interface Geschwindigkeit in Megabit Pro Sekunde. Der Wert kann fehlen, insbesondere wenn das Interface nicht UP/UP ist
.interfaces[].isEgressSpeed boolean Ist gesetzt, wenn es am Interface einen speziellen Shaping Egress Speed geben sollte
.interfaces[].egressSpeedMps Long Wenn isEgressSpeed gesetzt ist, dann könnte hier die Geschwindigkeit des Shapers drin stehen
.interfaces[].isTraffic32bit Boolean Wenn das Gerät keine 64bit Counter für Traffic anbietet. Das kann bei Traffic Auswertungen zu echten Problemen führen
.interfaces[].isIgnored Boolean Ist gesetzt, wenn das Interface ignoriert wird. Das können zum Beispiel Virtuelle Interfaces sein. Die Entscheidung kommt vom Interface Filter
.interfaces[].lastUpdateUtcMs Long Der Zeitstempel der letzten Änderung
.interfaces[].device Record Das Gerät vom Interface. Wird gesetzt wenn .actionParameter.includeDevice gesetzt ist
.interfaces[].device.id Integer Die interne ID des Gerätes
.interfaces[].device.name String Der Name des Gerätes
.interfaces[].device.ip String Die IP oder der Hostname des Gerätes
.interfaces[].deviceType Record Beinhaltet den Gerätetyp, sofern .actionParameter.includeDeviceType auf true steht
.interfaces[].deviceType.id Integer Die interne ID des Gerätetyps
.interfaces[].deviceType.name String Der Name des Gerätetyps
.interfaces[].deviceType.description String Die Beschreibung der Gerätetyps

Corvus Help - 28.February 2026 03:33:38 UTC - Commit 667ccc2e