CLI 快速参考
本节是 PubSub+ 软件事件代理和设备最常用命令行界面（CLI）命令的快速指南.有关 CLI 命令的详细列表，请参阅软件事件代理 CLI 命令和设备 CLI 命令.
Solace CLI 命令遵循一些基本约定（请参阅文档约定）.省略号（...）用于表示接受参数的命令.
有关如何使用 CLI 的详细信息，请参阅 Solace CLI.
命令级别锚点
四个命令级别构成了 CLI 命令层次结构.在以下示例中，solace 是事件代理的名称.
导航 CLI 锚点
在任何级别使用这些命令在命令层次结构中上下移动.
| 命令 | 功能 |
|---|---|
<br>exit<br> | 退出当前命令级别并返回到上一级别 |
<br>end<br> | 退出当前 CONFIG 命令级别并返回到特权 EXEC 级别 |
<br>home<br> | 退出当前命令级别并返回到用户 EXEC 级别 |
<br>create <thing><br> | 创建一个对象 |
<br>no <thing><br> | 删除一个对象或将其重置为其默认值 |
仅限设备锚点
启动命令锚点
所有启动命令都会影响服务.请谨慎操作.
在升级设备时，始终遵循文档化的程序.
| 命令| 功能|
| <br>reload<br>| 重启设备|
| <br>reload [config|default-config]<br>| 将系统配置设置为备份配置或系统默认配置|
| <br>boot <version><br>| 更改（升级或降级）SolOS|
| <br>power-down<br>| 关闭设备（不重启）|
首次配置锚点
setup 命令用于设置设备的主机名、接口、时钟和时区.
软件代理和设备锚点
帮助命令锚点
在任何级别使用这些命令以访问有关可用 CLI 命令的信息.
| 命令| 功能|
| ?, Tab, 或 tree| 显示当前级别的命令|
| ??, ??help, 或 tree all| 显示当前和全局级别的命令|
| tree global| 显示全局级别的命令|
| <partial-command> + Tab| 完成部分命令|
| <command> + Space + ?| 提供有关特定命令的详细帮助|
您可以在 CLI 命令中使用 * 或 ? 作为通配符自动完成对象名称.* 字符可以匹配 0 个或更多未知字符，而 ? 字符只能匹配一个未知字符.
显示命令锚点
在任何级别使用这些命令以查看事件代理服务中的不同状态.
| 命令| 功能|
| <br>show ip vrf...<br>| 显示 IP 地址|
| <br>show client...<br>| 显示客户端信息|
| <br>show queue...<br>| 显示队列信息|
| <br>show message-vpn...<br>| 显示消息 VPN 信息|
| <br>show redundancy...<br>| 显示冗余配置|
| <br>show message-spool...<br>| 显示消息转盘状态|
| <br>show version<br>| 显示当前 SolOS 版本信息|
| <br>show interface...<br>| 显示接口配置的参数|
| <br>show log<br>| 显示消息代理日志|
| <br>show hardware...<br>| 显示设备信息|
文件和目录锚点
这是 CLI 中常见目录的列表：
certs：证书文件configs：配置备份loads：SolOS 软件加载logs：日志文件
| 命令| 功能|
| cd, dir, pwd| 目录导航|
| rename...| 重命名文件及其路径名|
| 为支持票创建调试包 |
| 此命令帮助您报告事件代理服务中的错误： |
保存配置锚点
在事件代理的任何级别使用这些命令以查看和管理配置文件.
| 命令| 功能|
| <br>show current-config<br>| 查看有关事件代理的配置和统计信息|
| <br>backup<br>| 创建当前配置的手动本地备份|
| <br>schedule [backup...]<br>| 安排定期自动本地配置备份|
| <br>copy...<br>| 将文件复制到事件代理和从事件代理复制|
接口和 IP 锚点
使用这些 CONFIG 命令管理虚拟接口或链路聚合组（LAG）.
| 命令| 功能|
| <br>(configure)# [create] interface...<br>| 创建虚拟接口或 LAG|
| <br>(configure)# no interface...<br>| 删除接口|
| <br>(configure/interface)# member<br>| 将 LAG 或物理接口添加到 LAG（设备）|
| <br>(configure/interface)# primary-member<br>| 选择哪个 LAG 成员是活动-备份模式的主成员（设备）|
| <br>(configure/ip/vrf/interface)# ip-address<br>| 为接口分配 IP 地址（设备）|
冗余锚点
使用这些 CONFIG 命令管理冗余对之间的服务.
| 命令| 功能|
| <br>(configure/redundancy)# release-activity<br>| 永久将活动权让给配对事件代理|
| <br>(configure/redundancy)# no release-activity<br>| 停止将活动权让给配对事件代理|
| <br>(admin/redundancy)# revert-activity<br>| 如果主事件代理准备好提 供服务，则强制备份事件代理放弃活动|
消息传递锚点
消息传递客户端
使用这些 CONFIG 命令管理消息传递客户端配置文件.
| 命令| 功能|
| <br>(configure)# create client-username<br>| 创建消息传递客户端用户名|
| <br>(configure)# no client-username<br>| 删除消息传递客户端用户名|
| <br>(configure)# create client-profile<br>| 创建客户端用户名特征的配置文件|
| <br>(configure)# create acl-profile<br>| 创建新的访问控制列表（ACL）配置文件|
消息转盘
使用这些 CONFIG 命令管理保证消息传递.
| 命令| 功能|
| <br>(configure)# hardware message-spool...<br>| 设置全局消息转盘|
| <br>(configure/hardware/message-spool)# shutdown<br>| 停止所有保证消息传递|
| <br>(admin/system/message-spool)# reset<br>| 删除所有转盘消息并软重置消息转盘系统.请谨慎使用.|
| <br>(admin/message-spool)# delete-messages<br>| 删除当前转盘的消息|
| <br>(configure/message-spool/message-vpn)# create queue<br>| 创建队列|
消息 VPN
使用这些 CONFIG 命令管理消息 VPN.
| 命令| 功能|
| <br>(configure)# create message-vpn...<br>| 创建消息 VPN|
| <br>(configure)# no message-vpn...<br>| 删除消息 VPN|
| <br>(configure/message-vpn)# authentication user-class client<br>| 设置认证方法|
VPN 桥接
VPN 桥接用于持久消息桥接，以及通过订阅的直接消息.
使用这些 CONFIG 命令管理 VPN 桥接.
多节点路由（MNR）链接仅传输直接消息.
| 命令| 功能|
| <br>(configure)# create bridge<br>| 创建 VPN 桥接|
| <br>(configure)# no bridge<br>| 删除 VPN 桥接|
| <br>(configure/bridge)# create remote message-vpn...<br>| 将远程消息 VPN 分配给桥接|
| <br>(configure/bridge/remote/message-vpn)# message-spool queue...<br>| 将桥接绑定到远程消息 VPN 中的队列，以通过桥接从队列中提取保证消息|
| <br>(configure/bridge)# subscription-topic<br>| 在 VPN 桥接上创建订阅以通过桥接提取直接消息|
| 清除统计信息 |
使用 clear... 命令清除统计计数器.这可以在全局、消息-vpn、客户端、队列或其他对象级别进行. |
| 示例： |
端点管理
使用这些 CONFIG 命令管理端点.
| 命令| 功能|
| <br>(configure/message-spool)# create queue...<br>| 创建队列|
| <br>(configure/message-spool)# no queue...<br>| 删除队列|
| <br>(configure/message-spool/queue)# subscription topic<br>| 更改队列上的订阅|
| <br>(admin/message-spool)# delete-messages<br>| 删除端点上的消息|
用户管理锚点
使用这些 CONFIG 命令管理用户.
| 命令| 功能|
| <br>(configure)# create username...<br>| 创建管理员用户|
| <br>(configure)# create client-username...<br>| 创建消息传递客户端用户|
示例：
创建用于将文件复制到/从事件代理的用户：
(configure)# create username...password...file-transfer
CLI 编辑快捷键锚点
使用这些键盘快捷键浏览和编辑 CLI 行.
| 命令| 功能| | 上箭头 或 Ctrl+P Ctrl+P| 移动到上一个历史命令| | 下箭头 或 Ctrl+N| 移动到下一个历史命令| | 左箭头 或 Ctrl+T| 向左移动| | 右箭头 或 Ctrl+F| 向右移动| | Home 或 Ctrl+A| 移动到行首| | End 或 Ctrl+E| 移动到行尾| | Esc+B, Esc+F| 向后或向前移动一个单词|