CLI 顶级命令

本节详细介绍了各个顶级命令及其应用。

以下是从 Shell 中按两次 Tab 键时显示的顶级命令：

命令	描述
attach	连接到远程控制器或 SE。类似于 SSH。
clear	清除指定对象的统计信息或值。
configure	创建新对象或修改现有对象，例如虚拟服务、池、配置文件等。
convert	从非 VMware 负载均衡器导入并转换配置。
copy	复制文件，例如数据包捕获或技术支持文件。
debug	更改调试设置或执行数据包捕获。
delete	删除对象。某些对象可能具有依赖关系，必须先解决这些依赖关系。
do	在不退出当前位置或子模式的情况下执行 show 命令。
export	备份系统配置或单个虚拟服务配置。
import	导入备份（导出）的完整配置或特定于虚拟服务的配置。
initialplacement	使用手动放置模式将虚拟服务移至其他 SE。
purge	移除文件，例如数据包捕获或技术支持文件。
rebalance	重新调整 SE 组中处理虚拟服务的 SE。
reboot	重新引导部分或整个系统。还可以擦除配置。
rediscover	特定于 VMware：启动网络和虚拟机的发现。
restart	先停用再重新激活虚拟服务。
scalein	在手动放置模式下减少处理虚拟服务的 SE 数量，减幅为 1。
scaleout	在手动放置模式下增加处理虚拟服务的 SE 数量，增幅为 1。
show	显示有关任意 NSX Advanced Load Balancer 对象的详细信息和统计信息。
switchto	切换到其他租户。
terminal	更改 Shell 的终端设置。
upgrade	启动 NSX Advanced Load Balancer 系统升级。
upload	将指定的技术支持调试文件上载到 VMware。
verifylogin	验证远程 Orchestrator（如 vCenter、APIC 或 OpenStack）的登录设置。
watch	每隔几秒钟更新一次命令（例如 show）的结果。

attach

描述	连接到远程控制器或 SE。类似于 SSH。
示例	Attach serviceengine Avi-se-arjnz
顶级标记
controller	连接到控制器 Shell。
serviceengine	连接到 SE Shell。

configure

描述	创建新对象或修改现有对象，例如虚拟服务、池或配置文件。
示例	: > configure pool Test
顶级标记
actiongroupconfig	创建或修改操作组配置
alertconfig	创建或修改警示配置
alertemailconfig	创建或修改警示电子邮件配置
alertscriptconfig	创建或修改警示脚本配置
alertsyslogconfig	创建或修改警示 Syslog 配置
analyticsprofile	创建或修改分析配置文件
application	创建或修改应用程序
applicationpersistenceprofile	创建或修改应用程序持久性配置文件
applicationprofile	创建或修改应用程序配置文件
authprofile	创建或修改身份验证配置文件
cloud	创建或修改云
cluster	创建或修改集群
controller	创建或修改控制器属性
healthmonitor	创建或修改运行状况监控器
httppolicyset	创建或修改 HTTP 策略集
ipaddrgroup	创建或修改 IP 地址组
network	创建或修改网络
networkprofile	创建或修改网络配置文件
networksecuritypolicy	创建或修改网络安全策略
pkiprofile	创建或修改 PKI 配置文件
pool	创建或修改池
role	创建或修改角色
serviceengine	创建或修改服务引擎
serviceenginegroup	创建或修改服务引擎组
serviceengineproperties	创建或修改服务引擎属性
sslkeyandcertificate	创建或修改 SSL 密钥和证书请求
sslprofile	创建或修改 SSL 配置文件
stringgroup	创建或修改字符串组
systemconfiguration	创建或修改系统配置
tenant	创建或修改租户
user	创建或修改用户
virtualservice	创建或修改虚拟服务
vrfcontext	创建或修改 VRF 上下文
vsdatascriptset	创建或修改虚拟服务 DataScript 集

convert

描述	从非 VMware 负载均衡器导入并转换配置。支持从 F5 BIG-IP 本地流量管理器配置进行转换。导入的虚拟服务将以禁用状态启动，以避免 IP 冲突。
示例	convert bigip_configuration
顶级标记
bigip_ip_addr	BIGIP IP 地址
filename	NSX Advanced Load Balancer 配置文件名
password	BIGIP 密码
username	BIGIP 用户名
virtualservername	转换 virtualserver。名称格式为 /partition/virtualservername

copy

描述	复制文件，例如数据包捕获或技术支持文件。
示例	copy file source/tmp/old destination /tmp/new
顶级标记
source	由原始文件和路径构成的源
destination	由新文件和路径构成的目标

debug

描述	更改调试设置或执行数据包捕获。
示例	: > debug virtualservice Test-VS
顶级标记
controller	特定于控制器的调试选项
serviceengine	特定于服务引擎的调试选项
virtualservice	特定于虚拟服务的调试选项，包括数据包捕获。

delete

描述	删除对象。某些对象可能具有依赖关系，必须先解决这些依赖关系。
示例	delete pool Test-Pool
顶级标记
actiongroupconfig	删除操作组配置
alert	删除警示
alertconfig	删除警示配置
alertemailconfig	删除警示电子邮件配置
alertscriptconfig	删除警示脚本配置
alertsyslogconfig	删除警示 Syslog 配置
application	删除应用程序
applicationpersistenceprofile	删除应用程序持久性配置文件
applicationprofile	删除应用程序配置文件
authprofile	删除身份验证配置文件
cloud	删除云
healthmonitor	删除运行状况监控器
httppolicyset	删除 HTTP 策略集
ipaddrgroup	删除 IP 地址组
networkprofile	删除网络配置文件
networksecuritypolicy	删除网络安全策略
pkiprofile	删除 PKI 配置文件
pool	删除池
role	删除角色
serviceengine	删除服务引擎
serviceenginegroup	删除服务引擎组
sslkeyandcertificate	删除 SSL 密钥和证书请求
sslprofile	删除 SSL 配置文件
stringgroup	删除字符串组
tenant	删除租户
user	删除用户
virtualservice	删除虚拟服务
vrfcontext	删除 VRF 上下文
vsdatascriptset	删除虚拟服务 DataScript 集

do

描述	在不退出当前位置或子模式的情况下执行 show 命令。
示例	do show debug flags virtualservice Test-VS
顶级标记
show	显示有关任意 NSX Advanced Load Balancer 对象的详细信息和统计信息。

export

描述	备份系统配置或单个虚拟服务配置。
示例	export configuration file /tmp/backup_config export virtualservice Test-VS file /tmp/Test-VS
顶级标记
configuration	以 JSON 格式导出整个 NSX Advanced Load Balancer 配置。
serviceengine	从控制器中导出 SE OVA 文件以进行手动安装。
virtualservice	导出包含子对象的特定虚拟服务配置文件。

import

描述	导入备份（导出）的完整配置或特定于虚拟服务的配置。
示例	import configuration file /tmp/backup_config
顶级标记

initialplacement

描述	initialplacement virtualservice Test-VS servicengine Avi-se-arjni
顶级标记
virtualservice	指定要分配给 SE 的虚拟服务。
serviceengine	指定要接收虚拟服务的 SE 的名称。

migrate

描述	使用手动放置（无权访问或读取访问）模式将虚拟服务移至其他 SE
示例	migrate virtualservice Test-VS serviceengine Avi-se-arjni
顶级标记
from_se_ref	指定包含虚拟服务的源 SE 的名称。
to_host_ref	该选项与 to_new_se 一起使用，用于指定要在其中创建新 SE 的主机。
to_new_se	创建一个新 SE 并迁移到该 SE。
to_se_ref	迁移到特定的现有 SE。

purge

描述	移除文件，例如数据包捕获或技术支持文件。
示例	purge file source /tmp/backup_config
顶级标记

rebalance

描述	在自动缩放模式下，设置控制器每隔多长时间检查一次 SE 组，以确认是否必须调整虚拟服务到 SE 的映射，这可能会导致缩减、扩展或迁移。
示例	rebalance interval 10 se_group_ref My_SE_Group
顶级标记
interval	频率（以分钟为单位）。默认值为 5
se_group_ref	要更改的 SE 组的名称。

reboot

描述	重新引导部分或整个 NSX Advanced Load Balancer 系统。还可以删除配置。如果未指定任何标记，将重新引导所有控制器和 SE。
示例
顶级标记
clean	重置 NSX Advanced Load Balancer 系统的配置，然后重新引导集群。应考虑先进行备份。
node	重新引导集群中控制器的虚拟机。
serviceengine	重新引导特定 SE。虚拟服务中断情况将取决于 SE 组的高可用性设置。

rediscover

描述	特定于 VMware：启动网络和虚拟机的发现。
示例	rediscover vcenter My-vCenter
顶级标记

restart

描述	先禁用再立即重新启用虚拟服务。
示例	restart virtualservice Test-VS
顶级标记

scalein

描述	在手动放置模式下减少处理虚拟服务的 SE 数量，减幅为 1。必须至少有一个 SE。
示例	scalein virtualservice Test-VS
顶级标记
from_se_ref	为此虚拟服务指定一个要停止使用的非主 SE。
scalein_primary	将此虚拟服务从主 SE 迁移并停止使用该 SE。

scaleout

描述	在手动放置模式下增加处理虚拟服务的 SE 数量，增幅为 1。
示例	scaleout virtualservice Test-VS
顶级标记
to_host_ref	该选项与 to_new_se 一起使用，用于指定要在其中创建新 SE 的位置。
to_new_se	创建一个新 SE 并扩展到该 SE。
to_se_ref	扩展到现有的 SE。

show

描述	显示有关任意 NSX Advanced Load Balancer 对象的详细信息和统计信息。
示例	show virtualservice Test-VS summary
顶级标记
actiongroupconfig	显示有关操作组配置的信息
alert	显示有关警示的信息
alertconfig	显示有关警示配置的信息
alertemailconfig	显示有关警示电子邮件配置的信息
alertscriptconfig	显示有关警示脚本配置的信息
alertsyslogconfig	显示有关 Syslog 配置的信息
analyticsprofile	显示有关分析配置文件的信息
apic	显示有关 APIC 图形实例的信息
application	显示有关应用程序文件夹的信息
applicationpersistenceprofile	显示有关应用程序持久性配置文件的信息
applicationprofile	显示有关应用程序配置文件的信息
authprofile	显示有关身份验证配置文件的信息
backups	显示可用的备份文件
cloud	显示有关云的信息
cluster	显示有关集群的信息
config-consistency-check	显示 config-consistency-check 状态
config_events	显示有关事件日志的信息
configuration	显示配置
controller	显示控制器属性
cpuusage	显示控制器 CPU 使用情况
debug	显示虚拟服务捕获文件
debug-log	显示服务引擎调试信息
diskusage	显示控制器磁盘使用情况
events	显示有关事件日志的信息
file	显示文件
healthmonitor	显示有关运行状况监控器的信息
httppolicyset	显示有关 HTTP 策略集的信息
ipaddrgroup	显示有关 IP 地址组的信息
jobs	显示所有基于持续时间且处于挂起到期状态的作业。
License	显示有关控制器许可证的信息
logcontrollermapping	显示每个虚拟服务的日志控制器映射
logs-status	显示日志子系统状态
memoryusage	显示控制器内存使用情况
metricsmgr	显示有关衡量指标实体运行时的信息
network	显示有关网络的信息
networkprofile	显示有关网络配置文件的信息
networksecuritypolicy	显示有关网络安全策略的信息
openstack_audit	显示 OpenStack LBaaS 与 Avi 配置审核报告
pkiprofile	显示有关 PKI 配置文件的信息
placement	显示有关 Rm VRF 协议的信息
pool	显示有关池的信息
role	显示有关角色的信息
serviceengine	显示有关服务引擎的信息
serviceenginegroup	显示有关服务引擎组的信息
serviceengineproperties	显示服务引擎属性
seupgrade	显示正在进行的 SE 升级状态
sslkeyandcertificate	显示有关 SSL 密钥和证书的信息
sslprofile	显示有关 SSL 配置文件的信息
stringgroup	显示有关字符串组的信息
systemconfiguration	显示有关系统配置的信息
systemconfigurationruntime	显示有关系统配置运行时的信息
tech-support	显示完整的技术支持
tenant	显示有关租户的信息
terminal	显示终端设置
transaction	显示有关事务统计的更多信息
upgrade	如果有正在进行的升级，则显示升级状态
user	显示有关用户的信息
vcenter	显示有关指定虚拟机的信息
version	显示控制器节点的版本
vinfra	显示有关 VI 数据存储内容的信息
virtualservice	显示有关虚拟服务的信息
vrfcontext	显示有关 VRF 上下文的信息
vsdatascriptset	显示有关虚拟服务 DataScript 集的信息

switchto

描述	切换到其他租户。
示例	switchto tenant Tenant2
顶级标记

terminal

描述	更改 Shell 的终端设置。
示例	terminal session_timeout 240
顶级标记
length	对输出进行分页时显示的行数。比使用管道符和 more 命令显示的行数多。如果不分页，则选择 0。
session_timeout	更改默认的 15 分钟超时，以使空闲终端会话保持打开状态。
timezone	按指定时区显示时间戳。
unhide	命令显示其他标记。不建议随意使用。

upgrade

描述	启动 NSX Advanced Load Balancer 系统升级。这可能是被动式（通过在升级期间迁移每个 SE）操作，也可能是中断式（快速执行，但将终止现有的客户端连接，然后开始升级）操作。
示例	upgrade system image_path /tmp/new_file
顶级标记
system	升级 NSX Advanced Load Balancer 系统
ui	升级 NSX Advanced Load Balancer UI

upload

描述	生成技术支持调试文件并将其上载到 VMware。
示例	upload tech-support debuglogs filter exclude_logs
顶级标记
exclude_archive	排除已存档的备份。
exclude_logs	排除可能非常大的客户端日志文件（虚拟服务日志）。
include_se	包含可能存储在 SE 上的（非重要）日志。

verifylogin

描述	验证远程 Orchestrator（如 vCenter、APIC 或 OpenStack）的用户名、密码和路径。
示例	verifylogin vcenter username admin password secret vcenter_url 10.1.1.1/login
顶级标记
apic	验证对 APIC 控制器的访问权限。
openstack	验证对 OpenStack 的访问权限。
vcenter	验证对 VMware vCenter 控制器的访问权限。

watch

描述	每隔几秒钟更新一次命令（例如 show）的结果。
示例	watch show pool Test-pool server detail | grep -e 'ip\| open_conns'
顶级标记
show	选择有效的 show 命令语法以进行更新。