Kommandozeilenschnittstelle des IGEL UMS Administrators

Alle konfigurierten Datenquellen auflisten

db

list

Zeigt die ID der Datenquelle an, die für andere Befehle benötigt wird.

Die kleinste ID ist 1.

IDs können sich beim Erstellen oder Löschen von Datenquellen ändern.

Es wird dringend empfohlen, die ID vor der Verwendung mit --id immer neu zu ermitteln.

Die ID wird wie folgt berechnet: höchste vorhandene ID + 1

Alle Details einer Datenbank anzeigen

db

show

-i

--id

Ganzzahl

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 anschließendumsadmin-cli db show --id <ID>  mit dieser ID aus.

Neue Datenbankverbindung erstellen

db

create

-t

--type

Zeichenkette

Der Datenbanktyp. Eine Liste möglicher Werte erhalten Sie mit umsadmin-cli db create

Typ, Benutzer und Port sind erforderlich.

Weitere Optionen können je nach Datenbanktyp erforderlich sein oder nicht.

db create aktiviert die Datenbank standardmäßig; dies kann mit -A oder --no-activate verhindert werden. In diesem Fall kann keine Passwortoption verwendet werden.

Falls die Aktivierung fehlschlägt, bleibt der Datenquelleneintrag bestehen und ist nicht aktiv (gleiches Verhalten wie im grafischen UMS Administrator).

'rmdb' ist ein reservierter Name für die eingebettete Datenbank und darf für andere Typen nicht verwendet werden.

-H

--host

Zeichenkette

Der Datenbankhost

-d

--domain

Zeichenkette

Die Datenbankdomäne

-p

--port

Ganzzahl

Der Datenbankport

-u

--user

Zeichenkette

Der Datenbankbenutzername

-S

--schema

Zeichenkette

Das Datenbankschema

-n

--name

Zeichenkette

Der Datenbankname.

Freitext, außer 'rmdb'; dieser Name ist für die eingebettete Datenbank reserviert.

-I

--instance

Zeichenkette

Der Name der Datenbankinstanz

-A

--no-activate

Die Datenbank wird nicht aktiviert.

--password:file

Zeichenkette

Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

--password:in

Zeichenkette

Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

Datenquelle bearbeiten

db

edit

-t

--type

Zeichenkette

Der Datenbanktyp. Eine Liste möglicher Werte erhalten Sie mit umsadmin-cli db create

Eingebettete Datenbanken können nicht bearbeitet werden (wie im grafischen UMS Administrator).

Alle Optionen sind optional, außer --id

-H

--host

Zeichenkette

Der Datenbankhost

-d

--domain

Zeichenkette

Die Datenbankdomäne

-i

--id

Zeichenkette

Die Kennung der zu bearbeitenden Datenbank

-I

--instance

Zeichenkette

Der Name der Datenbankinstanz

--jdbc-params

Zeichenkette

Zusätzlicher JDBC-Parameter

Details zu JDBC-Parametern finden Sie unter So richten Sie eine Datenquelle im IGEL UMS Administrator ein.

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

Zeichenkette

Der Datenbankname.

Freitext, außer 'rmdb'; dieser Name ist für die eingebettete Datenbank reserviert.

-p

--port

Ganzzahl

Der Datenbankport

-S

--schema

Zeichenkette

Das Datenbankschema

-u

--user

Zeichenkette

Der Datenbankbenutzername

Datenbankverbindung aktivieren

db

activate

--password:file

Zeichenkette

Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

Beispiel: umsadmin-cli db activate --password:file /home/ike/password.txt

--password:in

Zeichenkette

Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

-i

--id

Ganzzahl

Die Kennung der zu aktivierenden Datenbank

Aktive Datenbankverbindung deaktivieren

db

deactivate

-i

--id

Ganzzahl

Die Kennung der zu deaktivierenden Datenbank

Aktive Datenbankverbindung testen

db

test

--password:file

Zeichenkette

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

--password:in

Zeichenkette

Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

Aktive Datenbank optimieren

db 

optimize

Dieser Befehl kann nur auf eine eingebettete Datenbank oder eine Derby-Datenbank angewendet werden.

Kopie der aktuellen Datenbank erstellen

db

copy

-t

--target

Ganzzahl

Die ID der Zieldatenbank

Um die Datenbank-ID zu ermitteln, geben Sie umsadmin-cli db list ein.

--password:file

Zeichenkette

Das Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

--password:in

Zeichenkette

Das Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

Datenbankverbindung löschen

db

delete

-i

--id

Ganzzahl

Die ID der zu löschenden Datenbankverbindung

Sicherung der aktuellen eingebetteten 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 Transferdateien werden eingeschlossen.

-p

--parent

Alle Verzeichnisse des angegebenen Pfads werden erstellt, falls sie noch nicht existieren.

Sicherung in die eingebettete Datenbank wiederherstellen

db

restore

-f

--file

Pfad zur Sicherungsdatei

Alle Ports und das SSL-Flag auflisten

ports

list

Neue Portnummern oder das Nur-SSL-Flag festlegen

ports

set

-d

--dev-comm

Ganzzahl

Port für die Gerätekommunikation. Details finden Sie unter Geräte kontaktieren die IGEL UMS.

-j

--java-webstart

Ganzzahl

Java-Web-Start-Port

-w

--web-server

Ganzzahl

Port des UMS Servers. Details finden Sie unter UMS mit interner Datenbank und UMS mit externer Datenbank.

-e

--embedded

Ganzzahl

Port der eingebetteten Datenbank

--ssl-only

Boolescher Wert

Nur SSL-Verbindungen zulassen

Alle Cipher-Suites auflisten, optional gefiltert

cipher

list

Alle Cipher-Suites auflisten

-e

--enabled

Nur aktivierte Cipher-Suites auflisten

-d

--disabled

Nur deaktivierte Cipher-Suites auflisten

Cipher-Suites aktivieren

cipher

enable

Cipher-Suites aktivieren. Die Cipher-Suites werden durch Leerzeichen getrennt angegeben.

Beispiel: umsadmin-cli cipher enable CIPHER1 CIPHER 2 CIPHER3 

--all

Auf alle anwenden; einzelne Namen von Cipher-Suites werden ignoriert.

Cipher-Suites deaktivieren

cipher

disable

Cipher-Suites deaktivieren. Die Cipher-Suites werden durch Leerzeichen getrennt angegeben.

Beispiel: umsadmin-cli cipher disable CIPHER1 CIPHER 2 CIPHER3

--all

Auf alle anwenden; einzelne Namen von Cipher-Suites werden ignoriert.

Web-Zertifikate zurücksetzen

reset-certs

-y

--yes

Das Zurücksetzen wird erst nach einer Bestätigung ausgeführt.

Zertifikat dem aktuellen oder allen Servern zuweisen

web-certs

assign-cert

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

-s

--server

Server, dem das Zertifikat zugewiesen wird. Mögliche Werte:

• ALL_SERVER

• CURRENT_SERVER (Standard)

Root-Zertifikat erstellen

web-certs

create-root-cert

-a

--algorithm

Schlüsselpaar-Algorithmus; rsa oder ec (Standard: rsa)

-c

--country

Ländercode (zwei Buchstaben)

-d

--expiration-date

Ablaufdatum (JJJJ-MM-TT)

(Aktuelles Datum + 20 Jahre, wenn nicht angegeben.)

--key-size

Schlüssellänge (4096, 8192, ... Bit). Gültige Werte:

• 4k (Standard)

• 8k

• 12k

• 16k 

-l

--locality

Ort

(Falls nicht angegeben, wird der Hash-Code einer zufälligen UUID verwendet.)

-n

--name

Zertifikatsname (Standard: Root-Zertifikat)

--named-curve

Benannte Kurve. Gültige Werte:

• nist-p-384 (Standard)

• nist-p-256

• nist-p-521 

-o

--organization

Organisation

(Pflichtoption)

Signiertes Zertifikat erstellen

web-certs

create-signed-cert

-f

--fingerprint-sha1

SHA1-Fingerabdruck des übergeordneten CA-Zertifikats

Das übergeordnete CA-Zertifikat wird über den SHA1-Fingerabdruck angegeben. Als Trennzeichen können kein Trennzeichen, „-“ oder „:“ verwendet werden.

-n

--name

Zertifikatsname (Standard: Zertifikat)

--cn

Common name

-c

--country

Ländercode (zwei Buchstaben)

-o

--organization

Organisation

-l

--locality

Ort

(Falls nicht angegeben, wird der Hash-Code einer zufälligen UUID verwendet.)

-d

--expiration-date

Ablaufdatum (JJJJ-MM-TT)

(Aktuelles Datum + 1 Jahr, wenn nicht angegeben.)

--ca

Zertifikatstyp:

• true = CA-Zertifikat,

• false = Endentitätszertifikat (Standard)

-h

--hostname

Hostname oder einer der folgenden Werte:

• ALL_SERVER

• CURRENT_SERVER (Standard)

Sie können eine Liste von Hostnamen für die Subject Alternative Names (SAN) angeben oder festlegen, ob der aktuelle Server (CURRENT_SERVER) oder alle Server (ALL_SERVER) in die SAN-Liste aufgenommen werden sollen.

Zertifikat löschen

web-certs

delete

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

Zertifikat exportieren

web-certs

export-cert

-c

--cert-file

Pfad, in den das Zertifikat exportiert werden soll (wenn nur ein Verzeichnis angegeben wird, wird der Name cert.cert verwendet.)

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

Zertifikatskette in einen Keystore (JKS) exportieren

web-certs

export-cert-chain

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

-k

--keystore-file

Pfad zum Keystore, in den die Zertifikatskette exportiert werden soll

--password:file

Pfad zu einer Datei mit dem Passwort

--password:in

Zeigt eine interaktive Eingabeaufforderung zur Passworteingabe an

Zertifikatskette aus einem Keystore importieren

web-certs

import-cert-chain

-k

--keystore-file

Die Keystore-Datei

--password:file

Pfad zu einer Datei mit dem Passwort

--password:in

Zeigt eine interaktive Eingabeaufforderung zur Passworteingabe an

Entschlüsselten privaten Schlüssel importieren

web-certs

import-private-key

-f

--fingerprint-sha1

SHA1-Fingerabdruck des übergeordneten CA-Zertifikats

-p

--private-key-file

Die Datei mit dem privaten Schlüssel

Root-Zertifikat importieren

web-certs

import-root-cert

-c

--cert-file

Das Root-Zertifikat (CERT, CER, CRT, PEM)

Signiertes Zertifikat importieren

web-certs

import-signed-cert

-c

--cert-file

Das Root-Zertifikat (CERT, CER, CRT, PEM)

Ein Zertifikat kann nur importiert werden, wenn kein anderes Zertifikat mit demselben Fingerabdruck bereits existiert. Andernfalls wird eine Fehlermeldung angezeigt.

-f

--fingerprint-sha1

SHA1-Fingerabdruck des übergeordneten CA-Zertifikats

Dem Zertifikat zugewiesene Server auflisten

web-certs

list-assigned-server

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

Alle Web-Zertifikate oder die Details eines Zertifikats auflisten

web-certs

list

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

Wenn ein Fingerabdruck angegeben wird, werden die Details des Zertifikats mit diesem Fingerabdruck angezeigt.

Zertifikat erneuern

web-certs

renew-cert

-f

--fingerprint-sha1

SHA1-Fingerabdruck des Zertifikats

Es muss nur der Fingerabdruck des zu erneuernden Zertifikats angegeben werden. Werden keine weiteren Parameter angegeben, werden die Werte des alten Zertifikats verwendet (mit neuem Ablaufdatum).

-n

--name

Zertifikatsname

--cn

Common name

-c

--country

Ländercode (zwei Buchstaben)

-o

--organization

Organisation

-l

--locality

Ort

-d

--expiration-date

Ablaufdatum (JJJJ-MM-TT)
(Aktuelles Datum + 1 Jahr, wenn nicht angegeben.)

-h

--hostname

Hostname oder einer der folgenden Werte:

• ALL_SERVER

• CURRENT_SERVER

Enable the acceptance of expired client certificates

accept-expired-client-certs

enable

Enables the use of a custom TrustManager that accepts expired client certificates. As a result, the UMS can communicate with IGEL OS 12 devices that have expired client certificates.

Disables the acceptance of expired client certificates

accept-expired-client-certs

disable

Disables the use of a custom TrustManager that accepts expired client certificates. As a result, the UMS cannot communicate with IGEL OS 12 devices that have expired client certificates.

Show state of the option

accept-expired-client-certs

state

Shows if the custom TrustManager is enabled or disabled.

Show UMS superuser

su

list

Change UMS superuser

su

change

-u

--user

string

New superuser

-p

--password:file

string

The password is read from a file (plain text) whose path is provided after this option.

--password:in

string

The password is read from stdin; an interactive prompt is shown.

Show the current UMS IDs

licensing

list

Create a new UMS ID

licensing

create

Backup the UMS ID

licensing

backup

-o

--outfile

string

Path to the target file (file suffix: .ksbak)

-p

--parent

All directories for the specified path will be created if they are not already existing.

--password:file

string

The password is read from a file (plain text) whose path is provided after this option.

--password:in

string

The password is read from stdin; an interactive prompt is shown.

Restore a UMS ID from a backup

licensing

restore

-f

--file

string

Path to the backup file

--password:file

string

The password is read from a file (plain text) whose path is provided after this option.

--password:in

string

The password is read from stdin; an interactive prompt is shown.

Register a license to the UMS

ums-license

register

-f

--filename

path to .lic file

Path to the UMS license file.

During registration several errors could occur, e.g. the path doesn’t exist, the file is invalid, the license already exists, the UMS ID doesn’t match. When such an error occurs a corresponding error code is returned. See error codes under Error Numbers.

Returns current UMS License information

ums-license

state

Delete all licenses previously imported with the command register

ums-license

deleteall

Install a network token for the UMS Server or a broker (UMS HA)

token

-f

--token-file

string

Path to token file

This command is also available as a standalone command named umstokeninstall-cli in broker-only installations. It is equivalent to umsadmin-cli token.

--server

boolean

Install token for UMS Server

--broker

boolean

Install token for broker

Show the current UMS cluster FQDN

ums-cluster

list

Set a new UMS cluster FQDN

ums-cluster

create

-n

--name

Name for the new UMS cluster FQDN

Delete the current UMS cluster FQDN

ums-cluster

remove

Start the local UMS Server

server

start

Stop the local UMS Server

server

stop

Restart the local UMS Server

server

restart

End the update mode of the local UMS Server

server

end-update-mode

Set the distributed mode of the UMS installation

server

distributed

-e

--enable

Enable Distributed UMS

-d

--disable

Disable Distributed UMS

Encrypt text

enc

encrypt

-p

--plain-text

Example:

enc encrypt -p “testExample“

Encode file

enc

encode

-f

--plain-file

Example:

enc encode -f "/home/IGEL/test.user/Downloads/test/test.ksbak"