vgGetList

Mit der Aktion vgGetList kann man eine Liste von allen virtuellen Gruppen (VG) anfordern.

Geliefert werden die Daten im vg Block

Beispiel

Anfrage:

{
	"action": "vgGetList"
}

Antwort:

{
	"action": "vgGetList",
	"vg": {
		"vg01NameShort": "B",
		"vg01NameLong": "Bereich",
		"vg02NameShort": "R",
		"vg02NameLong": "Region",
		"vg03NameShort": "M",
		"vg03NameLong": "Metro"
	}
}

Parameter

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

Parameter Name Datentyp Default Beschreibung
.actionParameter.includeVgItems Boolean false Gibt die Items der Gruppe mit aus
.actionParameter.countDevices Boolean false Gibt die Anzahl der Geräte in dem Item aus. Es muss zusätzlich .actionParameter.includeVgItems gesetzt ist
.actionParameter.includeDevices Boolean false Gibt die Liste der Geräte in dem Item aus. Es muss zusätzlich .actionParameter.includeVgItems gesetzt ist

Der Parameter includeDevices und countDevices ist konstruktionsbedingt abhängig von includeVgItems.

Beispiel mit 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": "vgGetList",
	"actionParameter": {
		"countDevices": true,
		"includeVgItems": true
	}
}

Antwort (sehr stark gekürzt):

{
	"action": "vgGetList",
	"actionParameter": {
		"countDevices": true,
		"includeVgItems": true
	},
	"vg": {
		"vg02NameShort": "R",
		"vg02NameLong": "Region",
		"vg02Items": [
			{
				"id": 62,
				"nameShort": "M",
				"nameLong": "Mitte",
				"countDevices": 14
			},
			{
				"id": 70,
				"nameShort": "N",
				"nameLong": "Nord",
				"countDevices": 16
			},
			{
				"id": 74,
				"nameShort": "O",
				"nameLong": "Ost",
				"countDevices": 12
			},
			{
				"id": 82,
				"nameShort": "W",
				"nameLong": "West",
				"countDevices": 10
			},
			{
				"id": 86,
				"nameShort": "S",
				"nameLong": "Süd",
				"countDevices": 18
			}
		]
	}
}

Antwort Datenfelder

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

Parameter Name Datentyp Beschreibung
.vg Record Liste aller gefundenen VGs
.vg.vg01NameShort String Der kurze Name der VG 01
.vg.vg01NameLong String Der lange Name der VG 01
.vg.vg01Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg02NameShort String Der kurze Name der VG 02
.vg.vg02NameLong String Der lange Name der VG 02
.vg.vg02Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg03NameShort String Der kurze Name der VG 03
.vg.vg03NameLong String Der lange Name der VG 03
.vg.vg03Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg04NameShort String Der kurze Name der VG 04
.vg.vg04NameLong String Der lange Name der VG 04
.vg.vg04Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg05NameShort String Der kurze Name der VG 05
.vg.vg05NameLong String Der lange Name der VG 05
.vg.vg05Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg06NameShort String Der kurze Name der VG 06
.vg.vg06NameLong String Der lange Name der VG 06
.vg.vg06Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg07NameShort String Der kurze Name der VG 07
.vg.vg07NameLong String Der lange Name der VG 07
.vg.vg07Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg08NameShort String Der kurze Name der VG 08
.vg.vg08NameLong String Der lange Name der VG 08
.vg.vg08Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg09NameShort String Der kurze Name der VG 09
.vg.vg09NameLong String Der lange Name der VG 09
.vg.vg09Items Liste Die Liste der VG Items, sofern .actionParameter.includeVgItems gesetzt ist. Siehe weiter unten
.vg.vg??Items{}.id Integer Die ID des VG Items
.vg.vg??Items{}.nameShort String Der kurze Name des VG Items
.vg.vg??Items{}.nameLong String Der lange Name des VG Items
.vg.vg??Items{}.countDevices Integer Die Anzahl der Gerät in dem VG Item, wenn .actionParameter.countDevices gesetzt ist
.vg.vg??Items{}.devices Liste Liste aller gefundenen Geräte mit deren Informationen, sofern .actionParameter.includeDevices gesetzt wurde
.vg.vg??Items{}.devices[].id Integer Die interne ID des Gerätes
.vg.vg??Items{}.devices[].name String Der Name des Gerätes
.vg.vg??Items{}.devices[].ip String Die IP oder der Hostname des Gerätes
.vg.vg??Items{}.devices[].isDeactivated Boolean Wird auf true gesetzt, wenn das Gerät vom Administrator deaktiviert wurde
.vg.vg??Items{}.devices[].isOffline Boolean Wird auf true gesetzt, wenn das Gerät als Offline markiert wurde
.vg.vg??Items{}.devices[].isOfflineSinceUtcMs Long Der Zeitstempel ab wann das Gerät als Offline gilt, sofern es Offline ist

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