WAE CLI の概要
WAE は、WAE YANG ファイルで記述されたデータモデルを使用して自動的にレンダリングされるネットワーク CLI を提供します。CLI には、ネットワーク構成を操作するためのコマンドが含まれています。CLI は完全にデータモデル駆動型です。YANG モデルは構成要素の階層を定義します。CLI はこのツリーに従います。CLI には、管理対象デバイスのハードウェアおよびネットワーク接続を構成するためのさまざまなコマンドが用意されています。
CLI は 2 つのモードをサポートしています。WAE ノードの状態を監視するための動作モードと、ネットワークの状態を変更するための構成モードです。プロンプトは、CLI がどのモードにあるかを示します。configure コマンドを使用して動作モードから構成モードに移行すると、プロンプトが user@wae# から user@wae(config)# に変化します。プロンプトは、wae.conf ファイルの c-prompt1 および c-prompt2 設定を使用して構成できます。
次に例を示します。
admin@wae# configure
Entering configuration mode terminal
admin@wae(config)#
動作モード(Operational Mode)
動作モードは、CLI へのログインに成功した後の初期モードです。これは主に、システムステータスの表示、CLI 環境の制御、ネットワーク接続の監視とトラブルシューティング、および構成モードの開始に使用されます。
次のコマンドは、動作モードで使用できる基本コマンドです。追加のコマンドは、ロードされた YANG ファイルからレンダリングされます。
<path> <parameters>
指定された parameters を使用して、path で見つかったアクションを呼び出します。このコマンドは YANG ファイルから自動生成されます。たとえば、YANG ファイルに次のアクション指定があるとします。
tailf:action shutdown {
tailf:actionpoint actions;
input {
tailf:constant-leaf flags {
type uint64 {
range "1 .. max";
}
tailf:constant-value 42;
}
leaf timeout {
type xs:duration;
default PT60S;
}
leaf message {
type string;
}
container options {
leaf rebootAfterShutdown {
type boolean;
default false;
}
leaf forceFsckAfterReboot {
type boolean;
default false;
}
leaf powerOffAfterShutdown {
type boolean;
default true;
}
}
}
}
このアクションは、次の方法で呼び出すことができます。
user@wae> shutdown timeout 10s message reboot options { \
forceFsckAfterReboot true }
組み込みの動作モードコマンド
コマンド |
説明 |
commit (abort | confirm) |
保留中の確認コミットを中止または確認します。commit confirm を実行せずに CLI セッションが終了した場合、保留中の確認コミットは中止されます。デフォルトは confirm です。例:
|
config (exclusive | terminal) [no-confirm] |
構成モードを開始します。デフォルトは terminal です。
例:
|
file list <directory> |
ディレクトリ内のファイルを一覧表示します。例:
|
file show <file> |
ファイルの内容を表示します。例:
|
help <command> |
コマンドのヘルプテキストが表示されます。例:
|
job stop <job id> |
特定のバックグラウンドジョブを停止します。デフォルトの CLI では、バックグラウンドジョブを作成するコマンドは monitor start だけです。例:
|
logout session <session ID> |
WAE から特定のユーザーセッションをログアウトします。ユーザーが構成排他ロックを保持している場合、ロックは解放されます。例:
|
logout user <username> |
WAE から特定のユーザーをログアウトします。ユーザーが構成排他ロックを保持している場合、ロックは解放されます。例:
|
script reload |
scripts/command ディレクトリにあるスクリプトをリロードします。新しいスクリプトが追加されます。スクリプトファイルが削除されている場合、対応する CLI コマンドは消去されます。 |
send (all | <user>) <message> |
デバイスにログインしているすべてのユーザーの画面または特定の画面にメッセージを表示します。
例:
oper ユーザーの画面には、次のメッセージが表示されます。
|
show cli |
CLI プロパティを表示します。例:
|
show history [<limit>] |
CLI コマンドの履歴を表示します。デフォルトでは、最新の 100 個のコマンドが一覧表示されます。履歴リストのサイズは、history CLI 設定を使用して構成されます。履歴制限が指定されている場合、その制限までの最新のコマンドのみが表示されます。例:
|
show jobs |
現在バックグラウンドで実行中のジョブを表示します。例:
|
show log <file> |
ログファイルの内容を表示します。例:
|
show parser dump <command prefix> |
指定されたコマンドプレフィックスで始まるすべての可能なコマンドを表示します。 |
show running-config [ <path filter> [ sort-by <idx> ] ] |
現在の設定を表示します。デフォルトでは、構成全体が表示されます。パスフィルタを指定することで、表示される内容を制限できます。パスフィルタでは、特定のインスタンスを指すパスを使用することも、またはインスタンス ID を省略した場合は、省略されたインスタンス以降の部分をフィルタとして扱うこともできます。 sort-by 引数は、パスフィルタがセカンダリインデックスを持つリスト要素を指す場合に使用できます。セカンダリインデックスの名前は idx です。使用すると、テーブルはセカンダリインデックスで定義された順序で並べ替えられます。これにより、インスタンスを表示する順序を制御できます。 たとえば、管理者ユーザーの aaa 設定を表示するには:
グループ ID 1000 のすべてのユーザーを表示し、ユーザー ID を省略して代わりに gid 1000 を指定するには:
|
show <path> [ sort-by <idx> ] |
パスがリスト要素につながり、データをテーブルとしてレンダリングできる(つまり、テーブルが画面に収まる)場合、構成をテーブルとして表示します。| tab パイプコマンドを使用して、リストのテーブルフォーマットを強制することもできます。 sort-by 引数は、パスがセカンダリインデックスを持つリスト要素を指す場合に使用できます。セカンダリインデックスの名前は idx です。使用すると、テーブルはセカンダリインデックスで定義された順序で並べ替えられます。これにより、インスタンスを表示する順序を制御できます。例:
|
source <file> |
ユーザーが入力したかのように、指定されたファイルからコマンドを実行します。ファイルからコマンドを実行する場合、autowizard は無効になります。 |
timecmd <command> |
コマンドの実行時間を測定して表示します。timecmd は、CLI セッション設定で devtools が true に設定されている場合にのみ使用できることに注意してください。例:
|
who |
現在、ログオンしているユーザーを表示します。現在のセッション(show status コマンドを実行しているセッション)には、アスタリスクが付いています。例:
|
構成モード
構成モードは、動作モードで configure コマンドを入力することで開始できます。ネットワーク構成に対するすべての変更は、アクティブな構成のコピーに対して行われます。これらの変更は、コミットまたはコミット確認コマンドが正常に入力されるまで有効になりません。
次のコマンドは、構成モードで使用できる基本コマンドです。追加のコマンドは、ロードされた YANG ファイルからレンダリングされます。
<path> [<value>]
パラメータを設定します。新しい識別子が作成され、autowizard が enabled の場合、CLI は、その識別子のすべての必須サブ要素についてユーザーにプロンプトを表示します。このコマンドは YANG ファイルから自動生成されます。
<value> が提供されていない場合、CLI はその値についてユーザーにプロンプトを表示します。<path> が tailf-common.yang データモデルで記述されている MD5DigestString、DESDigestString、DES3CBCEncryptedString、または AESCFB128EncryptedString 型の暗号化された値である場合、入力された値のエコーは発生しません。
組み込みの構成モードコマンド
コマンド |
説明 |
||
annotate <statement> <text> |
注釈を特定の構成に関連付けます。注釈を削除するには、テキストを空のままにします。このコマンドは、システムが属性を有効にして構成されている場合にのみ使用できます。 |
||
commit (check | and-quit | confirmed |to-startup) [comment <text>] [label <text>] |
現在の構成をコミットして running にします。
|
||
copy <instance path> <new id> |
インスタンスのコピーを作成します。 |
||
copy cfg [ merge | overwrite] <src path> to <dest path> |
ある構成ツリーから別の構成ツリーにデータをコピーします。接続先で意味のあるデータのみがコピーされます。コピーできないデータについてはエラーメッセージは生成されず、操作はエラーメッセージが生成されずに完全に失敗する可能性があります。たとえば、デバイス構成の一部からテンプレートを作成するには、最初にデバイスを構成してから、構成をテンプレート構成ツリーにコピーします。例:
|
||
copy compare <src path> to <dest path> |
2 つの任意の構成ツリーを比較します。送信元ツリーにのみ表示される項目は無視されます。 |
||
delete <path> |
データ要素を削除します。 |
||
do <command> |
コマンドを動作モードで実行します。 |
||
edit <path> |
サブ要素を編集します。パスに欠落している要素が作成されます。 |
||
exit (level | configuration-mode) |
|
||
help <command> |
コマンドのヘルプテキストを表示します。 |
||
hide <hide-group> |
非表示グループに属する要素とアクションを再度非表示にします。非表示にするのにパスワードは必要ありません。このコマンドは非表示であり、コマンドの完了時に表示されません。 |
||
insert <path> |
新しい要素を挿入します。要素がすでに存在し、データモデルに indexedView オプションが設定されている場合、古い要素の名前が element+1 に変更され、新しい要素がその場所に挿入されます。 |
||
insert <path>[ first | last | before <key> | after <key>] |
順序付きリストに新しい要素を挿入します。要素は、先頭、末尾(デフォルト)、別の要素の前または後に追加できます。 |
||
load (merge | override) (terminal | <file>) |
ファイルまたは端末から構成をロードします。
たとえば、現在の構成が次のようであるとします。
エントリ GigabitEthernet 0/0/0/0 の shutdown 値が削除されます。構成ファイルは、間にコメントが挿入された一連のコマンドであるため、構成ファイルは次のようになります。
その後、このファイルをコマンド load merge FILENAME で使用して、目的の結果を得ることができます。 |
||
move <path>[ first | last | before <key> | after <key>] |
既存の要素を順序付きリストの新しい位置に移動します。要素は、先頭、末尾(デフォルト)、別の要素の前または後に移動できます。 |
||
rename <instance path> <new id> |
インスタンスの名前を変更します。 |
||
revert |
実行構成を現在の構成にコピーし、コミットされていないすべての変更を削除します。 |
||
rload (merge | override) (terminal | <file>) |
現在のサブモードに関連するファイルをロードします。たとえば、ファイルにデバイス構成がある場合、1 つのデバイスに入り、rload merge/override <file> コマンドを発行してそのデバイスの構成をロードし、次に別のデバイスに入り、rload を使用して同じ構成ファイルをロードできます。 load コマンドも参照してください。
|
||
rollback configuration [<number>] [<path>] |
構成を以前にコミットされた構成に戻します。wae.conf ファイルに保存する古い構成の数を構成できます。保存する構成がしきい値を超えると、新しい構成を作成する前に最も古い構成が削除されます。構成の変更はロールバックファイルに保存され、最新の変更は最大の番号 N を持つファイル rollbackN に保存されます。 デルタのみがロールバックファイルに保存されます。構成をロールバック N にロールバックすると、rollback10001 ~ rollbackN に保存されているすべての変更が適用されます。オプションの path 引数を使用すると、構成ツリーの残りの部分を変更せずに、サブツリーをロールバックできます。 このコマンドは、wae.conf でロールバックが有効になっている場合にのみ使用できます。例:
|
||
rollback selective [<number>] [<path>] |
rollback10001 から rollbackN までのすべての変更を元に戻す代わりに、特定のロールバックファイルに保存されている変更のみを元に戻すことができます。場合によっては、ロールバックファイルの適用に失敗したり、構成を有効にするために追加の変更が必要になったりすることがあります。 オプションの path 引数を使用すると、構成ツリーの残りの部分を変更せずに、サブツリーをロールバックできます。 |
||
show full-configuration [<pathfilter> [sort-by <idx>]] |
ローカルの変更を考慮して、現在の構成を表示します。パスフィルタを指定することにより、show コマンドを構成の一部に制限できます。sort-by 引数は、パスフィルタがセカンダリインデックスを持つリスト要素を指す場合に指定できます。セカンダリインデックスの名前は idx です。使用すると、テーブルはセカンダリインデックスで定義された順序で並べ替えられます。これにより、インスタンスを表示する順序を制御できます。 |
||
show configuration [<pathfilter>] |
構成に対する現在の編集を表示します。 |
||
show configuration merge [<pathfilter> [sort-by <idx>]] |
ローカルの変更を考慮して、現在の構成を表示します。パスフィルタを指定することにより、show コマンドを構成の一部に制限できます。sort-by 引数は、パスフィルタがセカンダリインデックスを持つリスト要素を指す場合に指定できます。セカンダリインデックスの名前は idx です。使用すると、テーブルはセカンダリインデックスで定義された順序で並べ替えられます。これにより、インスタンスを表示する順序を制御できます。 |
||
show configuration commit changes [<number> [<path>]] |
コミットに対して作成されたロールバック番号によって識別される、そのコミットに関連付けられた編集を表示します。変更を元に戻すためのコマンドを表示する show configuration rollback changes とは対照的に、変更は前方変更として表示されます。オプションの path 引数を使用すると、特定のサブツリーに関連する編集のみをリストできます。 |
||
show configuration commit list [<path>] |
ロールバックファイルをリストします。オプションの path 引数を使用すると、特定のサブツリーに関連するロールバックファイルのみをリストできます。 |
||
show configuration rollback listed [<number>] |
ロールバックファイルに関連付けられたコミットで実行された変更を元に戻すために必要な操作を表示します。これらは、構成がそのロールバック番号にロールバックされた場合に適用される変更です。 |
||
show configuration running [<pathfilter>] |
コミットされていない変更を考慮せずに実行構成を表示します。オプションのパスフィルタを指定して、表示する内容を制限できます。 |
||
show configuration diff [<pathfilter>] |
追加および削除された構成行の前に + と - を付けて、実行構成に対するコミットされていない変更を差分形式で表示します。 |
||
show parser dump <command prefix> |
コマンドプレフィックスで始まるすべての可能なコマンドを表示します。 |
||
tag add <statement> <tag> |
構成ステートメントにタグを追加します。このコマンドは、システムが属性を有効にして構成されている場合にのみ使用できます。 |
||
tag del <statement> <tag> |
構成ステートメントからタグを削除します。このコマンドは、システムが属性を有効にして構成されている場合にのみ使用できます。 |
||
tag clear <statement> |
構成ステートメントからすべてのタグを削除します。このコマンドは、システムが属性を有効にして構成されている場合にのみ使用できます。 |
||
timecmd <command> |
コマンドの実行時間を測定して表示します。このコマンドは、CLI セッション設定で devtools が true に設定されている場合にのみ使用できます。例:
|
||
top [<command>] |
構成の最上位に戻るか、構成の最上位でコマンドを実行します。 |
||
unhide <hide-group> |
非表示グループに属するすべての要素とアクションを再表示します。パスワードが必要な場合があります。このコマンドは非表示であり、コマンドの完了時に表示されません。 |
||
validate |
現在の構成を検証します。commit check と同じ動作です。 |
||
xpath [ctx <path>] (eval | must | when) <expression> |
XPath 式を評価します。context-path は、式の評価のための現在のコンテキストとして使用できます。context-path が指定されていない場合、現在のサブモードが context-path として使用されます。パイプコマンドトレースを使用して、デバッグ情報またはトレース情報を表示できます。このコマンドは、CLI セッション設定で devtools が true に設定されている場合にのみ使用できます。
|