Hier sind alle Aktionen aufgelistet, die die Api bedienen kann.
Zu jeder Aktion liegen auch die gesamten Parameter und Spezifikationen vor.
Sortiert nach der letzten Änderung. Eine alphabetische Sortierung findet man im Menü.
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.
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.
Mit der Aktion deviceLazyPurge kann ein Gerät zum Löschen markiert werden. Siehe dazu auch unter Admin / LazyPurge Die benötigte Geräte Id wird dabei im actionParameter.data Block abgelegt. Wenn die Geräte Id nicht existiert, oder das Gerät online ist, wird eine entsprechende Fehlermeldung geliefert. Sollte das Gerät bereits Offline und im LazyPurge Modus sein, wird das Datum des LazyPurge neu gesetzt Permission Diese API wird durch Permission geschützt, man benötigt die DEVICE_MANAGEMENT_LAZY_PURGE Berechtigung für die API.
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.
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.
Mit der Aktion rawDataGetValues kann man Rohdaten aus dem Corvus holen. Dabei werden die Rohdaten, wie der Name schon andeutet, nicht aufbereitet, sondern werden eins zu eins übergeben. Das bedeutet, das sind die Original-Daten die Corvus von den Geräten bekommen hat. Eine Umrechnung findet nicht statt. Geliefert werden die Daten im rawdatas Block Beispiel Anfrage: { "action": "rawDataGetValues", "actionParameter": { "dataScope": "INTERFACE_TRAFFIC", "deviceId": 11, "ifIndex": 1, "minTs": 1663655228, "maxTs": 1663655528 } } Antwort :
Mit der Aktion reportDownload kann man einen Report exportieren. Diese Aktion gibt niemals ein JSON zurück, sondern immer ein Binär-Stream. Je nachdem welchen Export man wählt, kommt immer eine Datei, und niemals ein JSON. Fehlermeldungen werden als HTTP/500 Internal Server Error gekennzeichnet. Der Download wird in mehreren Methoden geteilt, die hier ausführlich beschrieben sind Methode 1 - Report Name Diese Methode eignet sich für eine Migration von den alten URLs am besten.
Mit der Aktion reportGetList kann man eine Liste von Reports aus einem System anfordern. Geliefert werden die Daten im reports Block Beispiel Anfrage: { "action": "reportGetList" } Antwort (stark verkürzt): { "action": "reportGetList", "reports": [ { "name": "20230124-day-dynamicIpPoolAgg", "year": 2023, "month": 1, "day": 24, "dateTms": "1674518400000", "timeframe": "DAY", "type": "DYNAMICIPPOOLAGG", "version": "YUNA_V1", "canExportCSV": true, "canExportXML": true }, { "name": "20230124-day-dynamicIpPoolSingle", "year": 2023, "month": 1, "day": 24, "dateTms": "1674518400000", "timeframe": "DAY", "type": "DYNAMICIPPOOLSINGLE", "version": "YUNA_V1", "canExportCSV": true, "canExportXML": true }, { "name": "20230124-day-inventoryDevices", "year": 2023, "month": 1, "day": 24, "dateTms": "1674518400000", "timeframe": "DAY", "type": "INVENTORYDEVICES", "version": "YUNA_V1", "canExportCSV": true, "canExportXML": true } ], "timingInformation": { "serverReceivedTimestampUtcMs": "1675758953164", "serverProcessingBeginTimestampUtcMs": "1675758953232", "serverProcessingEndTimestampUtcMs": "1675758953353" } } Parameter Man kann die Ausgabe durch Parameter beeinflussen, entweder man kann sie erweitern oder verringern.
Mit der Aktion sysdepGetList kann man eine Liste von Sysdeps anfordern. Geliefert werden die Daten im sysdeps Block Beispiel Anfrage: { "action": "sysdepGetList" } Antwort (stark gekürzt): { "action": "sysdepGetList", "sysdeps": [ { "id": "232646", "deviceId": 11, "deviceTypeId": 6, "key": "UCD_DISKIO", "userData01": "9", "userData02": "sda", "createdUtcMs": "1565717381000", "lastUpdateUtcMs": "1659486567000" }, { "id": "232647", "deviceId": 11, "deviceTypeId": 6, "key": "UCD_DISKIO", "userData01": "10", "userData02": "sda1", "createdUtcMs": "1565717381000", "lastUpdateUtcMs": "1659486567000" }, { "id": "975350891", "deviceId": 11, "deviceTypeId": 6, "key": "HR_STORAGE", "userData01": "/run/lock", "userData02": "Fixed Disk", "userData03": ".
Die Aktion test tut effektiv vorerst noch nichts. Und wird vermutlich demnächst wieder entfernt. Parameter Keine Datenfelder Keine Eigenarten Keine Beispiele Erfolgreiche Test Aktion Gesendet: { "action": "test" } Empfangen: { "action": "test" }
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 .
Corvus Help - 28.February 2026 03:33:38 UTC - Commit 667ccc2e