Corvus Hilfe > Api > Yuna > Aktionen > deviceTypeGetList

deviceTypeGetList

Mit der Aktion deviceTypeGetList kann man eine Liste von Gerätetypen anfordern.

Man kann die Liste einschränken, und man kann auch gleichzeitig alle Gerät die innerhalb dieses Gerätetyps zugeordnet sind anfordern.

Geliefert werden die Daten im deviceTypes Block

Beispiel

Anfrage:

{
	"action": "deviceTypeGetList"
}

Antwort:

{
	"action": "deviceTypeGetList",
	"deviceTypes": [
		{
			"id": 6,
			"name": "UNIX CorvusCore",
			"description": "UNIX mit CorvusCore und NET-SNMP"
		},
		{
			"id": 16,
			"name": "WS-C6509-E ",
			"description": "Cisco Catalyst Switch C6509"
		},
		{
			"id": 21,
			"name": "Cisco Nexus 5xxx",
			"description": "Cisco Nexus 5xxx Switch"
		},
		{
			"id": 32,
			"name": "C3640",
			"description": "Cisco 3640"
		},
		{
			"id": 38,
			"name": "F5 BigIP",
			"description": "Foundry BigIP"
		},
		{
			"id": 90,
			"name": "UNIX Net-Snmp",
			"description": "Regular Unix mit Net-SNMP"
		}
	]
}

Parameter

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

Parameter Name	Datentyp	Default	Beschreibung
.actionParameter.filterDeviceTypeIdByIds	Liste von Integer	[]	Eine Liste von IDs die ausgegeben werden soll
.actionParameter.countDevices	Boolean	false	Liefert die Anzahl der eingetragenen Geräte
.actionParameter.includeDevices	Boolean	false	Liefert zusätzlich die Geräteliste für jeden Gerätetyp

Beispiel .actionParameter.filterDeviceTypeIdByIds

Man kann eine Liste von IDs angeben, und nur diese Gerätetypen werden ausgegeben. Sofern die Gerätetypen IDs existieren. Damit kann man, wenn man die Gerätetype ID kennt, die Liste einschränken. Das kann insbesondere in Kombination mit .actionParameter.includeDevices hilfreich sein

Anfrage:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"filterDeviceTypeIdByIds": [
			6,
			90,
			312
		]
	}
}

Antwort:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"filterDeviceTypeIdByIds": [
			6,
			90,
			312
		]
	},
	"deviceTypes": [
		{
			"id": 6,
			"name": "UNIX CorvusCore",
			"description": "UNIX mit CorvusCore und NET-SNMP"
		},
		{
			"id": 90,
			"name": "UNIX Net-Snmp",
			"description": "Regular Unix mit Net-SNMP"
		}
	]
}

Beispiel .actionParameter.countDevices

Damit wird die Anzahl der Geräte innerhalb des Gerätetyps mit ausgegeben. Dabei werden alle Geräte gezählt, der Zustand eines Gerätes wird dabei ignoriert.

In der Antwort wird dann countDevices mit angegeben, fehlt das Feld, dann bedeutet das, dass der Default Wert von 0 (null) gilt, bedeutet das dieser Gerätetyp leer ist und keine Geräte beinhaltet.

Anfrage:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"countDevices": true
	}
}

Antwort:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"countDevices": true
	},
	"deviceTypes": [
		{
			"id": 6,
			"name": "UNIX CorvusCore",
			"description": "UNIX mit CorvusCore und NET-SNMP",
			"countDevices": 6
		},
		{
			"id": 32,
			"name": "C3640",
			"description": "Cisco 3640",
			"countDevices": 138
		},
		{
			"id": 38,
			"name": "F5 BigIP",
			"description": "Foundry BigIP"
		},
		{
			"id": 90,
			"name": "UNIX Net-Snmp",
			"description": "Regular Unix mit Net-SNMP",
			"countDevices": 2
		}
	]
}

Beispiel .actionParameter.includeDevices

Wird dieses Flag gesetzt, beinhaltet die Liste der Gerätetypen pro Eintrag zusätzlich noch eine Liste von den Geräten, die innerhalb des Gerätetyps zu finden sind.

Anfrage:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"countDevices": true,
		"includeDevices": true
	}
}

Antwort:

{
	"action": "deviceTypeGetList",
	"actionParameter": {
		"countDevices": true,
		"includeDevices": true
	},
	"deviceTypes": [
		{
			"id": 6,
			"name": "UNIX CorvusCore",
			"description": "UNIX mit CorvusCore und NET-SNMP",
			"countDevices": 6,
			"devices": [
				{
					"id": 11,
					"name": "corvus Frankfurt",
					"ip": "10.10.10.11"
				},
				{
					"id": 12,
					"name": "corvus Mainz",
					"ip": "10.10.10.21"
				},
				{
					"id": 16,
					"name": "corvus Bielefeld",
					"ip": "10.10.10.31",
					"isDeactivated": true
				},
				{
					"id": 17,
					"name": "corvus Nürnberg",
					"ip": "10.10.10.41"
				},
				{
					"id": 22,
					"name": "corvus Hamburg",
					"ip": "10.10.10.51"
				},
				{
					"id": 34818,
					"name": "corvus Berlin",
					"ip": "10.10.10.61",
					"isOffline": true,
					"isOfflineSinceUtcMs": "1658213272000"
				}
			]
		}
	]
}

Antwort Datenfelder

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

Parameter Name	Datentyp	Beschreibung
.deviceTypes	Liste	Liste aller gefundenen Gerätetypen und deren Informationen
.deviceTypes[].id	Integer	Die interne ID des Gerätetyps
.deviceTypes[].name	String	Der Name des Gerätetyps
.deviceTypes[].description	String	Die Beschreibung des Gerätetyps
.deviceTypes[].countDevices	Integer	Die Anzahl der Geräte in diesem Gerätetyp, sofern .actionParameter.countDevices gesetzt wurde
.deviceTypes[].devices	Liste	Liste aller gefundenen Geräte mit deren Informationen, sofern .actionParameter.includeDevices gesetzt wurde
.deviceTypes[].devices[].id	Integer	Die interne ID des Gerätes
.deviceTypes[].devices[].name	String	Der Name des Gerätes
.deviceTypes[].devices[].ip	String	Die IP oder der Hostname des Gerätes
.deviceTypes[].devices[].isDeactivated	Boolean	Wird auf true gesetzt, wenn das Gerät vom Administrator deaktiviert wurde
.deviceTypes[].devices[].isOffline	Boolean	Wird auf true gesetzt, wenn das Gerät als Offline markiert wurde
.deviceTypes[].devices[].isOfflineSinceUtcMs	Long	Der Zeitstempel ab wann das Gerät als Offline gilt, sofern es Offline ist