Befehlsmodi der Kommandozeilenschnittstelle

Viele CLI-Kommandos können Sie sowohl im interaktiven Modus als auch im Skriptmodus ausführen.

Einige Kommandos können Sie auch im Offline-Modus ausführen, d.h., Sie müssen sich nicht an der Process Engine anmelden, um diese Kommandos auszuführen.

Den Cache-Modus sollten Sie nur in absoluten Ausnahmefällen und nach Rücksprache mit dem Support der Virtimo AG nutzen.

Interaktiver CLI-Modus

Die meisten CLI-Kommandos können im interaktiven Modus ausgeführt werden. Dazu müssen Sie das CLI mit einer (Administrator-) Benutzerkennung starten.

Aufruf

Wechseln Sie in eines der folgenden Verzeichnisse:

<inubit-installdir>/server/process_engine/bin
<inubit-installdir>/client/bin/

Starten Sie das CLI:
```
startcli{.bat|.sh} [-u <user>] [-p <password>] [Option(en)] [Process-Engine-URL]
```
Die Groß- und Kleinschreibung wird beim Eingeben des Benutzernamens nicht beachtet.

Process-Engine-URL

URL der Process Engine, mit der sich das CLI verbinden soll: https://<server>:<port>/ibis/servlet/IBISSoapServlet
Wenn Sie kein Passwort angeben, werden Sie nach dem Start des Programms zur Eingabe des Passworts aufgefordert.
Nach der Eingabe des Passworts erscheint der CLI-Prompt.

Liste der Kommandos, Optionen und der Hilfe dazu anzeigen

Wenn Sie das Skript startcli.bat|[sh] mit der Option -h oder ohne irgendeine Option aufrufen, wird eine Liste der verfügbaren Kommandos, deren Optionen und die Hilfe angezeigt.

startcli
usage: CLI [OPTIONS] [Url]
Opens a shell to the INUBIT Process Engine.
 -a                                      List IPv4 addresses for local
                                         host
    --backupFile <arg>                   Output file for backup
    --backupRepository                   Backup the whole repository
 -c,--check                              Check if the INUBIT server is
                                         alive
...

Liste der verfügbaren Kommandos nach dem Start anzeigen

Durch Drücken der Tabulatortaste werden alle verfügbaren Kommandos angezeigt.

Hilfe zu einem Kommando

Mit <command> --help rufen Sie die Hilfe/Usage zu dem angegebenen Kommando auf.

Kommandoaufruf

<command> <options> <arguments>

Beispiel

library --upload --type plugin /tmp/example.jar

Skriptmodus des CLI

Die meisten Kommandos können Sie im Skriptmodus ausführen. Dazu müssen Sie für die meisten Kommandos das Kommando --execCommand nutzen.

Aufruf

Wechseln Sie in eines der folgenden Verzeichnisse:
<inubit-installdir>/server/process_engine/bin
<inubit-installdir>/client/bin/

Starten Sie das CLI:
startcli{.bat|.sh} [-u <user>] [-p <password>] --execCommand "[Option(en)] [Argument(e)]" [Process-Engine-URL]

Die Groß- und Kleinschreibung wird beim Login via CLI nicht beachtet.

Process-Engine-URL

URL der Process Engine, mit der sich das CLI verbinden soll: https://<server>:<port>/ibis/servlet/IBISSoapServlet

Wenn Sie keinen Benutzer angeben, wird root verwendet.

Wenn Sie kein Passwort angeben, werden Sie nach dem Start des Programms zur Eingabe des Passworts aufgefordert.

Wenn Sie keine URL angeben, wird https://<server>:<port>/ibis/servlet/IBISSoapServlet verwendet.

Wenn Sie das CLI ohne Parameter/Option starten, wird die Hilfe angezeigt.

Beispiel

startcli.sh --execCommand "library --upload `‑‑`type plugin /tmp/example.jar"

Das eigentliche Kommando muss in doppelte Anführungszeichen eingeschlossen sein.

Cache-Modus des CLI

Die Kommandos des Cache-Modus dienen dem direkten Zugriff auf die im Cache abgelegte Konfiguration. Diese Kommandos sind nur für interne Zwecke und zur Diagnose gedacht.

Die falsche Verwendung der Cache-Kommandos kann dazu führen, dass die komplette Serverkonfiguration zerstört ist und dass die Daten der Process Engine nicht mehr erreichbar sind! Die einzelnen Kommandos und deren Optionen können sich ohne Ankündigung ändern. Die Benutzung dieser Kommandos kann zum Verlust der Gewährleistung führen.