...
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-Code | Bedeutung |
---|---|
0 | Erfolgreiche Ausführung |
1 | Interner Fehler. Eine Fehlernummer wird auf stderr ausgegeben; für Details, siehe (12.04.120-de) IGEL UMS Administrator KommandozeilenschnittstelleFehlernummern. |
2 | Falsche Verwendung der CLI oder ungültige Argumente |
Kommandoreferenz
Anchor | ||||
---|---|---|---|---|
|
Info | ||
---|---|---|
| ||
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:
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 | ||
---|---|---|
| ||
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:
|
Scroll landscape |
---|
Scroll tablelayout | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
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 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 Führen Sie |
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
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 |
-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.04.120-de_orig) Wie kann ich eine Datenquelle im IGEL UMS Administrator einrichten? Beispiele:
| ||||
-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: | ||
--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: | ||
--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 | |
--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 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.04.120-de_orig) 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.04.120-de_orig) UMS mit interner Datenbank und (12.04.120-de_orig) 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 | Werttyp | 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: | |||
--all | Auf alle anwenden; einzelne Ciphernamen werden ignoriert. | |||||
Ciphers deaktivieren | cipher | disable | Ciphers deaktivieren. Die Ciphers werden durch Leerzeichen getrennt. Beispiel: | |||
--all | Auf alle anwenden; einzelne Ciphernamen werden ignoriert.. |
Web-Zertifikate
Aktion | Primäres Unter-kommando | Sekundäres Unter-kommando | Kurze Option | Lange Option | Beschreibung der Option | |
---|---|---|---|---|---|---|
Web-Zertifikate zurücksetzen | reset-certs | -y | --yes | Der Reset wird erst nach Bestätigung ausgeführt | ||
Zeigt Hilfeinformationen über den angegebenen Befehl an |
|
| ||||
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 ist. Mögliche Werte:
| ||||
Stammzertifikat erstellen | web-certs | create-root-cert | -a | --algorithm | Schlüsselpaar-Algorithmus; | |
-c | --country | Lä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:
| |||||
-l | --locality | Standort (Wenn nicht angegeben, wird der Hash-Code einer zufälligen uuid verwendet). | ||||
-n | --name | Name des Zertifikats (Standard: Root certificate) | ||||
--named-curve | Named curve
| |||||
-o | --organization | Organisation (obligatorisch) | ||||
Signiertes Zertifikat erstellen | web-certs | create-signed-cert | -f | --fingerprint-sha1 | SHA1-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 | --name | Name des Zertifikats (Standard: Certificate) | ||||
--cn | Common name | |||||
-c | --country | Ländercode (zwei Buchstaben) | ||||
-o | --organization | Organisation | ||||
-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:
| |||||
-h | --hostname | Hostname oder einer der folgenden Werte:
| 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öschen | web-certs | delete | -f | --fingerprint-sha1 | SHA1-Fingerprint des Zertifikats | |
Zertifikat exportieren | web-certs | export-cert | -c | --cert-file | Pfad, in den das Zertifikat exportiert werden soll (Der Name cert.cert wird verwendet, wenn nur ein Verzeichnis angegeben ist.) | |
-f | --fingerprint-sha1 | SHA1-Fingerabdruck des Zertifikats | ||||
Zertifikatskette in Schlüsselspeicher exportieren (JKS) | 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, die das Kennwort enthält | |||||
--password:in | Zeigt eine interaktive Aufforderung zur Eingabe des Passworts | |||||
Zertifikatskette aus Keystore importieren | web-certs | import-cert-chain | -k | --keystore-file | Die Keystore-Datei | |
--password:file | Pfad zu einer Datei, die das Kennwort enthält | |||||
--password:in | Zeigt eine interaktive Aufforderung zur Eingabe des Passworts | |||||
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, die den privaten Schlüssel enthält | ||||
Stammzertifikat importieren | web-certs | import-root-cert | -c | --cert-file | Das Stammzertifikat(CERT, CER, CRT, PEM ) | |
Signiertes Zertifikat importieren | web-certs | import-signed-cert | -c | --cert-file | Das 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-sha1 | SHA1 fingerprint des übergeordneten CA-Zertifikats | ||||
Den zugewiesenen Server eines Zertifikats auflisten | web-certs | list-assigned-server | -f | --fingerprint-sha1 | SHA1-Fingerabdruck des Zertifikats | |
Alle Webzertifikate oder Details zu einem Zertifikat auflisten | web-certs | list | -f | --fingerprint-sha1 | SHA1-Fingerabdruck des Zertifikats | Wenn Sie einen Fingerabdruck angeben, werden die Details des Zertifikats mit diesem Fingerabdruck angezeigt. |
Zertifikat erneuern | web-certs | renew-cert | -f | --fingerprint-sha1 | SHA1-Fingerabdruck des Zertifikats | Sie 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 | --name | Name des Zertifikats | ||||
--cn | Common name | |||||
-c | --country | Ländercode (zwei Buchstaben) | ||||
-o | --organization | Organisation | ||||
-l | --locality | Standort | ||||
-d | --expiration-date | Verfallsdatum (YYYY-MM-DD) (Aktuelles Datum plus 1 Jahr, falls nicht angegeben.) | ||||
-h | --hostname | Hostname oder einer der folgenden Werte:
|
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 |
--server | boolean | Token für UMS Server installieren | ||||
--broker | boolean | Token für Broker installieren |
UMS Cluster
Aktion | Primäres Unter-kommando | Sekundäres Unter-kommando | Kurze Option | Lange Option | Beschreibung der Option |
---|---|---|---|---|---|
Den aktuellen FQDN des UMS Clusters anzeigen | ums-cluster | list | |||
Einen neuen FQDN für den UMS Cluster festlegen | ums-cluster | create | -n | --name | Name für den neuen FQDN des UMS Clusters |
Den aktuellen FQDN des UMS Clusters löschen | ums-cluster | remove |
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 |
Scroll portrait |
---|
Fehlernummern
Anchor | ||||
---|---|---|---|---|
|
Die Fehlernummern werden in folgendem Format ausgegeben:
...