[index] SwitchBlade x3100シリーズ コマンドリファレンス

SwitchBlade x3100シリーズ コマンドリファレンス


このたびは、SwitchBlade x3100シリーズをお買い上げいただき、誠にありがとうございます。

本マニュアルでは、SwitchBlade x3100シリーズ用ファームウェアの機能とコマンドについて詳細に解説しています。各機能の使用方法やコマンドの解説に加え、複数の機能を組み合わせた具体的な設定例も数多く掲載しています。SwitchBlade x3100シリーズを活用するための参考資料としてご利用ください。

なお、設定を行う前に必要なこと、たとえば機器の設置や配線、設定に使用するコンソールターミナルの準備などについては原則として説明しておりません。これらに関しては、製品付属の冊子「取扱説明書」などをご覧ください。


はじめに

対象機種とバージョン

本マニュアルは、以下の機種用のファームウェアバージョン「17.1.0」を対象に記述されていますが、執筆時には開発中のバージョンを用いたため、画面表示などが実際の製品とは異なる場合があります。また使用例に関しては過去のバージョンのものが記載されている場合があります。あらかじめご了承ください。


製品のご使用にあたっては、必ず弊社ホームページに掲載のリリースノートや添付書類をお読みになり、最新の情報をご確認ください。リリースノートや添付書類には、機種やバージョンごとの注意事項や最新情報が記載されています。

本製品はファームウェアのコマンドリファレンスであるため、機種ごとのハードウェア構成の違い(ポート数など)には依存しないよう作成してありますが、設定例などでは特定の機種を想定して記述している場合があります。このような箇所については、適宜ポート番号等を読み替えてくださいますようお願いいたします。

サポート機能と制限事項

ファームウェアのバージョンやハードウェアのリビジョンにより、サポート対象となる機能の範囲が異なる場合があります。原則として、本マニュアルに記載されていない機能、コマンドはサポート対象外です。また、本マニュアルに記載されている機能やコマンドでも、サポート対象外となることがあります。各バージョンにおけるサポート機能や制限事項については、弊社ホームページに掲載のリリースノートや添付書類でご確認ください。また、機能によってはフィーチャー(追加機能)ライセンスを必要とするものもありますので、そちらもあわせてご確認ください。

マニュアルの提供形態

本マニュアルはHTML(Hyper Text Markup Language)形式のオンラインマニュアルです。弊社Webサイトにて最新バージョンを見ることができます。印刷物としては提供しておりませんので、必要な場合はHTMLファイルをプリンターで出力してご使用ください。

本マニュアルをご覧になるには、Microsoft Internet ExplorerやMozilla FirefoxなどのWebブラウザーが必要です。HTMLフレームとスタイルシート(CSS)を使用しているため、これらに対応したブラウザーが必要ですが、JavaScriptなどのスクリプト言語や、Javaアプレット等は使用しておりませんので、これらの機能はオフでもかまいません。

本マニュアルは、ハイパーリンク機能を利用して、あるコマンドから関連する別のコマンドへジャンプしたり、機能解説のページからコマンドリファレンスへジャンプできるように作成してあります。

マニュアルの構成

本マニュアルの構成について説明します。

章構成

まず、本マニュアルは大きな機能ごとに章が分けられています。

画面上部のフレームに表示されている項目([運用・管理]など)が各章へのリンクになっています。章名をクリックすると、画面左側のフレームに該当する章の機能別索引が表示されます。索引上のリンクをクリックすることにより、画面右側のフレームにコマンドや機能の解説が表示されます。

章内の構成

各章は、大きく分けて「機能解説編」と「コマンドリファレンス編」の2つの部分から構成されています。

機能解説編(以下、解説編)は、それぞれの機能において使用するコマンドや設定手順、注意点、具体的な設定例などを解説したものです。通常、1つの機能を使用するには複数のコマンドを組み合わせて使う必要があります。コマンドリファレンス編では個々のコマンドについて詳細に解説していますが、これをどう組み合わせて使用するかについては最小限しか述べられていません。最初に実現したいことが決まっている場合は、解説編で概要をつかんでから各コマンドの詳細解説に目を通すのがよいでしょう。解説編では、必要に応じて具体的な設定例ものせています。左側フレームのコマンド索引にある機能別見出しが該当機能の解説編へのリンクになっています。

コマンドリファレンス編は、コマンドごとに構文、機能、パラメーター、実行例、注意事項などをまとめたものです。各コマンドが1つのHTMLファイル(Webページ)になっています。解説編と同様に、左側フレームのコマンド名をクリックすると、右側フレームに該当するコマンドのページが表示されます。

表記について

本マニュアルにおける各種表記について説明します。

コマンド名

本マニュアルでは、識別のため各コマンドに名前を付けています。

コマンド名は、コマンド構文のうち入力が必須の部分から付けたものが大部分ですが、中にはそれでは識別できないものもあります。そのような場合は、補助的な情報をカッコ付きで付加することにより区別しています。

いずれの場合も、文中のコマンド名はコマンドリファレンス編へのリンクになっています。

コマンド構文

コマンドリファレンス編では、以下の基準にしたがってコマンドの構文を表記しています。

表 1
KEYWORD キーワード 黒大文字の部分はキーワード(予約語)を示します。基本的にそのまま入力してください。ただし、キーワードは大文字小文字の区別がないので、小文字入力してもかまいません
variable 変数(一般) 青小文字の部分は一般的な変数値(一般的な文字列、数値など)を示します。コマンド入力時には、環境に適した文字列や数字を入力してください。ホスト名など一部のものを除き、大文字小文字を区別します
1..32 変数(数値) 青色の1..32は変数値(数値)の一種で指定可能な数値の範囲を表します。たとえば、1..32は1〜32の範囲の数値を指定するという意味です。指定できる数値の範囲はコマンドにより異なります
{aaa | bbb | CCC} 択一選択肢 ブレース(中カッコ)で囲まれた部分は、選択肢を表します。選択肢の各要素が縦棒1つ(|)で区切られている場合は、選択肢から1つだけを選択して指定できます。見やすさのため、縦棒の前後に適宜スペースを入れて表記しています
{aaa & bbb & CCC} 複数選択肢 ブレース(中カッコ)で囲まれた部分は、選択肢を表します。選択肢の各要素がアンパサンド(&)で区切られている場合は、選択肢から1つ以上複数の項目を選択して指定できます。見やすさのため、アンパサンドの前後にスペースを入れて表記しています。複数の要素を指定する場合は「aaa CCC」のように項目をスペースで区切って指定してください
[OPTIONAL=value] 省略可能 スクエアブラケット(角カッコ)で囲まれた部分は省略可能であることを示します
[AAA | BBB | CCC] 省略可能な選択肢 選択肢全体が省略可能なときは、本来 [{AAA | BBB | CCC}] のように書くべきですが、冗長なのでブレースを省略することがあります。これは択一選択肢、複数選択肢とも同じです
MANDATORY=value 入力必須 太字の部分は、必ず入力しなくてはならない部分を表しています。具体的にはスクエアブラケットで囲まれていない部分がこれに相当します
struct 複合要素または別名 青緑の部分は上記の複数の要素が組み合わさっている部分(複合要素)、あるいは、上記のいずれかの要素の別名であることを示します。コマンド構文を見やすくするため、複雑な選択肢などをこの形式で表したり、同じ形式の変数(たとえばIPアドレス)が複数回登場するような場合に、それぞれの意味合いを込めてこの形式で表したりすることがあります。具体的な内容はパラメーター解説のセクションで示します(次項を参照)
struct := {A | B val [C]} 複合要素または別名の展開 パラメーター解説のセクションにおいて、複合要素や別名の具体的内容をこの形式で表します。「:=」の左側が構文中の複合要素名/別名、「:=」の右側が実際の内容です


なお、本マニュアルにおける変数名の表記は、コマンド入力補助機能(「運用・管理」/「コマンドプロセッサー」をご参照ください)で表示される変数名とは必ずしも一致しません。本マニュアルでは、構文全体として見たときの理解しやすさを優先して、人間の手で編集を加えているためです。あらかじめご了承ください。

コマンドライン例

本マニュアルにはコマンドラインの入力例や出力例が数多く登場します。

officer SEC>> SHOW IP INTERFACE


コマンドライン例に関しては、以下の点にご注意ください。

プロンプト

コマンドライン先頭のofficer SEC>>のような箇所はコマンドプロンプトを表しています。コマンドプロンプトは自動的に表示されるもので、入力する必要はありません。

入力すべき箇所

入力すべき箇所は太字で表しています。前記の例では「SHOW IP INTERFACE」が入力すべき文字列です。

なお、必要な文字列を入力したら最後に「Enter」キーを押してください。これにより、コマンドが実行されます。なお、「Enter」キーを押すとき、必ずしもカーソルが行末になくてもかまいません。

折り返し

HTMLの仕様上、折り返し位置の制御が困難なため、本書ではコマンドラインの末尾(改行位置)を次の例のように赤の下向き矢印で示しています。までを一行と考えてください。

デフォルト

本マニュアルでは、いわゆる「デフォルト」について、次のように書き分けています。

Note - 「デフォルトゲートウェイ」や「デフォルトVLAN」など一般的な用語は除きます。

初期設定

製品出荷時における設定の状態やパラメーターの値を「初期設定」または「初期値」と呼びます。インターフェースのネットワークモニタリングの有効・無効を設定するSET INTERFACE COUNTERコマンドのCOUNTERパラメーターを例に挙げると、同パラメーターの初期設定はONとなります。これはすなわち、何も設定を行っていない状態では、COUNTER=ONという設定が行われているのと等しいという意味です。

省略時設定

コマンドによっては、省略可能なパラメーターを持つものがあります。こうしたコマンドで特定のパラメーターを省略した場合、該当パラメーターの値として何が保持されることになるかを「省略時設定」または「省略時値」と呼びます。たとえば、VLANにインターフェースを追加するADD VLAN INTERFACEコマンドには省略可能なFRAMEパラメーターがありますが、これを省略した場合、同パラメーターの値はUNTAGGEDとなります。

なお、省略時値は特定の設定要素に対して初めてコマンドを入力したときだけで適用され、既に設定済みの要素に対して変更を加えるときは明示的に値を指定しない限り該当パラメーターの値は変更されないのが普通ですが、そうでないものもあります。設定作業時には、こまめにSHOW CONFIG (SEC)コマンドを実行し、設定内容が意図したとおり反映されているか確認しながら進めることをお勧めします。

本製品

本マニュアルでは、前記対象バージョンのファームウェアを搭載した前記対象製品を「本製品」と総称します。

本マニュアルには、数多くの「例」が登場します。IPアドレス、ドメイン名、ログイン名、パスワードなどに具体的な文字列や値を使用していますが、これらは例として挙げただけの架空の存在です。実際に運用を行う場合は、お客様の環境におけるものをご使用ください。

また、本書の設定例はあくまでも説明のためのサンプルです。お客様の環境に適した設定を行う際の参考としてください。ある機能について説明するため、現実のネットワークではあり得ないような構成例を使っているところがあるかもしれません。実際にネットワークを構築する場合は、お客様の環境に適した構成をとるようにしてください。

ファブリックコントロールカード、ラインカードの表記

本マニュアルでは、ファブリックコントロールカード、ラインカードを次のように記載しています。

■ ファブリックコントロールカード(AT-SBx31CFC)
■ ラインカード:本マニュアルでは下記5種類のカードを区別する必要がない場合には「ラインカード」と表記しています。

インターフェース

本製品では5つのインターフェースをサポートしています。
本マニュアルでの設定時にどのインターフェースを使用するかなどの識別に使用します。

表 2:インターフェースタイプ
ETH イーサーネットを示します。「ETH:1.4」はシャーシのスロット番号1に挿入したカードの4番ポートを意味します。ただしファブリックコントロールカード(CFCカード)のマネージメントインターフェース(MGMT)は「ETH:0」となります(「MGMT」で指定することも可能です)。
LAG リンクアグリゲーションを示します。
VLAN バーチャルLANを示します。
GE GE24RJカード(AT-SBx31GT24)、GE24POEカード(AT-SBx31GP24)、GE24SFPカード(AT-SBx31GS24)を示します。
XE XE4カード(AT-SBx31XZ4)、XE6SFPカード(AT-SBx31XS6)を示します。



最新情報

製品の出荷後は、弊社Webサイトでマニュアル等の正誤情報や改版されたマニュアル、アップデートされたファームウェアなどの最新の情報を公開しています。

http://www.allied-telesis.co.jp/

ご注意


(C) 2010-2013 アライドテレシスホールディングス株式会社

商標について


マニュアルバージョン


(C) 2010-2013 アライドテレシスホールディングス株式会社

PN: 613-001335 Rev.D