コマンドの記述形式
各コマンドは以下の形式に従って記述しています。
[機能]
コマンドの使用用途を記述しています。
[入力形式]
コマンドの入力形式を定義しています。この入力形式は,次の規則に基づいて記述しています。
-
値や文字列を設定するパラメータは,<>で囲みます。
-
<>で囲まれていない文字はキーワードで,そのまま入力する文字です。
-
{A|B}は,「AまたはBのどちらかを選択」を意味します。
-
[]で囲まれたパラメータやキーワードは「省略可能」を意味します。
-
パラメータの入力形式を,「パラメータに指定できる値」に示します。
[入力モード]
コマンドを入力できる入力モードを記述しています。
[パラメータ]
コマンドで設定できるパラメータを詳細に説明しています。「すべてのパラメータ省略時の動作」とした項目では,省略可能なパラメータをすべて同時に省略した場合の動作について説明しています。
「本パラメータ省略時の動作」とした項目では,パラメータ単位に省略した場合の個別の動作について記述しています。また,複数のパラメータについて,パラメータ単位に省略した場合の個別の動作を「各パラメータ省略時の動作」とした項目にまとめて記述することがあります。
[スタック構成時の運用]
スタック構成時の動作について記述しています。
remote commandコマンドを使用できるコマンドには,それぞれのコマンドの入力形式を記述しています。remote commandコマンド全般についての入力モードや注意事項は,remote commandコマンドの記載を参照してください。
[実行例]
コマンド使用方法の例を適宜に挙げています。
[表示説明]
実行例で示す表示内容についての説明を記述しています。
スタック構成時に,各コマンドの[実行例]でコマンドの実行結果に表示されるSwitch表示の説明を,次の表に示します。
表示項目 |
意味 |
表示詳細情報 |
---|---|---|
Switch |
スイッチ番号。括弧はスイッチ状態。 |
スイッチ番号 スイッチ状態 Init:スタック構成中 Master:スタック構成(マスタ) Backup:スタック構成(バックアップ) -------:スタック構成外 |
各コマンドの[実行例]で,コマンドの実行直後に表示されるDate表示の説明を,次の表に示します。
表示項目 |
表示内容 意味 |
---|---|
Date |
yyyy/mm/dd hh:mm:ss timezone 年/月/日 時:分:秒 タイムゾーン コマンドを受け付けた時刻を表示 |
本装置は,コンフィグレーションで設定されたインタフェースに対して,対応する名称を付与します。[表示説明]に<interface name>と記載されている場合,本装置は次の表に示すインタフェース名を表示します。
入力形式 |
インタフェース名<interface name> |
---|---|
interface gigabitethernet |
geth1/1/1 数値は<switch no.>/<nif no.>/<port no.>です。 |
interface tengigabitethernet |
tengeth1/1/24 数値は<switch no.>/<nif no.>/<port no.>です。 |
interface fortygigabitethernet |
ftygeth1/0/1 数値は<switch no.>/<nif no.>/<port no.>です。 |
interface port-channel |
ChGr10 数値は<channel group number>です。 |
interface vlan <vlan id> |
VLAN0002 下4桁の数値は<vlan id>です。 |
interface vxlan <vtep id>【OS-L3CA】 |
VTEP ID <vtep id> |
interface loopback 0 |
loopback0 |
interface loopback <loopback id>【OS-L3CA】 |
loopback1 数値は<loopback id>です。 |
interface null 0 |
null0 |
interface mgmt 0 |
MGMT0 |
interface async 1 |
ASYNC1 |
[通信への影響]
コマンドの設定により通信が途切れるなど通信に影響がある場合,本欄に記述しています。
[応答メッセージ]
コマンド実行後に表示される応答メッセージの一覧を記述しています。
ただし,入力エラー位置指摘で表示されたエラーメッセージはここでは記述しないで,「入力エラー位置指摘で表示するメッセージ」で別途掲載してあります。
本装置は,コンフィグレーションで設定されたインタフェースに対して,対応する名称を付与します。[応答メッセージ]に<interface name>と記載されている場合,本装置は「表1‒3 入力形式に対して付与するインタフェース名一覧」に示すインタフェース名を表示します。
[注意事項]
コマンドを使用する上での注意点について記述しています。