EnglishFrançaisDeutschEspañolItaliano日本語한국어NederlandsPortuguês (Brasil)中文 (简体)中文 (繁體, 台灣)
Skip to main content

2026 年 9 月 15 日

用于 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 healthcheck、wso validate-log-config 和相关命令可验证部署运行状况和配置。

下表列出了可用的 CLI 命令以及每个命令的简要描述。

wso 命令

**注意：**请从集群文件夹 (/opt/wss/<cluster_name>) 运行 wso 命令，除非命令的帮助文本另有说明。

  • wso

    Omnissa Access CLI 的 root 命令。运行 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 请求的速率限制

    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 init：初始化用于发送邮件的 SMTP。
    wso access smtp update：更新用于使用 SMTP 服务器发送邮件的 SMTP 参数。
    wso access smtp get：获取用于使用 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 restore-complete：验证还原的数据，并在新升级的主集群上启用备份操作。

    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 的版本。

access-wizard 命令

可以使用引导式 access-wizard 命令执行初始部署（通过创建租户来设置引导节点），而不是直接运行 wso 命令。请参阅阶段 3，选项 1 - 使用 Access Wizard 部署 Omnissa Access 以了解完整的引导式部署过程，或者参阅阶段 3，选项 2 - 手动部署 Omnissa Access 以直接运行上文所述的 wso 命令。进行 access-wizard 部署后，可使用这些 access-wizard 命令来执行常见的实施后任务。access-wizard deploy、resume 和 support-bundle 记录在阶段 3，选项 1 - 使用 Access Wizard 部署 Omnissa Access 中，因为它们是在引导式部署本身的上下文中使用的。对于此处未涵盖的任何操作，请使用上文所述的 wso 命令。

**注意：**仅当使用 Access Wizard 完成了部署时，access-wizard 命令才起作用。

  • access-wizard --help：显示可用 access_wizard 命令的列表。

  • access-wizard status：显示每个部署阶段的状态。

  • access-wizard configure：重新打开第 6 部分（“可选服务”）的问题（SMTP、NTP、NFS 共享存储和证书代理），以便在部署后进行配置或更改。

  • access-wizard show-tokens：显示 Nomad、Consul 和 Vault URL 以及访问令牌。需要交互式终端和确认。

  • access-wizard credentials：针对集群中的每个节点验证共享 configuser 密码。

  • access-wizard verify-control-plane：验证控制平面平台服务的运行状况。

  • access-wizard docs：显示 Omnissa Access 文档 URL 的列表。

常见管理任务

以下示例显示了在部署后如何使用常用的 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 --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 --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 --login_rpm 100 --launch_rpm 100 --wsfed_rpm 100
wso access rate-limit get

轮换证书

使用 wso access rotate-certificate 可轮换 FQDN 或 cert-proxy 证书。仅提供在 /opt/wss/<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 可将 cert-proxy 配置为现有 Access 部署上的实施后操作。仅当 --ssl_certificate_type 为 CUSTOM_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

此页面对您有帮助吗?

对本主题提供反馈

本主题对您有帮助吗?

请勿填写任何个人信息或机密信息。

正在生成链接…