Corvus Hilfe > Api > Yuna > Aktionen > deviceGetList

deviceGetList

Mit der Aktion deviceGetList kann man eine Liste von Geräten anfordern.

Geliefert werden die Daten im devices Block

Beispiel

Anfrage:

{
	"action": "deviceGetList"
}

Antwort:

{
	"action": "deviceGetList",
	"devices": [
		{
			"id": 11,
			"name": "corvus Frankfurt",
			"ip": "10.10.10.11",
			"lastAutoConfigUtcMs": "1659486567000"
		},
		{
			"id": 12,
			"name": "corvus Mainz",
			"ip": "10.10.10.21",
			"lastAutoConfigUtcMs": "1659486567000"
		},
		{
			"id": 16,
			"name": "corvus Bielefeld",
			"ip": "10.10.10.31",
			"isDeactivated": true
		},
		{
			"id": 17,
			"name": "corvus Nürnberg",
			"ip": "10.10.10.41",
			"lastAutoConfigUtcMs": "1659486567000"
		}
	]
}

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.filterSysdepKeyByKeys	Liste von Strings	[]	Eine Liste von Sysdep Keys die ausgegeben werden soll, sofern .actionParameter.includeSysdeps gesetzt ist
.actionParameter.countInterfaces	Boolean	false	Liefert die Anzahl der eingetragenen Interfaces
.actionParameter.countSysdeps	Boolean	false	Liefert die gesamt Anzahl gefundener Sysdeps (ohne Filter)
.actionParameter.includeDeviceType	Boolean	false	Gibt den Gerätetyp für jedes Gerät mit aus
.actionParameter.includeInterfaces	Boolean	false	Gibt alle Interfaces des Gerätes mit aus
.actionParameter.includeSysdeps	Boolean	false	Gibt alle Sysdep Informationen des Gerätes mit aus
.actionParameter.includeVg	Boolean	false	Gibt alle VG Informationen des Gerätes 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.

Aber auf nur ein Gerät gefiltert, man beachte, dass die gesamte Liste ohne Filter leicht sehr groß werden könnte.

Anfrage:

{
	"action": "deviceGetList",
	"actionParameter": {
		"filterDeviceIdByIds": [
			11
		],
		"countInterfaces": true,
		"countSysdeps": true,
		"includeDeviceType": true,
		"includeInterfaces": true,
		"includeSysdeps": true,
		"includeVg": true,
		"filterSysdepKeyByKeys": [
			"HR_PROCESSOR_LOAD"
		]
	}
}

Antwort (sehr stark gekürzt):

{
	"devices": [
		{
			"id": 11,
			"name": "corvus Frankfurt",
			"ip": "10.10.10.10",
			"lastAutoConfigUtcMs": "1659486567000",
			"countInterfaces": 2,
			"countSysdeps": 2,
			"deviceType": {
				"id": 6,
				"name": "UNIX CorvusCore",
				"description": "UNIX mit CorvusCore und NET-SNMP"
			},
			"interfaces": [
				{
					"ifIndex": "2",
					"description": "eno1 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
					"mibTypeId": 6,
					"speedMbs": "1000",
					"lastUpdateUtcMs": "1636201970000"
				},
				{
					"ifIndex": "3",
					"description": "eno2 - Broadcom Corporation NetXtreme BCM5719 Gigabit Ethernet PCIe",
					"mibTypeId": 6,
					"isAdminDown": true,
					"isOperationDown": true,
					"lastUpdateUtcMs": "1636201970000"
				}
			],
			"sysdeps": [
				{
					"id": "232605",
					"key": "HR_PROCESSOR_LOAD",
					"userData01": "32",
					"createdUtcMs": "1565717378000",
					"lastUpdateUtcMs": "1659486566000"
				}
			],
			"vg": {
				"vg01NameShort": "B",
				"vg01NameLong": "Bereich",
				"vg01ItemId": 14,
				"vg01ItemNameShort": "Z",
				"vg01ItemNameLong": "Zentral",
				"vg02NameShort": "R",
				"vg02NameLong": "Region",
				"vg02ItemId": 62,
				"vg02ItemNameShort": "M",
				"vg02ItemNameLong": "Mitte"
			}
		}
	]
}

Antwort Datenfelder

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

Parameter Name	Datentyp	Beschreibung
.devices	Liste	Liste aller gefundenen Geräte und deren Informationen
.devices[].id	Integer	Die interne ID des Gerätes
.devices[].name	String	Der Name des Gerätes
.devices[].ip	String	Die IP oder der Hostname des Gerätes
.devices[].isDeactivated	Boolean	Wird auf true gesetzt, wenn das Gerät vom Administrator deaktiviert wurde
.devices[].isOffline	Boolean	Wird auf true gesetzt, wenn das Gerät als Offline markiert wurde
.devices[].isOfflineSinceUtcMs	Long	Der Zeitstempel ab wann das Gerät als Offline gilt, sofern es Offline ist
.devices[].isLazyPurge	Boolean	Wird auf true gesetzt, wenn das Gerät im LazyPurge Status ist
.devices[].lazyPurgeCreateUtcMs	Long	Der Zeitstempel ab wann das Gerät in den LazyPurge Status gesetzt wurde
.devices[].countInterfaces	Integer	Liefert die Anzahl der Interfaces, wenn .actionParameter.countInterfaces gesetzt ist
.devices[].countSysdeps	Integer	Liefert die Anzahl der Sysdeps, wenn .actionParameter.countSysdeps gesetzt ist
.devices[].lastAutoConfigUtcMs	Long	Der Zeitstempel wann das Gerät zuletzt gescannt wurde
.devices[].deviceType	Record	Beinhaltet den Gerätetyp, sofern es einen validen Gerätetyp gibt und .actionParameter.includeDeviceType auf true steht
.devices[].deviceType.id	Integer	Die interne ID des Gerätetyps
.devices[].deviceType.name	String	Der Name des Gerätetyps
.devices[].deviceType.description	String	Die Beschreibung der Gerätetyps
.devices[].interfaces	Liste	Liste aller gefundenen Interfaces zu dem Gerät, ist vorhanden, wenn .actionParameter.includeInterfaces gesetzt ist
.devices[].interfaces[].ifIndex	Integer	Der Interface Index mit dem das Interface auf dem Gerät identifiziert wird
.devices[].interfaces[].description	String	Die Interface Beschreibung
.devices[].interfaces[].mibTypeId	Integer	Der MIB Type des Interfaces (siehe IANA IfType)
.devices[].interfaces[].isAdminDown	Boolean	Wenn das Interface Admin-Down ist, ist dieser Wert gesetzt
.devices[].interfaces[].isOperationDown	Boolean	Wenn das Interface Operation-Down ist, ist dieser Wert gesetzt
.devices[].interfaces[].speedMps	Long	Die Interface Geschwindigkeit in Megabit Pro Sekunde. Der Wert kann fehlen, insbesondere wenn das Interface nicht UP/UP ist
.devices[].interfaces[].isEgressSpeed	boolean	Ist gesetzt, wenn es am Interface einen speziellen Shaping Egress Speed geben sollte
.devices[].interfaces[].egressSpeedMps	Long	Wenn isEgressSpeed gesetzt ist, dann könnte hier die Geschwindigkeit des Shapers drin stehen
.devices[].interfaces[].isTraffic32bit	Boolean	Wenn das Gerät keine 64bit Counter für Traffic anbietet. Das kann bei Traffic Auswertungen zu echten Problemen führen
.devices[].interfaces[].isIgnored	Boolean	Ist gesetzt, wenn das Interface ignoriert wird. Das können zum Beispiel Virtuelle Interfaces sein. Die Entscheidung kommt vom Interface Filter
.devices[].interfaces[].lastUpdateUtcMs	Long	Der Zeitstempel der letzten Änderung
.devices[].sysdeps	Liste	Liste aller gefundenen Sysdep zu dem Gerät, ist vorhanden, wenn .actionParameter.includeSysdeps gesetzt ist
.devices[].sysdeps[].id	Integer	Die ID des Sysdep
.devices[].sysdeps[].key	String	Der Sysdep Key Name
.devices[].sysdeps[].isInvalid	Boolean	Ist gesetzt, wenn der Sysdep nicht mehr aktiv und invalide ist
.devices[].sysdeps[].userData01	String	Der Inhalt des User Data 01 Feldes
.devices[].sysdeps[].userData02	String	Der Inhalt des User Data 02 Feldes
.devices[].sysdeps[].userData03	String	Der Inhalt des User Data 03 Feldes
.devices[].sysdeps[].userData04	String	Der Inhalt des User Data 04 Feldes
.devices[].sysdeps[].userData05	String	Der Inhalt des User Data 05 Feldes
.devices[].sysdeps[].userData06	String	Der Inhalt des User Data 06 Feldes
.devices[].sysdeps[].userData07	String	Der Inhalt des User Data 07 Feldes
.devices[].sysdeps[].userData08	String	Der Inhalt des User Data 08 Feldes
.devices[].sysdeps[].userData09	String	Der Inhalt des User Data 09 Feldes
.devices[].sysdeps[].createdUtcMs	Long	Der Zeitstempel der Erstellung
.devices[].sysdeps[].lastUpdateUtcMs	Long	Der Zeitstempel der letzten Änderung
.devices[].vg	Record	Die VG Informationen, sofern .actionParameter.includeVg gesetzt ist
.devices[].vg.vg01NameShort	String	Der kurze Name der VG 01
.devices[].vg.vg01NameLong	String	Der lange Name der VG 01
.devices[].vg.vg01ItemId	Integer	Die Id des VG Items der VG 01
.devices[].vg.vg01ItemNameShort	String	Der kurze Name des VG Items der VG 01
.devices[].vg.vg01ItemNameLong	String	Der lange Name des VG Items der VG 01
.devices[].vg.vg02NameShort	String	Der kurze Name der VG 02
.devices[].vg.vg02NameLong	String	Der lange Name der VG 02
.devices[].vg.vg02ItemId	Integer	Die Id des VG Items der VG 02
.devices[].vg.vg02ItemNameShort	String	Der kurze Name des VG Items der VG 02
.devices[].vg.vg02ItemNameLong	String	Der lange Name des VG Items der VG 02
.devices[].vg.vg03NameShort	String	Der kurze Name der VG 03
.devices[].vg.vg03NameLong	String	Der lange Name der VG 03
.devices[].vg.vg03ItemId	Integer	Die Id des VG Items der VG 03
.devices[].vg.vg03ItemNameShort	String	Der kurze Name des VG Items der VG 03
.devices[].vg.vg03ItemNameLong	String	Der lange Name des VG Items der VG 03
.devices[].vg.vg04NameShort	String	Der kurze Name der VG 04
.devices[].vg.vg04NameLong	String	Der lange Name der VG 04
.devices[].vg.vg04ItemId	Integer	Die Id des VG Items der VG 04
.devices[].vg.vg04ItemNameShort	String	Der kurze Name des VG Items der VG 04
.devices[].vg.vg04ItemNameLong	String	Der lange Name des VG Items der VG 04
.devices[].vg.vg05NameShort	String	Der kurze Name der VG 05
.devices[].vg.vg05NameLong	String	Der lange Name der VG 05
.devices[].vg.vg05ItemId	Integer	Die Id des VG Items der VG 05
.devices[].vg.vg05ItemNameShort	String	Der kurze Name des VG Items der VG 05
.devices[].vg.vg05ItemNameLong	String	Der lange Name des VG Items der VG 05
.devices[].vg.vg06NameShort	String	Der kurze Name der VG 06
.devices[].vg.vg06NameLong	String	Der lange Name der VG 06
.devices[].vg.vg06ItemId	Integer	Die Id des VG Items der VG 06
.devices[].vg.vg06ItemNameShort	String	Der kurze Name des VG Items der VG 06
.devices[].vg.vg06ItemNameLong	String	Der lange Name des VG Items der VG 06
.devices[].vg.vg07NameShort	String	Der kurze Name der VG 07
.devices[].vg.vg07NameLong	String	Der lange Name der VG 07
.devices[].vg.vg07ItemId	Integer	Die Id des VG Items der VG 07
.devices[].vg.vg07ItemNameShort	String	Der kurze Name des VG Items der VG 07
.devices[].vg.vg07ItemNameLong	String	Der lange Name des VG Items der VG 07
.devices[].vg.vg08NameShort	String	Der kurze Name der VG 08
.devices[].vg.vg08NameLong	String	Der lange Name der VG 08
.devices[].vg.vg08ItemId	Integer	Die Id des VG Items der VG 08
.devices[].vg.vg08ItemNameShort	String	Der kurze Name des VG Items der VG 08
.devices[].vg.vg08ItemNameLong	String	Der lange Name des VG Items der VG 08
.devices[].vg.vg09NameShort	String	Der kurze Name der VG 09
.devices[].vg.vg09NameLong	String	Der lange Name der VG 09
.devices[].vg.vg09ItemId	Integer	Die Id des VG Items der VG 09
.devices[].vg.vg09ItemNameShort	String	Der kurze Name des VG Items der VG 09
.devices[].vg.vg09ItemNameLong	String	Der lange Name des VG Items der VG 09