CLI のトップレベル コマンド

このセクションでは、トップレベル コマンドとその応用方法について詳しく説明します。

以下に示すのは、シェルから Tab キーを 2 回押したときに表示されるトップレベル コマンドです。

コマンド	説明
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	シェルのターミナル設定を変更します。
upgrade	NSX Advanced Load Balancer システムのアップグレードを開始します。
upload	指定したテクニカル サポート デバッグ ファイルを VMware にアップロードします。
verifylogin	vCenter、APIC、OpenStack などのリモート オーケストレータへのログイン設定を検証します。
watch	show などのコマンドの結果を数秒ごとに更新します。

attach

説明	リモート コントローラまたは SE に接続します。SSH に似ています。
例	Attach serviceengine Avi-se-arjnz
トップ レベル フラグ
controller	コントローラ シェルに接続します。
serviceengine	SE シェルに接続します。

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	仮想サーバを変換します。名前は /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	NSX Advanced Load Balancer 構成全体を JSON 形式でエクスポートします。
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	新しい SE を作成するホストを指定する、to_new_se とともに使用されるオプション。
to_new_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 つ減らします。少なくとも 1 つの SE が必要です。
例	scalein virtualservice Test-VS
トップ レベル フラグ
from_se_ref	この仮想サービスについて使用を停止する、プライマリ以外の SE を指定します。
scalein_primary	プライマリ SE から移行し、この仮想サービスについて SE の使用を中止します。

scaleout

説明	手動配置で仮想サービスを処理する SE の数を 1 つ増やします。
例	scaleout virtualservice Test-VS
トップ レベル フラグ
to_host_ref	新しい SE を作成する場所を指定する、to_new_se とともに使用されるオプション。
to_new_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	期限切れが保留中のすべての期間ベースのジョブを表示します。
ライセンス	コントローラ ライセンスに関する情報を表示します。
logcontrollermapping	各仮想サービスのログ コントローラのマッピングを表示します。
logs-status	ログ サブシステムの状態を表示します。
memoryusage	コントローラのメモリ使用率を表示します。
metricsmgr	メトリック エンティティ ランタイムに関する情報を表示します。
network	ネットワークに関する情報を表示します。
networkprofile	ネットワーク プロファイルに関する情報を表示します。
networksecuritypolicy	ネットワーク セキュリティ ポリシーに関する情報を表示します。
openstack_audit	OpenStack LBaaS と Avi 構成の監査レポートを表示します。
pkiprofile	PKI プロファイルに関する情報を表示します。
placement	Rm VRF Proto に関する情報を表示します。
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

説明	シェルのターミナル設定を変更します。
例	terminal session_timeout 240
トップ レベル フラグ
length	ページネーション出力に表示する行数。「より大きい」を使用すると、より多くにパイプ処理されます。ページネーションを行わない場合は 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 のユーザー インターフェイスをアップグレードします。

upload

説明	テクニカル サポート デバッグ ファイルを生成して、VMware にアップロードします。
例	upload tech-support debuglogs filter exclude_logs
トップ レベル フラグ
exclude_archive	アーカイブされたバックアップを除外します。
exclude_logs	クライアント ログ ファイル（仮想サービス ログ）を除外します。このファイルはサイズが非常に大きい場合があります。
include_se	インクルード ログ（重要でないログ）は SE に保存できます。

verifylogin

説明	ユーザー名、パスワード、および vCenter、APIC、OpenStack などのリモート オーケストレータへのパスを検証します。
例	verifylogin vcenter username admin password secret vcenter_url 10.1.1.1/login
トップ レベル フラグ
apic	APIC コントローラへのアクセスを確認します。
openstack	OpenStack へのアクセスを確認します。
vCenter Server	VMware vCenter コントローラへのアクセスを確認します。

watch

説明	show などのコマンドの結果を数秒ごとに更新します。
例	watch show pool Test-pool server detail | grep -e 'ip\| open_conns'
トップ レベル フラグ
show	更新する有効な show コマンド構文を選択します。