Mit ROQSTAR OpenAPI Aufgaben im IP-Netzwerk automatisieren

Eine typische Umgebung

Ein Verkehrsbetrieb digitalisiert seine Fahrzeuge. Die Flotte besteht aus über 100 Fahrzeugen, darunter Solobusse, Gelenkbusse und Trams. Jedes Fahrzeug wird mit einem kontaktlosem Bezahlsystem, digitalen Entwertern und Kameras ausgestattet. Auch ein Fahrgastzählsystem und ein Fahrgastinformationssystem werden in jedem Fahrzeug installiert. Die Komponenten sind gleich, können sich jedoch in ihrer Anzahl unterscheiden. So z. B. benötigt ein Gelenkbus mehr Komponenten als ein Solobus.

Die Datenübertragung erfolgt über die Ethernet-Technologie. Dafür werden alle Geräte über Ethernet Switches zu einem Netzwerk verbunden. Die Komponenten werden im Fahrzeug installiert, verkabelt und in Betrieb genommen. Nach der Inbetriebnahme können alle Komponenten über IP adressiert werden. Die Systeme sind „online“ und können innerhalb des Netzwerks miteinander kommunizieren. Die initiale Konfiguration ist somit abgeschlossen.

Automatisierung von Management-Aufgaben mit maximaler Flexibilität

Die Nutzung einer API bietet eine leistungsstarke Methode zur Steigerung der Produktivität da, wo ROQSTAR Ethernet Switches im Einsatz sind. Die API-Technologie ermöglicht die Maschine-zu-Maschine-Kommunikation. Darauf basierend kann eine Großzahl an Aufgaben durch ein Programm/Dienst ausgeführt werden. Die Ausführung der Aufgaben hängt vollkommen von der Programmierung ab: autark, zeitlich begrenzt oder durch eine bestimmte Interaktion bzw. Verfügbarkeit getriggert. Eine Anpassung von Aufgaben oder deren Ausführung ist jederzeit möglich.

Die Automatisierung kann im Backend-Dienst erfolgen oder wird als einfacher (stand-alone) Skript ausgeführt. Auf diese Art und Weise können wiederkehrende Aufgaben und deren Abarbeitung beschleunigt und vereinfacht werden. Praxisnahe Beispiele hierzu sind:

• Überprüfung ob die Ethernet Switches eine aktuelle Software-Revision haben
• Überprüfung der Einstellungen im Ethernet Switch
• Auswahl der Ethernet Switches, deren Einstellungen aktualisiert werden sollen
• Auswahl von Fahrzeugen deren Netzwerkeinstellungen geändert werden sollen
• Deployment von Konfiguration oder Software Update von mehreren Ethernet Switches
• Austausch von Konfigurationsdateien
• Scheduling von Wartungsaufgaben im Fahrzeugflottennetzwerk

Beispiel aus der Praxis: Automatisierte Konfigurationsänderung

Aufgabenstellung
Das Netzwerk in der Fahrzeugflotte soll eine neue Konfiguration erhalten, denn es sollen neue Entwerter in Betrieb gehen. Dafür muss ein weiterer Port am Ethernet Switch aktiviert und die DHCP-Einstellungen erweitert werden. Die Aufgabe soll automatisch über ein Update-Dienst erfolgen, sobald das Fahrzeug über das Betriebshofsnetzwerk erreichbar ist.

Vorbereitung
Alle Ethernet Switches sind über das Betriebshofsnetzwerk über ihre eindeutige IP-Adresse erreichbar. Die Zuordnung der Konfiguration zum Ethernet Switch erfolgt ebenfalls über die IP-Adresse. Die IP-Adresse ist so gewählt, dass sie einer Fahrzeugnummer zugeordnet ist. Zur Änderung der Konfiguration werden neue Konfigurationsdateien im Vorfeld erstellt.

Umsetzung
Es wird ein Skript programmiert, welcher die untenstehenden Operationen über API ausführt. Das Skript schreibt die Ereignisse für jede Operation in eine Logdatei. Dort kann der Status überprüft werden. Außerdem wird ein Scheduler eingestellt, sodass das Skript für drei Wochen in einer Schleife durchläuft. In dieser Zeit sollen alle Fahrzeuge mindestens einmal im Betriebshof gewesen sein.

Skript Operationen:
1) Führe ein Ping zu einer IP-Adresse aus dem Fahrzeug-IP-Pool aus.
2) Falls Ping erfolgreich, Abrufen von Status und bestehender Konfiguration.
3) Falls die Konfiguration mit Soll nicht übereinstimmt, führe ein Konfigurationsupdate durch.
4) Erneutes Abrufen vom Status.
5) Springe zu nächster IP-Adresse.

Erstellung von Skripten ist einfach dank OpenAPI

Die OpenAPI-Spezifikation ist ein Format, das die Struktur und Syntax für die API-Dienste (REST) – in diesem Fall die gerätseitige Schnittstelle – festlegt. Der große Vorteil von OpenAPI liegt in der Dokumentation. Diese wird automatisiert generiert, so dass sie stets mit Code, Struktur und Parametern synchronisiert ist.

Eine veraltete oder fehlende Dokumentation ist durch OpenAPI ausgeschlossen, da die OpenAPI-Definitionsdatei selbst die API-Dokumentation ist. Außerdem liegt die gesamte API-Spezifikation in einem einzigen Format vor, das mehrere Tools, einschließlich des Dokumentationsgenerators, automatisch verarbeiten können. Die YAML-Datei, in der die OpenAPI-Definitionsdatei beschrieben ist, ist einfach zu lesen und zu ändern.

Durch vorhandene Tools kann auch der Code für die API automatisch generiert werden. Der Code für die Client-Anwendung kann dabei in einer Reihe von Sprachen generiert werden. Eine geräteseitige Ausführung ist davon unabhängig.