deviceAdd

Mit der Aktion deviceAdd kann man ein Gerät dem System hinzufügen.

Dabei werden die Daten im actionParameter.data Block abgelegt, mal davon abgesehen, dass die Daten korrekt sein sollten, werden die folgenden Prüfungen stattfinden:

  • Der Geräte Name muss einzigartig sein, und darf nicht schon existieren
  • Der Geräte Typ muss angegeben werden, und er muss valide sein
  • Die SNMP Daten müssen korrekt sein
  • Das Gerät muss bereit sein, es wird getestet beim Eintragen

Werden die Bedingungen nicht erfüllt, wird das Gerät nicht eingetragen und eine Fehlermeldung wird ausgegeben.

Sind alle Bedingungen erfüllt, wird das neue Gerät im devices Block, das ist der gleiche Block wie bei deviceGetList, zurückgegeben mit den Basis eigenschaften. Dort ist dann auch die neue ID zu sehen.

Permission

Diese API wird durch Permission geschützt, man benötigt die DEVICE_MANAGEMENT_ADD Berechtigung für die API. Ansonsten bekommt man eine Permission Denied Fehlermeldung zurück.

Beispiel

Anfrage:

{
	"action": "deviceAdd",
	"actionParameter": {
		"data": {
			"deviceName": "MyNewDevice",
			"deviceTypeId": 29,
			"vg01Id": 89,
			"snmpIp": "127.0.0.1",
			"snmpPort": 161,
			"snmpVersion": "2c",
			"snmpV2Community": "public"
		}
	}
}

Positive Antwort:

{
	"action": "deviceGetList",
	"actionParameter": {
		"data": {
			"deviceName": "MyNewDevice",
			"deviceTypeId": 29,
			"vg01Id": 89,
			"snmpIp": "127.0.0.1",
			"snmpPort": 161,
			"snmpVersion": "2c"
		}
	},
	"devices": [
		{
			"id": 4711,
			"name": "MyNewDevice",
			"ip": "127.0.0.1"
		}
	]
}

Parameter

Der data Block beinhaltet die Daten, für das neue Gerät

Parameter Name Datentyp Default Beschreibung
.actionParameter.data.deviceName String - Der Geräte Name, der muss einzigartig sein
.actionParameter.data.deviceTypeId Integer - Die ID des Gerätetyps. Der muss angegeben werden
.actionParameter.data.vg01Id Integer - Die ID des Items aus der virtuellen Gruppe 01, der Wert ist Optional
.actionParameter.data.vg02Id Integer - Die ID des Items aus der virtuellen Gruppe 02, der Wert ist Optional
.actionParameter.data.vg03Id Integer - Die ID des Items aus der virtuellen Gruppe 03, der Wert ist Optional
.actionParameter.data.vg04Id Integer - Die ID des Items aus der virtuellen Gruppe 04, der Wert ist Optional
.actionParameter.data.vg05Id Integer - Die ID des Items aus der virtuellen Gruppe 05, der Wert ist Optional
.actionParameter.data.vg06Id Integer - Die ID des Items aus der virtuellen Gruppe 06, der Wert ist Optional
.actionParameter.data.vg07Id Integer - Die ID des Items aus der virtuellen Gruppe 07, der Wert ist Optional
.actionParameter.data.vg08Id Integer - Die ID des Items aus der virtuellen Gruppe 08, der Wert ist Optional
.actionParameter.data.vg09Id Integer - Die ID des Items aus der virtuellen Gruppe 09, der Wert ist Optional
.actionParameter.data.snmpIp String - Die IP (IPv4 oder IPv6, Hostname geht auch, sollte aber nicht benutzt werden) des Gerätes für SNMP. Der Wert muss angegeben werden
.actionParameter.data.snmpPort Integer - Der SNMP Port. Der Wert muss angegeben werden
.actionParameter.data.snmpVersion String - Die SNMP Version, muss entweder 2c oder 3 sein
.actionParameter.data.snmpV2Community String - Wind SNMP Version 2c verwendet, muss die Community angegeben werden
.actionParameter.data.snmpV3SecurityName String - Wird SNMP Version 3 verwendet, muss der SecurityName angegeben werden
.actionParameter.data.snmpV3SecurityLevel String - Wird SNMP Version 3 verwendet, muss der Level angegeben werden, das kann noAuthNoPriv oder authNoPriv oder authPriv sein
.actionParameter.data.snmpV3AuthenticationProtocol String - Wird SNMP Version 3 und der Level authNoPriv oder authPriv verwendet, muss das Protokoll angegeben werden, das kann MD5 oder SHA sein
.actionParameter.data.snmpV3AuthenticationPassphrase String - Wird SNMP Version 3 und der Level authNoPriv oder authPriv verwendet, muss das Password angegeben werden
.actionParameter.data.snmpV3PrivacyProtocol String - Wird SNMP Version 3 und der Level authPriv verwendet, muss das Protokoll angegeben werden, dass kann AES oder DES sein
.actionParameter.data.snmpV3PrivacyPassphrase String - Wird SNMP Version 3 und der Level authPriv verwendet, muss das Password angegeben werden

Antwort Datenfelder

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

Parameter Name Datentyp Beschreibung
.devices Liste Liste aller neuen Geräte (also nur das eine) mit 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

Der Block fehlt bei einem Fehler und es gelten die generischen Fehlermeldungen

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