Befehle der Befehlszeilenschnittstelle für Omnissa Access

Nach einer erfolgreichen Omnissa Access-Bereitstellung verwenden Sie die CLI zur Verwaltung und Wartung Ihrer Umgebung.

Die CLI unterstützt tägliche Verwaltungsaufgaben, darunter das Validieren der Konfiguration, das Initialisieren und Aktualisieren von Mandanteneinstellungen, das Rotieren von Zertifikaten, das Überprüfen der Dienstbereitschaft, das Ausführen von Integritätsprüfungen, das Erfassen von Protokollen, das Wiederherstellen von Backups, das Aktualisieren von Betriebssystempaketen sowie das Verwalten von Diensten auf der Omnissa Access Control Plane.

Die Befehle sind nach Verwaltungsbereichen in Gruppen organisiert:

• wso access – Verwalten von Omnissa Access-Mandanten und der SMTP-Konfiguration.
• wso control-plane – Bereitstellen, Validieren, Aktualisieren, Wiederherstellen und Warten der Komponenten der Omnissa Access Control Plane.
• wso services – Bereitstellen, Wiederherstellen, Erstellen von Snapshots und Verwalten von Vorgängen auf Dienstebene.
• wso healthcheck, wso validate-log-config und zugehörige Befehle überprüfen die Integrität und Konfiguration der Bereitstellung.

In der folgenden Tabelle sind die verfügbaren CLI-Befehle mit einer kurzen Beschreibung der einzelnen Befehle aufgeführt.

WSO-Befehle

• wso

  Root-Befehl für die Omnissa Access-CLI. Führen Sie wso --help aus, um alle verfügbaren Befehle und deren Verwendung anzuzeigen.

• Source <(wso completion bash): Aktiviert die Autovervollständigung in der aktuellen Terminalsitzung. Sie müssen den Befehl source <(wso completion bash) jedes Mal ausführen, wenn Sie eine neue Terminalsitzung starten.

• wso access

  Verwaltet die Installation und Konfiguration von Omnissa Access.

  wso access add-tenant-admin-users: Fügt einem Access-Mandanten einen Admin-Benutzer hinzu.

  wso access bootstrap: Lädt das Access-Profil, validiert Zertifikate, generiert Umgebungsvariablen und synchronisiert Schlüssel-Wert-Daten sowie geheime Schlüssel.

  wso access check-service-readiness: Überprüft die Betriebsbereitschaft der Access-Dienste.

  wso access configure-cert-proxy: Konfiguriert den Cert-Proxy für den Access-Cluster

  wso access create-admin-client: Erstellt einen OAuth2-Admin-Client in einem Mandanten

  wso access create-tenant: Erstellt den ersten Access-Mandanten.

  wso access init: Initialisiert das Arbeitsverzeichnis für die Omnissa Access-Installation.

  wso access push-notifications: Befehl zur Verwaltung von Push-Benachrichtigungen in Hub Services.

  wso access rate-limit set: Legt Ratengrenzwerte für Omnissa Access fest, mit den folgenden Flags:

  • --login_rpm – Ratengrenzwert für Anmeldeanforderungen
  • --launch_rpm – Ratengrenzwert für Startanforderungen
  • --wsfed_rpm – Ratengrenzwert für WS-Fed-Anforderungen
  • --tenant_id – Mandantenbezeichner; wird nur in Mehrmandanten-Bereitstellungen abgefragt

  wso access rate-limit get: Ruft die aktuellen Ratengrenzwerteinstellungen für Omnissa Access ab.

  wso access reset-admin-password: Setzt das Kennwort eines Mandanten-Admin-Benutzers zurück.

  wso access rotate-certificate: Rotiert Access-Zertifikate (FQDN oder Cert-Proxy).

  wso access smtp: Initialisiert, ruft ab, validiert und aktualisiert die SMTP-Konfiguration.

  wso access smtp get: Ruft die SMTP-Parameter für den E-Mail-Versand über einen SMTP-Server ab.
  wso access smtp init: Initialisiert SMTP für den E-Mail-Versand.
  wso access smtp update: Aktualisiert die SMTP-Parameter für den E-Mail-Versand über einen SMTP-Server ab.
  wso access smtp validate: Validiert die SMTP-Parameter für den E-Mail-Versand über einen SMTP-Server.

  wso access update-config: Gleicht die Consul KV- und Vault-Konfiguration der Access-Plattform während eines Upgrades ab.

  wso access validate: Validiert die Bestandslistendatei des Access-Clusters und die Voraussetzungen.

• wso configure

  Konfiguriert die CLI für die Verwendung einer bestimmten Version von Omnissa Access-Komponenten.

• wso control-plane

  Stellt die Komponenten der Omnissa Access Control Plane bereit und verwaltet diese. Verwenden Sie wso cp als Kurzalias für diesen Befehl.

  wso control-plane ansible: Führt beliebige Ansible-Befehle für den Cluster der Steuerungsebene aus.

  wso control-plane collect-log-bundle: Erfasst Offline-Protokolle von Clusterknoten in einem Paket.

  wso control-plane deploy: Stellt Komponenten der Omnissa Access Control Plane bereit.

  wso control-plane diagnostics: Führt Diagnosen auf den Knoten in der Omnissa Access Control Plane aus.

  wso control-plane hydrate-assets: Fügt die neuesten Assets hinzu.

  wso control-plane plan-restore-backup: Plant die Wiederherstellung von Konfigurations- und Schlüsselwertdaten aus der Sicherung auf der Omnissa Control Plane.

  wso control-plane precheck: Überprüft, ob die Clusterkonfiguration die Bereitstellungsanforderungen erfüllt.

  wso control-plane reset-assets: Bereinigt alte Assets und setzt sie auf die neuesten Assets zurück.

  wso control-plane restart-schedulers: Startet die Dienst-Scheduler-Agent im Omnissa Access-Cluster neu.

  wso control-plane plan-restore-backup: Stellt Konfigurations- und Schlüssel-Wert-Daten aus der Sicherung in der Omnissa Access Control Plane wieder her.

  wso control-plane sync-time: Synchronisiert die Uhrzeit auf den virtuellen Maschinen der Omnissa Access Control Plane.

  wso control-plane unseal: Hebt die Versiegelung der Vault-Knoten in der Omnissa Access Control Plane auf.

  wso control-plane update-agents: Aktualisiert Agentversionen oder aktualisiert die Konfiguration der Komponenten der Omnissa Access Control Plane auf virtuellen Agent-Maschinen.

  wso control-plane update-certificate: Aktualisiert die Zertifikate für die Omnissa Access Control Plane-Dienste.

  wso control-plane update-os: Aktualisiert Pakete auf jedem Linux-Knoten der Omnissa Access Control Plane.

  wso control-plane update-telemetry: Aktualisiert die Telemetriedaten auf jedem Knoten der Omnissa Access Control Plane.

• wso cp

  Alias für den Befehl wso control-plane. Akzeptiert dieselben Unterbefehle.

• wso eula

  Zeigt die Endbenutzerlizenzvereinbarung (EULA) an und ermöglicht deren Annahme oder Ablehnung.

• wso healthcheck

  Führt eine grundlegende Integritätsprüfung der Steuerungsebene durch, einschließlich der Kernkomponenten der Plattform und der darauf ausgeführten Dienste.

• wso services

  Stellt Dienste in der Omnissa Control Plane bereit und verwaltet diese.

  wso services config-report: Meldet die verwendeten Konfigurationen und Außerkraftsetzungen.

  wso services deploy: Stellt Dienste in der Omnissa Control Plane bereit.

  wso services list: Zeigt Einstellungen für einen bestimmten Dienst an.

  wso services restore: Stellt Dienste auf der Omnissa Control Plane wieder her.

  wso services set-log-level: Legt die Protokollierungsebene für einen bestimmten Dienst fest.

  wso services snapshot: Erstellt einen Snapshot der Dienste auf der Omnissa Access Control Plane.

  wso services sync-kv: Synchronisiert Daten aus einem Verzeichnis des lokalen Dateisystems mit dem Schlüssel-Wert-Speicher.

  wso services sync-secrets: Synchronisiert mit dem Geheimnisspeicher aus einem Verzeichnis des lokalen Dateisystems.

  wso services temp-creds-generate: Generiert temporäre Anmeldedaten für einen Dienst.

  wso services temp-creds-revoke: Widerruft temporäre Anmeldedaten für einen Dienst.

• wso validate-log-config

  Validiert die Protokollierungskonfiguration (Syslog, Loki, OpenSearch) und überprüft die Erreichbarkeit.

• wso version

  Zeigt die Version der CLI an.

Allgemeine Verwaltungsaufgaben

Die folgenden Beispiele zeigen, wie häufig benötigte CLI-Befehle nach der Bereitstellung verwendet werden.

Erstellen eines Protokollpakets

Verwenden Sie wso control-plane collect-log-bundle, um Offlineprotokolle von allen Clusterknoten in einem einzelnen Paket zur Fehlerbehebung zu erfassen. Standardmäßig wird das aktuelle Verzeichnis nach der Cluster-Bestandslistendatei durchsucht. Übergeben Sie ein Arbeitsverzeichnis als Argument, um den Befehl von einem anderen Ort aus auszuführen.

wso cp collect-log-bundle

Protokolle werden unter /tmp/ gespeichert.

Zurücksetzen des Mandanten-Admin-Kennworts

Sendet standardmäßig eine E-Mail zum Zurücksetzen des Kennworts an den Benutzer. Verwenden Sie --send_mail=false, um dies zu überspringen. Die Domäne ist standardmäßig auf System Domain gesetzt, sofern nicht --domain angegeben wird.

wso access reset-admin-password

Erstellen des ersten Access-Mandanten

wso access create-tenant

Aufheben der Versiegelung der Vault-Knoten

Verwenden wso control-plane unseal, wenn Vault nach einem Wartungsvorgang, wie z. B. einem Neustart des Knotens, versiegelt wird. Standardmäßig wird das aktuelle Verzeichnis nach der Bestandslistendatei der Steuerungsebene durchsucht. Übergeben Sie ein Arbeitsverzeichnis als Argument, um den Befehl von einem anderen Ort aus auszuführen.

wso cp unseal

Ausführen der Diagnose

Verwenden Sie wso control-plane diagnostics, um Diagnosen auf den Knoten in der Steuerungsebene auszuführen.

wso cp diagnostics

Wiederherstellen der Konfiguration aus der Sicherung

Verwenden Sie wso control-plane restore-backup, um Konfigurations- und Schlüssel-Wert-Daten auf der Steuerungsebene wiederherzustellen. Dies erfordert einen Wiederherstellungsplan, der bereits mithilfe von plan-restore-backup erstellt und verifiziert wurde. Standardmäßig wird das aktuelle Verzeichnis nach der Bestandslistendatei der Steuerungsebene durchsucht. Übergeben Sie ein Arbeitsverzeichnis als Argument, um den Befehl von einem anderen Ort aus auszuführen.

wso cp restore-backup

Überprüfen der Dienstbereitschaft

Verwenden Sie wso access check-service-readiness, um zu überprüfen, ob die Access-Dienste bereit sind. Prüfen Sie alle Dienste oder einen bestimmten Dienst anhand seines Namens.

wso access check-service-readiness
wso access check-service-readiness --service_name saas

Erstellen eines Admin-OAuth 2-Clients.

Verwenden Sie wso access create-admin-client, um einen OAuth2-Client mit Administratorbereich in einem Mandanten zu erstellen, der für die Authentifizierung gegenüber der ACS-API dient. Führen Sie dies nach der Mandantenerstellung aus. Der geheime Clientschlüssel wird nur einmal angezeigt. Speichern Sie ihn daher sicher.

wso access create-admin-client --tenant_id my-tenant --client_id my-admin-client

Durchführen einer Integritätsprüfung

Verwenden Sie wso healthcheck, um eine grundlegende Integritätsprüfung der Steuerungsebene durchzuführen, einschließlich der Kernkomponenten der Plattform und der darauf ausgeführten Dienste. Die Ausgabe erfolgt standardmäßig im Format table. Verwenden Sie -f json für eine maschinenlesbare Ausgabe.

wso healthcheck

Fügen Sie -n/--include_node_stats hinzu, um die Statistiken des Knotens in die Ausgabe aufzunehmen (dies verlängert die Ausführungszeit).

Hinzufügen eines Mandanten-Admin-Benutzers

Verwenden Sie wso access add-tenant-admin-users, um einen Admin-Benutzer zu einem vorhandenen Mandanten hinzuzufügen.

wso access add-tenant-admin-users --tenant_name my-tenant --admin_username admin --admin_email admin@example.com

SMTP konfigurieren

Verwenden Sie die wso access smtp-Befehle, um die SMTP-Einstellungen für ausgehende E-Mails zu initialisieren, abzurufen, zu validieren und zu aktualisieren.

wso access smtp init
wso access smtp update --SMTP_HOST smtp.example.com --SMTP_PORT 587 --SMTP_USER user --SMTP_PASSWORD ****** --SMTP_SECURITY_TYPE TLS
wso access smtp get
wso access smtp validate

Festlegen von Ratengrenzwerten

Verwenden Sie wso access rate-limit set, um die maximal zulässige Anzahl an Anmelde-, Start- und WS-Fed-Anforderungen pro Minute festzulegen. Verwenden Sie wso access rate-limit get, um die aktuellen Grenzwerte anzuzeigen.

wso access rate-limit set --tenant_id my-tenant --login_rpm 100 --launch_rpm 100 --wsfed_rpm 100
wso access rate-limit get --tenant_id my-tenant

Rotieren eines Zertifikats

Verwenden Sie wso access rotate-certificate, um den FQDN oder das Cert-Proxy-Zertifikat zu rotieren. Geben Sie nur die Namen des Zertifikats und der Schlüsseldatei (keinen Pfad) an, wie in /root/<cluster_name>/access/certsgefunden.

wso access rotate-certificate --cert_type fqdn --cert_file cert.pem --key_file key.pem

Cert-Proxy konfigurieren

Verwenden Sie wso access configure-cert-proxy, um Cert-Proxy als Tag-2-Vorgang in einer vorhandenen Access-Bereitstellung zu konfigurieren. --ssl_certificate_path und --ssl_certificate_key sind nur erforderlich, wenn --ssl_certificate_type auf CUSTOM_CERT gesetzt ist; bei FQDN_CERT sind sie nicht erforderlich.

wso access configure-cert-proxy --ssl_certificate_type CUSTOM_CERT --ssl_certificate_path cert.pem --ssl_certificate_key key.pem

Festlegen einer Dienstprotokollebene

Verwenden Sie wso services set-log-level, um die Protokollebene für einen bestimmten Dienst zu ändern. Standardmäßig wird das aktuelle Verzeichnis nach der Konfiguration durchsucht. Übergeben Sie ein Arbeitsverzeichnis als Argument, um den Befehl von einem anderen Ort aus auszuführen. Wenn --log-level nicht angegeben ist, wird die eigene Standardprotokollebene des Diensts verwendet.

wso services set-log-level --service <service-name> --log-level debug

Validieren der Protokollierungskonfiguration

Verwenden Sie wso validate-log-config zur Validierung der Protokollierungskonfiguration (Syslog, Loki, OpenSearch) und zur Überprüfung der Erreichbarkeit.

wso validate-log-config