Das CLI (Command Line Interface) Tool wurde speziell für die cioplenu Plattform zur Automatisierung und Integration in andere Systemlandschaften entwickelt.

Mit diesem können Sie die Operationen, welche auch in der GUI durchgeführt werden, "maschinengerecht" durchführen bzw. auslesen.

Das CLI-Tool kann eigenständig oder in Verbindung mit einer Skriptsprache wie Python verwendet werden, um Prozesse und wiederkehrende Aufgaben zu automatisieren bzw. unternehmensspezifische Logiken zu realisieren.

Bitte kontaktieren Sie uns über [email protected] zur Bereitstellung des CLI-Tools.

Einrichten des CLI-Tools

Um das CLI-Tool nutzen zu können sind wenige manuelle Schritte zur Einrichtung notwendig.

Nachdem Sie das Paket heruntergeladen und entpackt haben reicht es aus, die ausführbare Datei (je nach Betriebssystem) in ein Verzeichnis ihrer Wahl zu kopieren.

Der Einfachheit halber empfehlen wir ihnen den Ordnernamen in cio abzukürzen.

Das erleichtert das spätere arbeiten mit dem Tool. Alle Befehle beginnen immer mit dem Dateinamen cio gefolgt von weiteren Parametern.

Nach dem ersten Login wird zudem eine Datei .cio.yml erzeugt.

Diese beinhaltet die Login-Informationen und kann jederzeit angepasst werden.

Dateien

Ebenfalls im Zip-Verzeichnis enthalten ist eine detaillierte Dokumentation mit allen Befehlen sowie Optionen.

Einen Nutzer für das CLI-Tool anlegen und einen Token erstellen

Damit Sie sich im nächsten Schritt mit dem CLI-Tool am Server anmelden können, müssen Sie einen Nutzer anlegen und für diesen ein sog. Token (Zugangsschlüssel) generieren.

Am Nutzer muss in den Einstellungen die Checkbox App Nutzer gesetzt werden.

App Nutzer

Sobald der Nutzer als App Nutzer gespeichert wurde, erscheint in der Übersichtstabelle ein Schlüsselsymbol zum Benutzer.

CLI-Nutzer

Über diesen Schlüssel gelangen Sie in ein Fenster, indem Sie ein Token erstellen.

Zum Erstellen des Tokens klicken Sie auf das Aktualisieren-Symbol.

Da man mit Hilfe dieses Token ohne Eingabe eines Nutzernahmen oder Passworts ein Zugriff auf das System möglich ist, empfehlen wir einen Token immer zeitlich zu begrenzen. Dazu wählen Sie ein entsprechendes Ablaufdatum.

Achtung: Nach dem Ablaufdatum, müssen Sie das Token erneut erzeugen

CLI Token Erstellen

Verbindung mit dem Server herstellen

Um sich initial mit dem Server zu verbinden geben Sie cio login in die Konsole ein.

Es erscheint die Zeile URL . Kopieren Sie die URL des Servers und bestätigt mit der Enter-Taste.

Anschließend erscheint in der nächsten Zeile Token. Fügen Sie nun das kopierte Token hier ein.

Login

Abschließend gibt der Server eine Rückmeldung über Verbindung und korrekte Authentifizierung sowie die aktuelle Version der Software. Beachten Sie hierbei, dass entsprechende Portfreigaben eingerichtet sind. Für die standardmäßige, sichere HTTPS-Verbindung wird Port 443 genutzt (HTTP - Port 80).

Diese Anmeldung muss nur einmal erfolgen und bleibt solange gültig, bis das Token abgelaufen ist.

Dies bedeutet beim nächsten Aufruf der Kommandozeile muss nicht erneut cio login eingegeben werden.

Befehle ausführen

Befehle werden über den Befehl cio [Befehl] gesendet.

cio help gibt Ihnen beispielsweise eine Übersicht aller verfügbaren Befehle aus.

Hilfe

cio ping testet die Verbindung und korrekte Authentifizierung zum Server.

Ping

War diese Antwort hilfreich für Sie?