(12.01-de) IGEL UMS Administrator Kommandozeilenschnittstelle

Die UMS Administrator Kommandozeilenschnittstelle ermöglicht es Ihnen, den IGEL UMS Administrator über ein Terminal zu steuern und Aktionen des UMS Administrator über Skripte zu automatisieren. Zu diesen Aktionen gehören das Erstellen und Bearbeiten von Datenbankverbindungen für den UMS-Server, das Sichern und Wiederherstellen der eingebetteten Datenbank, die Konfiguration von Kommunikationsports und Security, die Verwaltung der UMS-ID, die Konfiguration des Superusers und der Neustart des UMS-Servers.

Da diese Funktion eine vollständige Steuerung ohne grafische Desktop-Umgebung ermöglicht, kann die CLI-Anwendung auch auf Headless-Linux-Systemen ausgeführt werden.

Grundlegende Verwendung

Wie die grafische Anwendung des UMS Administrator erfordert auch die CLI erweiterte Rechte.

Windows: Öffnen Sie eine Eingabeaufforderung (cmd.exe) als Administrator.

Linux: Werden Sie root oder verwenden Sie sudo

Sie können das Hauptkommando umsadmin-cli von jedem Verzeichnis aus ausführen, da der Befehl auf dem PATH verfügbar ist.

Um die globalen Optionen und die primären Unterkommandos zu sehen, geben Sie umsadmin-cli ein.

Um alle möglichen Optionen für einen bestimmten Unterbefehl zu erhalten, geben Sie umsadmin-cli gefolgt von dem Unterbefehl ein, z.B. umsadmin-cli db create

Um die komplette Online-Hilfe mit allen Befehlen zu erhalten, geben Sie umsadmin-cli fullhelp ein.

Bestimmte Unterbefehle haben keine Optionen und werden sofort ausgeführt. Bitte beachten Sie die Kommandoreferenz.

Globale Optionen

Wenn Sie die UMS Administrator CLI in einem Skript verwenden wollen, sollten Sie die Ausgabe nach stdout/stderr konfigurieren. Dies erleichtert die Weiterverarbeitung der Ausgabe von umsadmin-cli und die Extraktion aller relevanten Daten.

Bitte beachten Sie die unten aufgeführten Optionen.

--machine-readable

Maschinenlesbare Ausgabe mit einem Semikolon (;) als Standardtrennzeichen.

Beispiel:

root@machine:/home/locadmin# umsadmin-cli --machine-readable db list
ACTIVE;DATABASE;HOST;USER;DB-TYPE;ID
true;rmdb;localhost;root;Embedded DB;1

--no-header

Es wird keine Header-Zeile ausgegeben. Nicht alle Kommandos geben eine Header-Zeile aus.)

Beispiel:

root@machine:/home/locadmin# umsadmin-cli --machine-readable --no-header db list
true;rmdb;localhost;root;Embedded DB;1

--quiet

Alle Ausgaben in stdout/stderr werden für einige Befehle unterdrückt, deren Ausführung lange dauern kann. Dies sind z. B. db backup, db restore, db copy und server-restart.

Beispiel:

root@machine:/home/locadmin# umsadmin-cli --quiet db backup -o /tmp/mybackup02.pbak --full root@machine:/home/locadmin#

Es ist wetierhin möglich, alle Ausgaben mit Betriebssystemfunktionen auf das Null-Device umzuleiten. Um zum Beispiel unter Linux die Standard- und Fehlerausgabe auf das Null-Device umzuleiten, verwenden Sie:

command … >/dev/null 2>&1

--separator

Definiert ein benutzerdefiniertes Spaltentrennzeichen für die Ausgabe in stdout/stderr.

Beispiel:

root@machine:/home/locadmin# umsadmin-cli --machine-readable --no-header --separator "||" db list
true||rmdb||localhost||root||Embedded DB||1

Einige Trennzeichen, wie z. B. das Pipe-Symbol (|), müssen in Anführungszeichen gesetzt werden, da sie in Terminals besondere Funktionen haben.

Exit-Codes

Exit-Code	Bedeutung
0	Erfolgreiche Ausführung
1	Interner Fehler. Eine Fehlernummer wird auf stderr ausgegeben; für Details, siehe Fehlernummern.
2	Falsche Verwendung der CLI oder ungültige Argumente

Kommandoreferenz

Allgemeine Verwendung der Passwortoptionen

Einige Befehle erfordern ein Passwort. Die Eingabe des Passworts im Klartext auf der Befehlszeile ist nicht sicher und daher nicht möglich. Daher muss eine der folgenden Passwortoptionen verwendet werden:

--password:in zur interaktiven Eingabe des Passworts (eventuell mit Bestätigung)

--password:file <FILE> für die Bereitstellung einer Datei, die das Passwort enthält

Eine Passwortdatei muss das Passwort in der ersten Zeile enthalten, und die Passwörter dürfen nicht aus reinen Leerzeichen bestehen. Zusätzliche Zeilen mit Inhalt sind erlaubt, werden aber nicht ausgewertet.

Neustart des UMS Servers erforderlich

Die meisten der Befehle in den Abschnitten "Ports", "Cipher", "Reset Certificates" und "Superuser" ändern die UMS-Konfiguration und ein Neustart des UMS-Servers ist erforderlich, damit die neuen Einstellungen wirksam werden. Dies kann auf zwei Arten geschehen:

Verwenden Sie die entsprechende Funktion des Betriebssystems (z. B. systemctl unter Linux)
Verwenden Sie das Kommando umsadmin-cli server restart

Datenbank

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Werttyp	Beschreibung der Option	Anmerkungen
Alle konfigurierten Datenquellen auflisten	`db`	`list`					Zeigt die ID der Datenquelle an, die von anderen Kommandos benötigt wird. Die niedrigste ID ist 1. Die IDs können sich bei der Erstellung und Löschung von Datenquellen ändern.. Es wird dringend empfohlen, die ID immer zu extrahieren, bevor sie in anderen Befehlen mit `--id` verwendet wird Die ID wird wie folgt berechnet: höchste vorhandene ID + 1
Alle Details einer Datenbank anzeigen	`db`	`show`	`-i`	`--id`	integer	Die ID der anzuzeigenden Datenbank	Führen Sie `umsadmin-cli db list` aus, um eine Liste der aktuellen Datenquellen zu erhalten und wählen Sie die ID einer Datenquelle aus. Führen Sie `umsadmin-cli db show --id <ID>` mit dieser ID aus.
Erstellen Sie eine neue Datenbankverbindung	`db`	`create`	`-t`	`--type`	string	Der Datenbanktyp. Für eine Liste der möglichen Werte, geben Sie `umsadmin-cli db create` ein.	Typ, Benutzer und Port sind erforderlich. Andere Optionen können je nach DB-Typ erforderlich sein oder nicht `db create` aktiviert die Datenbank standardmäßig; dies kann durch die Verwendung von `-A` oder `--no-activate` verhindert werden. Eine Passwortoption kann dann nicht verwendet werden. Wenn die Aktivierung fehlschlägt, ist der Datenquelleneintrag noch vorhanden und nicht aktiv (gleiches Verhalten wie im grafischen UMS Administrator). 'rmdb' ist ein reservierter Name für den eingebetteten Datenbanktyp und kann nicht für andere Typen verwendet werden.
			`-H`	`--host`	string	Datenbank-Host
			`-d`	`--domain`	string	Datenbank-Domäne
			`-p`	`--port`	integer	Datenbank-Port
			`-u`	`--user`	string	Benutzer für die Datenbank
			`-S`	`--schema`	string	Schema der Datenbank
			`-n`	`--name`	string	Name der Datenbank. Freier Text, außer 'rmdb'; dieser Name ist für die eingebettete Datenbank reserviert.
			`-I`	`--instance`	string	Name der Datenbankinstanz
			`-A`	`--no-activate`		Die Datenbank wird nicht aktiviert.
				`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
				`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
Bearbeiten einer Datenquelle	`db`	`edit`	`-t`	`--type`	string	Datenbanktyp. Für eine Liste der möglichen Werte geben Sie `umsadmin-cli db create` ein.	Embedded-Datenbanken können nicht bearbeitet werden (wie im grafischen UMS Administrator). Alle Optionen außer `--id` sind optional.
			`-H`	`--host`	string	Datenbank-Host
			`-d`	`--domain`	string	Datenbank-Domäne
			`-i`	`--id`	integer	ID der zu bearbeitenden Datenbank
			`-I`	`--instance`	string	Name der Datenbankinstanz
				`--jdbc-params`	string	Zusätzlicher JDBC-Parameter	Einzelheiten zu den JDBC-Parametern finden Sie unter (12.01-de) Wie kann ich eine Datenquelle im IGEL UMS Administrator einrichten? Beispiele: `rmadmin\umsadmin-cli.exe db create --type=mssql --name=rmdb12_00 --host=122.30.229.1 --port=1433 --user=rmdb --password:in --jdbc-params sendStringParametersAsUnicode=false;` `rmadmin/umsadmin-cli.bin db edit -i 1 --jdbc-params sendStringParametersAsUnicode=false;`
			`-n`	`--name`	string	Der Name der Datenbank. Freier Text, außer 'rmdb'; dieser Name ist für die Embedded-Datenbank reserviert.
			`-p`	`--port`	integer	Datenbank-Port
			`-S`	`--schema`	string	Schema der Datenbank
			`-u`	`--user`	string	Benutzer für die Datenbank
Datenbankverbindung aktivieren	`db`	`activate`		`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird. Biespiel: `umsadmin-cli db activate --password:file /home/ike/password.txt`
				`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
			`-i`	`--id`	integer	ID der zu aktivierenden Datenbank
Aktive Datenbankverbindung aktivieren	`db`	`deactivate`	`-i`	`--id`	integer	ID der zu deaktivierenden Datenbank
Aktive Datenbankverbindung testen	`db`	`test`		`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird. Beispiel: `umsadmin-cli db test --password:file /home/ike/password.txt`
Aktive Datenbankverbindung testen	`db`	`test`		`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
Aktive Datenbank optimieren	`db`	`optimize`					Dieser Befehl kann nur auf eine Embedded-Datenbank oder eine Derby-Datenbank angewendet werden.
Kopie der aktuellen Datenbank anlegen	`db`	`copy`	`-t`	`--target`	integer	ID der Ziel-Datenbank Um die Datenbank-ID zu erhalten, geben Sie `umsadmin-cli db list` ein
				`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
				`--password:in`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
Datenbankverbindung löschen	`db`	`delete`	`-i`	`--id`	integer	ID der Datenbankverbindung, die gelöscht werden soll
Sicherungskopie der aktuellen Embedded-Datenbank erstellen	`db`	`backup`	`-o`	`--outfile`		Pfad zur Zieldatei. Die Dateiendung `.pbak` wird automatisch hinzugefügt. Vorhandene Sicherungsdateien werden nicht überschrieben.
			`-f`	`--full`		Vollständige Sicherung. Datenbank, Serverkonfigurationen und Übertragungsdateien sind enthalten.
			`-p`	`--parent`		Alle Verzeichnisse für den angegebenen Pfad werden erstellt, sofern sie nicht bereits vorhanden sind.
Sicherungskopie in die Embedded-Datenbank wiederherstellen	`db`	`restore`	`-f`	`--file`		Pfad zur Sicherungsdatei

Ports

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Werttyp	Beschreibung der Option
Alle Ports und SSL-only-Flag anzeigen	`ports`	`list`
Neue Portnummern oder SSL-only-Flag setzen	`ports`	`set`	`-d`	`--dev-comm`	integer	Port für die Kommunikation mit den Geräten. Einzelheiten siehe (12.01-de) Geräte kontaktieren die UMS.
			`-j`	`--java-webstart`	integer	Port für Java Web Start
			`-w`	`--web-server`	integer	Port für den UMS Server. Einzelheiten siehe (12.01-de) UMS mit interner Datenbank und (12.01-de) UMS mit externer Datenbank.
			`-e`	`--embedded`	integer	Port der Embedded-Datenbank
				`--ssl-only`	boolean	Nur SSL-Verbindungen erlauben

Cipher

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Beschreibung der Option
Alle Ciphers auflisten, optional gefiltert	`cipher`	`list`			Alle Ciphers auflisten
			`-e`	`--enabled`	Nur aktivierte Ciphers auflisten
			`-d`	`--disabled`	Nur deaktivierte Ciphers auflisten
Ciphers aktivieren	`cipher`	`enable`			Ciphers aktivieren. Die Ciphers werden durch Leerzeichen getrennt. Beispiel: `umsadmin-cli cipher enable CIPHER1 CIPHER 2 CIPHER3`
Ciphers aktivieren	`cipher`	`enable`		`--all`	Auf alle anwenden; einzelne Ciphernamen werden ignoriert.
Ciphers deaktivieren	`cipher`	`disable`			Ciphers deaktivieren. Die Ciphers werden durch Leerzeichen getrennt. Beispiel: `umsadmin-cli cipher disable CIPHER1 CIPHER 2 CIPHER3`
Ciphers deaktivieren	`cipher`	`disable`		`--all`	Auf alle anwenden; einzelne Ciphernamen werden ignoriert..

Web-Zertifikate zurücksetzen

Aktion	Primäres Unter-kommando	Kurze Option	Lange Option	Beschreibung der Option
Web-Zertifikate zurücksetzen	`reset-certs`	`-y`	`--yes`	Nur wenn Sie dies bestätigen, wird der Reset ausgeführt.

Superuser

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Werttyp	Beschreibung der Option
UMS Superuser anzeigen	`su`	`list`
UMS Superuser ändern	`su`	`change`	`-u`	`--user`	string	Neuer Superuser
			`-p`	`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
				`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

UMS-ID

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Werttyp	Beschreibung der Option
Aktuelle UMS-IDs anzeigen	`licensing`	`list`
Neue UMS-ID erstellen	`licensing`	`create`
UMS-ID sichern	`licensing`	`backup`	`-o`	`--outfile`	string	Pfad zur Zieldatei (Dateiendung: `.ksbak`)
			`-p`	`--parent`		Alle Verzeichnisse für den angegebenen Pfad werden erstellt, sofern sie nicht bereits vorhanden sind.
				`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
				`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
UMS-ID aus einem Backup wiederherstellen	`licensing`	`restore`	`-f`	`--file`	string	Pfad zur Backupdatei
				`--password:file`	string	Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
				`--password:in`	string	Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigtaus einer Datei (Klartext), deren Pfad nach dieser Option angegeben wird.

Netzwerktoken

Aktion	Primäres Unter-kommando	Kurze Option	Lange Option	Werttyp	Beschreibung der Option	Anmerkungen
Netzwerk-Token für den UMS Server oder einen Broker installieren	`token`	`-f`	`--token-file`	string	Pfad zur Datei des Tokens	Dieser Befehl ist auch als eigenständiger Befehl namens `umstokeninstall-cli` in reinen Broker-Installationen verfügbar. Er ist äquivalent zu `umsadmin-cli token`.
			`--server`	boolean	Token für UMS Server installieren
			`--broker`	boolean	Token für Broker installieren

Server

Aktion	Primäres Unter-kommando	Sekundäres Unter-kommando	Kurze Option	Lange Option	Beschreibung der Option
Lokalen UMS Server starten	`server`	`start`
Lokalen UMS Server stoppen	`server`	`stop`
Lokalen UMS Server neu starten	`server`	`restart`
Update-Modus für den lokalen UMS Server beenden	`server`	`end-update-mode`
Distributed-Modus der UMS Installation einstellen	`server`	`distributed`	`-e`	`--enable`	Distributed UMS aktivieren
			`-d`	`--disable`	Distributed UMS deaktivieren

Fehlernummern

Die Fehlernummern werden in folgendem Format ausgegeben:

<E-NNNN>: <HUMAN READABLE MESSAGE>

Einige Fehlerbeschreibungen in der folgenden Tabelle enthalten die Phrase "[param]". Diese wird zur Laufzeit durch Angaben zum jeweiligen Fehler ersetzt, z.B. den problematischen Pfad für E-1030.

Fehlernummer	Fehlerbeschreibung
1000	Unable to connect to database. UMS server may be down.
1001	Cannot get database configurations.
1002	Cannot create database.
1003	Cannot activate database. [param]
1004	Internal error while activating database.
1005	Database already exists in this configuration.
1006	Database type is unknown.
1007	Database is already activated.
1008	Cannot edit database configurations.
1009	Internal error while while optimize database.
1010	The active data source type is not Embedded or Derby and does not support optimization.
1014	No database is active or the active database is not of type 'Embedded' or 'Derby'.
1051	Authentication error or internal error when an attempt was made to copy the database
1052	Error Accessing credentials of source database
1020	Database could not be deleted.
1011	Test of the active data source failed.
1012	No database is activated.
1013	Cannot deactivate database.
1030	The specified directory for the backup does not exist: [param]
1031	Internal error while attempting database backup.
1040	The specified backup file was not found.
1041	The specified backup file has an invalid file type.
1042	Unable to read the specified backup file.
1043	Internal error while activate data source after restore.
1044	Internal error while attempting to restore database.
1045	The active data source is not embedded or there is no active data source.
1090	A name is required for non-embedded database types.
1100	The name 'rmdb' is reserved for the Embedded database.
1091	Activation failed, incorrect password provided.
1092	Backup failed, the specified file already exists.
1093	Port number is required for non-Embedded database.
1094	A data source of the Embedded type cannot be edited.
1095	No such data source with this ID.
2000	Internal error while reading port configuration.
2001	Internal error while setting port configuration.
2002	Internal error while restarting UMS server.
2003	Invalid port number provided.
2004	Port number [param] already configured.
3000	Internal error while reading cipher data.
3001	Internal error while changing cipher configuration.
3002	Invalid ciphers provided: [param]
4000	Resetting web certificates requires '--yes' option for confirmation.
4001	Internal error while resetting web certificates.
5000	Internal error while reading super user credentials.
5001	Internal error while writing super user credentials.
5002	No username was provided for new credentials.
5003	Unable to set superuser credentials. There is no active data source.
6000	Unable to create new UMS ID.
6001	The specified file for the license key backup already exists.
6002	No internal license keystore found.
6003	Internal error while creating license key backup.
6004	Internal error while restoring license key backup.
6005	The specified file for the license key backup does not exist.
6006	The specified password for the license key backup is incorrect.
6007	The specified path for the license key backup does not exist: [param]
7000	Token file was not found.
7001	Setup type not defined, token not installed.
8000	Internal error while restarting the UMS server.
8001	Internal error while starting the UMS server.
8002	Internal error while stopping the UMS server.
8003	Internal error while ending the update mode of the UMS Server.
8004	Internal error while setting the distributed mode of the UMS installation.
8005	Either --enable or --disable must be provided in the options.
8006	Distributed UMS not recommended for Derby Embedded Database.
9000	An error with the password file occured: [param]
9001	The provided passwords did not match. Aborted.
9002	The provided password exceeds the maximium character limit ([param]) or contains only whitespace.