Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Documents: Update page title prefix

...

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.

...

Info

Bestimmte Unterbefehle haben keine Optionen und werden sofort ausgeführt. Bitte beachten Sie die (12.04.120-de) IGEL UMS Administrator KommandozeilenschnittstelleKommandoreferenz.

...

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

...

Um Hilfeinformationen zu einem beliebigen Befehl anzuzeigen, verwenden Sie help als Unterbefehl. Zum beispiel, geben Sie umsadmin-cli web-certs help

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.

...

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.)

...

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.

...

command … >/dev/null 2>&1

--separator

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

...

Info

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-CodeBedeutung
0Erfolgreiche Ausführung
1Interner Fehler. Eine Fehlernummer wird auf stderr ausgegeben; für Details, siehe (12.04.120-de) IGEL UMS Administrator KommandozeilenschnittstelleFehlernummern
2Falsche Verwendung der CLI oder ungültige Argumente

Kommandoreferenz
Anchor
Kommandoreferenz
Kommandoreferenz

Info
titleAllgemeine 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.

...

Info
titleNeustart 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

Scroll landscape

Scroll tablelayout
orientationdefault
sortDirectionASC
repeatTableHeadersdefault
widths10%, 10%, 10%, 10%, 10%, 10%, 20%, 20%
sortByColumn1
tableStylingconfluence
sortEnabledfalse
cellHighlightingtrue

Datenbank

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange OptionWerttypBeschreibung der OptionAnmerkungen
Alle konfigurierten Datenquellen auflistendblist



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 anzeigendbshow-i--idintegerDie 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--typestringDer 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--hoststringDatenbank-Host
-d--domainstringDatenbank-Domäne
-p--portintegerDatenbank-Port
-u--userstringBenutzer für die Datenbank
-S--schemastringSchema der Datenbank
-n--namestring

Name der Datenbank.

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


-I--instancestringName der Datenbankinstanz
-A--no-activate
Die Datenbank wird nicht aktiviert.

--password:filestringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
--password:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
Bearbeiten einer Datenquelledbedit-t--typestringDatenbanktyp.
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--hoststringDatenbank-Host
-d--domainstringDatenbank-Domäne
-i--idintegerID der zu bearbeitenden Datenbank
-I--instancestringName der Datenbankinstanz

--jdbc-paramsstringZusätzlicher JDBC-Parameter

Einzelheiten zu den JDBC-Parametern finden Sie unter (12.04.120-de_orig) 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--namestring

Der Name der Datenbank.

Freier Text, außer 'rmdb'; dieser Name ist für die Embedded-Datenbank reserviert.


-p--portintegerDatenbank-Port
-S--schemastringSchema der Datenbank
-u--userstringBenutzer für die Datenbank
Datenbankverbindung aktivierendbactivate

--password:filestring

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:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
-i--idintegerID der zu aktivierenden Datenbank

Aktive Datenbankverbindung aktivieren

dbdeactivate-i--idintegerID der zu deaktivierenden Datenbank
Aktive Datenbankverbindung testendbtest
--password:filestring

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:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
Aktive Datenbank optimierendb optimize



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

Kopie der aktuellen Datenbank anlegen

dbcopy-t--targetinteger

ID der Ziel-Datenbank

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


--password:filestringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird. 
--password:instringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.
Datenbankverbindung löschendbdelete-i--idintegerID der Datenbankverbindung, die gelöscht werden soll
Sicherungskopie der aktuellen Embedded-Datenbank erstellendb

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

dbrestore-f--file
Pfad zur Sicherungsdatei

Ports

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange OptionWerttypBeschreibung der Option

Alle Ports und SSL-only-Flag anzeigen

portslist



Neue Portnummern oder SSL-only-Flag setzen



ports



set



-d--dev-commintegerPort für die Kommunikation mit den Geräten. Einzelheiten siehe (12.04.120-de_orig) Geräte kontaktieren die UMS.
-j--java-webstartintegerPort für Java Web Start
-w--web-serverintegerPort für den UMS Server. Einzelheiten siehe (12.04.120-de_orig) UMS mit interner Datenbank und (12.04.120-de_orig) UMS mit externer Datenbank.
-e--embeddedintegerPort der Embedded-Datenbank

--ssl-onlybooleanNur SSL-Verbindungen erlauben

Cipher

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange OptionWerttypBeschreibung der Option  
Alle Ciphers auflisten, optional gefiltertcipherlist


Alle Ciphers auflisten
-e--enabled
Nur aktivierte Ciphers auflisten
-d--disabled
Nur deaktivierte Ciphers auflisten
Ciphers aktivierencipherenable



Ciphers aktivieren. Die Ciphers werden durch Leerzeichen getrennt.

Beispiel: umsadmin-cli cipher enable CIPHER1 CIPHER 2 CIPHER3 

--all

Auf alle anwenden; einzelne Ciphernamen werden ignoriert.

Ciphers deaktivierencipherdisable



Ciphers deaktivieren. Die Ciphers werden durch Leerzeichen getrennt.

Beispiel: umsadmin-cli cipher disable CIPHER1 CIPHER 2 CIPHER3

--all

Auf alle anwenden; einzelne Ciphernamen werden ignoriert..

Web-Zertifikate

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze OptionLange OptionBeschreibung der Option
Web-Zertifikate zurücksetzenreset-certs
-y--yes

Der Reset wird erst nach Bestätigung ausgeführt


Zeigt Hilfeinformationen über den angegebenen Befehl an

web-certs

help





Zertifikat dem aktuellen oder allen Servern zuweisenweb-certsassign-cert-f--fingerprint-sha1SHA1-Fingerabdruck des Zertifikats
-s--server

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

  • ALL_SERVER
  • CURRENT_SERVER (standard)

Stammzertifikat erstellenweb-certscreate-root-cert-a--algorithm

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


-c--countryLändercode (zwei Buchstaben)
-d--expiration-date

Verfallsdatum (YYYY-MM-DD)

(Aktuelles Datum plus 20 Jahre, falls nicht angegeben.)



--key-size

Schlüsselgröße (4096, 8192, ... bits). Mögliche Werte:

  • 4k (default)
  • 8k
  • 12k
  • 16k 

-l--locality

Standort

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


-n--nameName des Zertifikats
(Standard: Root certificate)


--named-curve

Named curve
Gültige Werte:

  • nist-p-384 (default)
  • nist-p-256
  • nist-p-521 

-o--organization

Organisation

(obligatorisch)


Signiertes Zertifikat erstellenweb-certscreate-signed-cert-f--fingerprint-sha1SHA1-Fingerabdruck des übergeordneten CA-Zertifikats

Das übergeordnete CA-Zertifikat wird durch den SHA1-Fingerabdruck angegeben. Es spielt keine Rolle, ob Sie kein Trennzeichen, '-' oder ':' als Trennzeichen für den Fingerabdruck verwenden.

-n--nameName des Zertifikats
(Standard: Certificate)


--cnCommon name
-c--countryLändercode (zwei Buchstaben)
-o--organizationOrganisation
-l--locality

Standort

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


-d--expiration-date

Verfallsdatum (YYYY-MM-DD)

(Aktuelles Datum plus 1 Jahr, falls nicht angegeben.)



--ca

Typ des Zertifikats:

  • true = CA certificate
  • false = End entity (standard)


-h--hostnameHostname oder einer der folgenden Werte:
  • ALL_SERVER
  • CURRENT_SERVER (default)

Sie können eine Liste von Hostnamen für den Subject Alternative Name (SAN) angeben oder Sie können angeben, ob der aktuelle Server (CURRENT_SERVER) oder alle Server (ALL_SERVER) in der SAN-Liste aufgeführt werden.

Zertifikat löschenweb-certsdelete-f--fingerprint-sha1SHA1-Fingerprint des Zertifikats
Zertifikat exportierenweb-certsexport-cert-c--cert-filePfad, in den das Zertifikat exportiert werden soll
(Der Name cert.cert wird verwendet, wenn nur ein Verzeichnis angegeben ist.)

-f--fingerprint-sha1SHA1-Fingerabdruck des Zertifikats
Zertifikatskette in Schlüsselspeicher exportieren (JKS)web-certsexport-cert-chain-f--fingerprint-sha1SHA1-Fingerabdruck des Zertifikats
-k--keystore-filePfad zum Keystore, in den die Zertifikatskette exportiert werden soll

--password:filePfad zu einer Datei, die das Kennwort enthält

--password:inZeigt eine interaktive Aufforderung zur Eingabe des Passworts
Zertifikatskette aus Keystore importierenweb-certsimport-cert-chain-k--keystore-fileDie Keystore-Datei

--password:filePfad zu einer Datei, die das Kennwort enthält

--password:inZeigt eine interaktive Aufforderung zur Eingabe des Passworts
Entschlüsselten privaten Schlüssel importierenweb-certsimport-private-key-f--fingerprint-sha1SHA1-Fingerabdruck des übergeordneten CA-Zertifikats
-p--private-key-fileDie Datei, die den privaten Schlüssel enthält
Stammzertifikat importierenweb-certsimport-root-cert-c--cert-fileDas Stammzertifikat(CERT, CER, CRT, PEM)
Signiertes Zertifikat importierenweb-certsimport-signed-cert-c--cert-fileDas Stammzertifikat (CERT, CER, CRT, PEM)Ein Zertifikat kann nur importiert werden, wenn kein anderes Zertifikat mit demselben Fingerabdruck bereits existiert, sonst erhalten Sie eine Fehlermeldung.
-f--fingerprint-sha1SHA1 fingerprint des übergeordneten CA-Zertifikats
Den zugewiesenen Server eines Zertifikats auflistenweb-certslist-assigned-server-f--fingerprint-sha1SHA1-Fingerabdruck des Zertifikats
Alle Webzertifikate oder Details zu einem Zertifikat auflistenweb-certslist-f--fingerprint-sha1SHA1-Fingerabdruck des ZertifikatsWenn Sie einen Fingerabdruck angeben, werden die Details des Zertifikats mit diesem Fingerabdruck angezeigt.
Zertifikat erneuernweb-certsrenew-cert-f--fingerprint-sha1SHA1-Fingerabdruck des ZertifikatsSie müssen nur den Fingerabdruck des Zertifikats angeben, das erneuert werden soll. Wenn die anderen Parameter nicht angegeben werden, werden die Werte des alten Zertifikats verwendet (mit neuem Ablaufdatum).
-n--nameName des Zertifikats

--cnCommon name
-c--countryLändercode (zwei Buchstaben)
-o--organizationOrganisation
-l--localityStandort
-d--expiration-date

Verfallsdatum (YYYY-MM-DD)

(Aktuelles Datum plus 1 Jahr, falls nicht angegeben.)


-h--hostname

Hostname oder einer der folgenden Werte:

  • ALL_SERVER
  • CURRENT_SERVER

Superuser

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange OptionWerttypBeschreibung der Option  
UMS Superuser anzeigensulist



UMS Superuser ändern

su

change

-u--userstringNeuer Superuser
-p--password:filestringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

--password:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.

UMS-ID

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange OptionWerttypBeschreibung der Option
Aktuelle UMS-IDs anzeigenlicensinglist



Neue UMS-ID erstellenlicensingcreate



UMS-ID sichernlicensing

backup

-o--outfilestringPfad zur Zieldatei (Dateiendung: .ksbak)
-p--parent
Alle Verzeichnisse für den angegebenen Pfad werden erstellt, sofern sie nicht bereits vorhanden sind.

--password:filestringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

--password:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigt.
UMS-ID aus einem Backup wiederherstellen

licensing

restore

-f--filestringPfad zur Backupdatei

--password:filestringDas Passwort wird aus einer Datei (Klartext) gelesen, deren Pfad nach dieser Option angegeben wird.

--password:instringDas Passwort wird von stdin gelesen; eine interaktive Eingabeaufforderung wird angezeigtaus einer Datei (Klartext), deren Pfad nach dieser Option angegeben wird.

Netzwerktoken

AktionPrimäres Unter-kommandoKurze Option Lange Option WerttypBeschreibung der OptionAnmerkungen
Netzwerk-Token für den UMS Server oder einen Broker installierentoken

-f--token-filestring

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.



--serverbooleanToken für UMS Server installieren
--brokerbooleanToken für Broker installieren

UMS Cluster

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange Option Beschreibung der Option
Den aktuellen FQDN des UMS Clusters anzeigenums-clusterlist


Einen neuen FQDN für den UMS Cluster festlegenums-clustercreate-n--nameName für den neuen FQDN des UMS Clusters
Den aktuellen FQDN des UMS Clusters löschenums-clusterremove


Server

AktionPrimäres Unter-kommandoSekundäres Unter-kommandoKurze Option Lange Option Beschreibung der Option
Lokalen UMS Server startenserverstart


Lokalen UMS Server stoppenserverstop


Lokalen UMS Server neu startenserverrestart


Update-Modus für den lokalen UMS Server beendenserverend-update-mode


Distributed-Modus der UMS Installation einstellenserverdistributed-e--enableDistributed UMS aktivieren

-d--disableDistributed UMS deaktivieren

Scroll portrait

Fehlernummern
Anchor
Fehlernummern
Fehlernummern

Die Fehlernummern werden in folgendem Format ausgegeben:

...