Skip to main content

2026 年 8 月 18 日

Omnissa Access 命令列介面命令

成功部署 Omnissa Access 後,請使用 CLI 管理及維護環境。

CLI 支援日常管理工作,包括驗證組態、初始化和更新租用戶設定、輪替憑證、檢查服務就緒狀態、執行健全狀況檢查、收集記錄、從備份還原、更新作業系統套件,以及管理 Omnissa Access Control Plane 上的服務。

各項命令依管理領域分為下列群組:

  • wso access — 管理 Omnissa Access 租用戶和 SMTP 組態。
  • wso control-plane — 部署、驗證、更新、還原及維護 Omnissa Access Control Plane 元件。
  • wso services — 部署及還原服務、建立服務快照,以及管理服務層級作業。
  • wso healthcheckwso validate-log-config 和相關命令 — 驗證部署的健全狀況和組態。

下表列出可用的 CLI 命令,並提供各命令的簡要說明。

wso 命令

  • wso

    Omnissa Access CLI 的根命令。執行 wso --help,可顯示所有可用命令及其用法。

  • source <(wso completion bash):在目前的終端機工作階段中啟用自動完成功能。每次起始新的終端機工作階段時,都必須執行 source <(wso completion bash) 命令。

  • wso access

    管理 Omnissa Access 的安裝和組態。

    wso access add-tenant-admin-users:將管理員使用者新增至 Access 租用戶。

    wso access bootstrap:載入 Access 設定檔、驗證憑證、產生環境變數,以及同步鍵值資料和密碼。

    wso access check-service-readiness:檢查 Access 服務的就緒狀態。

    wso access configure-cert-proxy:為 Access 叢集設定 cert-proxy

    wso access create-admin-client:在租用戶中建立管理員 OAuth2 用戶端

    wso access create-tenant:建立第一個 Access 租用戶。

    wso access init:初始化 Omnissa Access 安裝的工作目錄。

    wso access push-notifications:管理 Hub Services 中的推送通知。

    wso access rate-limit set:設定 Omnissa Access 的速率限制,並支援下列旗標:

    • --login_rpm - 登入要求的速率限制
    • --launch_rpm - 啟動要求的速率限制
    • --wsfed_rpm - WS-Fed 要求的速率限制
    • --tenant_id - 租用戶識別碼;僅在多租用戶部署中提示輸入

    wso access rate-limit get:取得 Omnissa Access 目前的速率限制設定。

    wso access reset-admin-password:重設租用戶管理員使用者的密碼。

    wso access rotate-certificate:輪替 Access 憑證 (FQDN 或 cert-proxy)。

    wso access smtp:初始化、擷取、驗證及更新 SMTP 組態。

    wso access smtp get:取得使用 SMTP 伺服器傳送郵件所需的 SMTP 參數。
    wso access smtp init:初始化用於傳送郵件的 SMTP。
    wso access smtp update:更新使用 SMTP 伺服器傳送郵件所需的 SMTP 參數。
    wso access smtp validate:驗證使用 SMTP 伺服器傳送郵件所需的 SMTP 參數。

    wso access update-config:在升級期間,使 Access 平台的 Consul KV 和 Vault 組態保持一致

    wso access validate:驗證 Access 叢集詳細目錄檔案和先決條件。

  • wso configure

    設定 CLI 使用特定版本的 Omnissa Access 元件。

  • wso control-plane

    部署及管理 Omnissa Access Control Plane 元件。使用 wso cp 作為此命令的簡寫別名。

    wso control-plane ansible:對控制平面叢集執行任意 Ansible 命令。

    wso control-plane collect-log-bundle:將叢集節點的離線記錄收集成記錄服務包。

    wso control-plane deploy:部署 Omnissa Access Control Plane 元件。

    wso control-plane diagnostics:對 Omnissa Access Control Plane 中的節點執行診斷。

    wso control-plane hydrate-assets:新增最新資產。

    wso control-plane plan-restore-backup:規劃將組態和鍵值資料從備份還原至 Omnissa Control Plane。

    wso control-plane precheck:確認叢集組態是否符合部署需求。

    wso control-plane reset-assets:清除舊資產,並重設為最新資產。

    wso control-plane restart-schedulers:重新啟動 Omnissa Access 叢集中的服務排程器代理程式。

    wso control-plane restore-backup:將組態和鍵值資料從備份還原至 Omnissa Access Control Plane。

    wso control-plane sync-time:同步 Omnissa Access Control Plane 虛擬機器上的時間。

    wso control-plane unseal:解封 Omnissa Access Control Plane 中的 Vault 節點。

    wso control-plane update-agents:升級代理程式版本,或更新代理程式虛擬機器上 Omnissa Access Control Plane 元件的組態。

    wso control-plane update-certificate:更新 Omnissa Access Control Plane 服務的憑證。

    wso control-plane update-os:更新每個 Omnissa Access Control Plane Linux 節點上的套件。

    wso control-plane update-telemetry:更新每個 Omnissa Access Control Plane 節點上的遙測組態。

  • wso cp

    wso control-plane 命令的別名。接受所有相同的子命令。

  • wso eula

    顯示使用者授權合約 (EULA),並允許接受或拒絕。

  • wso healthcheck

    對控制平面執行基本健全狀況檢查,包括核心平台元件及其上執行的服務。

  • wso services

    部署及管理 Omnissa Control Plane 上的服務。

    wso services config-report:報告目前使用的組態和覆寫設定。

    wso services deploy:在 Omnissa Control Plane 上部署服務。

    wso services list:顯示指定服務的設定。

    wso services restore:還原 Omnissa Control Plane 上的服務。

    wso services set-log-level:設定指定服務的記錄層級。

    wso services snapshot:建立 Omnissa Access Control Plane 上服務的快照。

    wso services sync-kv:將本機檔案系統目錄中的內容同步至鍵值存放區。

    wso services sync-secrets:將本機檔案系統目錄中的內容同步至密碼存放區。

    wso services temp-creds-generate:為服務產生暫時認證。

    wso services temp-creds-revoke:撤銷服務的暫時認證。

  • wso validate-log-config

    驗證記錄組態 (Syslog、Loki、OpenSearch),並檢查是否可連線。

  • wso version

    顯示 CLI 版本。

常見管理工作

下列範例說明部署完成後,如何使用常用的 CLI 命令。

產生記錄服務包

使用 wso control-plane collect-log-bundle,將所有叢集節點的離線記錄收集至單一服務包中,以進行疑難排解。依預設,此命令會在目前目錄中掃描叢集詳細目錄檔案;若要從其他位置執行,請將工作目錄作為引數傳入。

wso cp collect-log-bundle

記錄會儲存在 /tmp/ 下。

重設租用戶管理員密碼

依預設,系統會向使用者傳送密碼重設電子郵件;若要略過此步驟,請使用 --send_mail=false。除非指定 --domain,否則網域依預設為 System Domain

wso access reset-admin-password

建立第一個 Access 租用戶

wso access create-tenant

解封 Vault 節點

如果 Vault 在節點重新開機等維護作業後變為密封狀態,請使用 wso control-plane unseal。依預設,此命令會在目前目錄中掃描控制平面詳細目錄檔案;若要從其他位置執行,請將工作目錄作為引數傳入。

wso cp unseal

執行診斷

使用 wso control-plane diagnostics,對控制平面中的節點執行診斷。

wso cp diagnostics

從備份還原組態

使用 wso control-plane restore-backup,將組態和鍵值資料還原至控制平面。此命令需要使用 plan-restore-backup 預先建立並驗證的還原計劃。依預設,此命令會在目前目錄中掃描控制平面詳細目錄檔案;若要從其他位置執行,請將工作目錄作為引數傳入。

wso cp restore-backup

檢查服務就緒狀態

使用 wso access check-service-readiness,確認 Access 服務是否已就緒。您可以檢查所有服務,或依名稱檢查特定服務。

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

建立管理員 OAuth2 用戶端

使用 wso access create-admin-client,在租用戶中建立具有管理員範圍的 OAuth2 用戶端,以向 ACS API 進行驗證。在建立租用戶後執行此命令。用戶端密碼只會顯示一次,因此請妥善保管。

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

執行健全狀況檢查

使用 wso healthcheck,對控制平面執行基本健全狀況檢查,包括核心平台元件及其上執行的服務。輸出依預設採用 table 格式;若需要機器可讀取的輸出,請使用 -f json

wso healthcheck

新增 -n/--include_node_stats,可在輸出中包含節點統計資料,但會增加執行時間。

新增租用戶管理員使用者

使用 wso access add-tenant-admin-users,將管理員使用者新增至現有租用戶。

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

設定 SMTP

使用 wso access smtp 命令,初始化、擷取、驗證及更新傳出郵件的 SMTP 設定。

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

設定速率限制

使用 wso access rate-limit set,設定每分鐘允許的登入、啟動和 WS-Fed 要求數目上限。使用 wso access rate-limit get,檢視目前的限制。

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

輪替憑證

使用 wso access rotate-certificate,輪替 FQDN 或 cert-proxy 憑證。僅提供 /root/<cluster_name>/access/certs 中的憑證和金鑰檔案名稱,不要提供路徑。

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

設定 Cert-Proxy

使用 wso access configure-cert-proxy,在現有 Access 部署上將 cert-proxy 設定為次日作業。只有當 --ssl_certificate_typeCUSTOM_CERT 時,才需要指定 --ssl_certificate_path--ssl_certificate_key;若為 FQDN_CERT,則不需要指定。

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

設定服務記錄層級

使用 wso services set-log-level,變更指定服務的記錄層級。依預設,此命令會在目前目錄中掃描組態;若要從其他位置執行,請將工作目錄作為引數傳入。如果未指定 --log-level,系統會使用該服務本身的預設記錄層級。

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

驗證記錄組態

使用 wso validate-log-config,驗證記錄組態 (Syslog、Loki、OpenSearch),並檢查是否可連線。

wso validate-log-config

此頁面對您有幫助嗎?

針對本主題提供意見回饋

本主題對您有幫助嗎?

請勿填寫任何個人或機密資訊。

正在產生連結…