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

運用・管理 / コマンドプロセッサー


  - ログイン
  - コマンドプロンプト
  - コマンドライン編集キー
  - コマンド入力時の注意事項
  - コンソールメッセージ
  - コマンド入力補助機能
   - 入力候補の表示
    - 次のキーワード候補を表示
    - 入力途中のキーワード候補を表示
   - キーワードの補完
   - パラメーター値の説明
    - パラメーターの補足
  - オンラインヘルプ
  - 端末画面のページ当たり行数
  - エイリアス

本製品に対する設定は、コンソールポート(非同期シリアルポート)に接続したコンソールターミナル、または、ネットワーク上のTelnet/SSHクライアントから、コマンドプロセッサー(コマンドラインインターフェース)にアクセスして行います。ここではコマンド入力に関する基本的な事柄について説明します。

ログイン

コマンドプロセッサーにアクセスするには、コンソールポート(非同期シリアルポート)に接続したコンソールターミナルからログインするか、Telnet/SSH経由でログインする必要があります。

また、Telnet/SSHを使用するには、あらかじめコンソールターミナルからログインし、本製品にIPアドレス等を設定しておく必要があります。ご購入時の状態ではIPが有効になっていないため、初回ログイン時は必ずコンソールターミナルからログインすることになります。なお、IPの設定については「IP」の章をご覧ください。

コンソールターミナルを接続するかTelnetで接続すると、「login: 」というログインプロンプトが表示されます。コンソールターミナルを接続してもログインプロンプトが表示されない場合は、「Enter」を何回か押してみてください。

ご購入時の状態では、Security Officer(特権ユーザー)レベルのユーザー「officer/manager」だけが登録されています。初期パスワードは「officer/friend」です。「login:」に対してユーザー名「officer/manager」を、「Password:」に対してパスワード「officer/friend」を入力してください。ログインに成功すると、コマンドプロンプトが表示されます。

Username: officer
Password: officer(実際には表示されません)

officer SEC>> 


Note - デフォルトのパスワードを使い続けることはセキュリティー上好ましくありませんので、初回ログイン時に変更することをお勧めします。詳細は「運用・管理」の「ユーザー認証」をご覧ください。

Note - Telnet接続の場合、ログインプロンプトが表示されてから1分以内にログインしないと、Telnetセッションが切断されます。

Note - 既定回数(初期設定は5回)連続してログインに失敗すると、コンソールターミナルでは一定時間(初期設定は60秒)ログインプロンプトが表示されなくなります。また、Telnet接続の場合はセッションが切断され、該当クライアントからのTelnet接続要求が同じ期間拒否されるようになります。これらの設定は、SET SYSTEM USERCONFIG (SEC)コマンドのLOGINFAIL、LOCKOUTPDパラメーターで変更できます。


コマンドプロンプト

初期設定では、どのユーザーレベルでログインしているかによってコマンドプロンプトの表示が異なります。user、manager、officerの部分はユーザー名が表示され、USR、MGR、SECはユーザー権限を示しています。


なお、SET PROMPTコマンドを使ってコマンドプロンプトをカスタマイズすることもできます。次の例では、ユーザー名の代わりにホスト名を表示するよう設定しています。複数のシステムを管理しているような場合は、ホスト名を表示させておくと各システムを区別しやすくなり便利です。

officer SEC>> SET SYSTEM HOSTNAME=TQC5F
Info (010017): Operation successful.

officer SEC>> SET PROMPT=%n
Info (010017): Operation successful.

TQC5F SEC>> 


コマンドライン編集キー

コマンドラインでは、以下の編集機能を使うことができます(VT100互換の端末エミュレーターが必要です)。

表 1
キー
機能
1文字右に移動
1文字左に移動
Ctrl/A 行頭に移動
Ctrl/E 行末に移動
DeleteまたはBackspace カーソルの左にある文字を削除
Ctrl/U コマンド行の消去
↑またはCtrl/P コマンド履歴をさかのぼる
↓またはCtrl/N コマンド履歴を進める
TabまたはCtrl/I 入力途中のキーワードを補完


コマンド入力時の注意事項

コマンド入力時には以下の事柄に注意してください。

■ 1行で入力できるコマンドの最大文字数はスペースを含めて1000文字です。通常の用途では事実上無制限ですが、コマンド行が長くなり1行におさまらない場合は、コマンドの省略形を使うか、コマンドを複数行に分けてください(ADDとSETなど)。

Note - SET SYSTEMコマンドのNAMEオプションでシステム名を設定している場合は、システム名の分だけ短くなります。

■ コマンドの等号(=)は省略可能です。省略する場合は、イコールサインの変わりにスペースを1つ空けます。

■ 「ADD」、「IP」などのキーワード(予約語)は大文字小文字を区別しないので、どちらで入力してもかまいません。一方、パラメーターとして与える値の中には、パスワードのように大文字小文字を区別するものと、ユーザー名のように大文字小文字を区別しないものがあります。コマンドリファレンス等でご確認の上入力してください。

■ コマンドは一意に識別できる範囲で省略可能です。たとえば、SHOW FILESコマンドは次のように省略して入力することができます。

Note - コマンドの省略形は、キーワードの増減によって変更される可能性があります(ソフトウェアのバージョンによって異なる可能性があります)。

■ ログインユーザーの権限(ユーザーレベル)によって実行できるコマンドが異なります。通常の管理作業はSecurity Officerレベルで行います。

■ コマンドの効果は(エラーがなければ)入力直後にあらわれ、直ぐにデータベースに保存されます。

コンソールメッセージ

コマンド入力後、実行結果や構文エラーを知らせるメッセージが表示されることがあります。

officer SEC>> show
Error (000001): The command entered is incomplete.


■ メッセージは次のような形式になっています。

レベル(番号): 本文



コマンド入力補助機能

コマンドプロセッサーには、コマンドの入力を補助する機能がいくつか備わっています。コマンド入力補助機能には次の種類があります。


これらの補助機能を利用するには、コマンドの入力途中で「?」か「TAB」キーを入力します。次にコマンド入力補助機能の使い方をまとめます。

表 2:コマンド入力補助機能の使い方
書式
使用方法
機能
入力候補の表示(次のキーワード)
? コマンドラインの先頭で「?」キーを入力 コマンドラインの先頭で入力可能なキーワードの一覧を表示する
keywords ? 1つ以上のキーワード(keywords)を入力した後、スペースを入れ、その後で「?」キーを入力 カーソル位置に入力可能なキーワードの一覧を表示する
入力候補の表示(入力途中のキーワード)
partial-keyword? 何らかの文字列(partial-keyword)を入力した後、スペースを入れずに「?」を入力 カーソル位置に入力可能なキーワードのうち、partial-keywordで始まるものの一覧を表示する
キーワードの補完
partial-keyword<TAB> 何らかの文字列(partial-keyword)を入力した後、スペースを入れずに「TAB」キーを入力 カーソル位置に入力可能なキーワードのうち、partial-keywordで始まるものが1つだけであれば、partial-keywordを補完して完全なキーワードにする。
パラメーター値の説明
keyword=? 何らかの文字列(keyword)を入力した後、等号(=)を入れ、その後で「?」キーを入力 keywordをパラメーター名とみなし、同パラメーターに指定可能な値の説明を表示する


以下、それぞれの機能について、実例を挙げながら解説します。

入力候補の表示

入力候補の表示機能は、現在のカーソル位置に入力可能なキーワード(コマンド名やパラメーター名、オプション名)の一覧を表示する機能です。コマンドの入力途中で「?」キーを入力することによって使用します。

Note - 「?」キーで表示されるキーワードの中には、サポート対象外のものも含まれます。原則として、本コマンドリファレンスに記載されていないコマンドやキーワード、機能はサポート対象外となります。詳細はリリースノートなどでご確認ください。

入力候補のキーワードは1行に1つずつ表示されます。また、コマンドラインの先頭キーワード(ADD、ENABLEなど)やモジュール名キーワード(SYSTEM、IPなど)の場合は、簡単な説明(英文)も表示されます。

次のキーワード候補を表示

コマンドラインの先頭で「?」キーを押す、あるいは、いくつかのキーワードを入力した後にスペースを入れ、その後「?」キーを押すと、次に入力可能なキーワードの一覧が表示されます。

■ たとえば、コマンドラインの先頭で「?」キーを押すと次のように表示されます(実際には「?」は表示されません)。

officer SEC>> ?

ACTIVATE                  - Activate an object.
ADD                       - Add an object.
AUDIT                     - Audit load files.
BACKUP                    - Backup an object
CLEAR                     - Clear an object
COPY                      - Copy an object
CREATE                    - Create an object
DEACTIVATE                - Deactivate the functionality of an object.

 ...

SHOW                      - To display configuration and status information.
STOP                      - To stop an action.
SWAP                      - To swap activity between control modules.
TELNET                    - Telnet Client.
TRACEROUTE                - Trace route/path to specified destination
TSHELL                    - Targetshell command execution

officer SEC>>


画面の左側に列挙されているのが、コマンドラインの先頭キーワードとして有効な単語の一覧です(表示項目はソフトウェアのバージョンによって異なる可能性があります)。大文字の部分は、各キーワードを一意に識別するため、最低限入力しなくてはならない部分を示しています。

画面の右側は、キーワードの簡単な説明(英文)です。

Note - 「?」キーで表示されるキーワードの中には、サポート対象外のものも含まれます。原則として、本コマンドリファレンスに記載されていないコマンドやキーワード、機能はサポート対象外となります。詳細はリリースノートなどでご確認ください。

■ 次に、コマンドラインでさきほどの候補一覧から「SHOW」を入力し、さらに半角スペースを一文字入力した上で再度「?」キーを押すと、次のように表示されます。

officer SEC>>show ?

ACCESSLIST                - The name of the ACCESSLIST(s) to show
ALARMS                    - Current alarm conditions on system components
ALIAS                     - List of alias command definitions to be displayed.
ARPFILTER                 - ARPFILTER describes the kind of SHOW operation
                            being performed.
AUTHENTICATION            - Show the per-interface settings for Port
                            Authentication.
BFD                       - Bi-directional Forwarding Detection
BOOTSERVER                - A network load file server
CARD                      - The slot number for the card being displayed
 ...

TELNET                    - Show the telnet configuration.
TRACE                     - Show Trace logs or status.
TRAFFICDESCRIPTOR         - The name of the TRAFFICDESCRIPTOR(s) to show.
TRANSFER                  - The file transfer operation to display
USER                      - The optional login-name of user to be display.
VC                        - VC identifier number
VLAN                      - A Virtual LAN (VLAN) name or Id.
VLANTUNNELMAP             - VLAN tunnel mapping operation

officer SEC>>show 


■ さらに「SYSTEM」を入力し、半角スペースを一文字入力した上で再度「?」キーを押すと、次のように表示されます。

officer SEC>>show system ?

<cr>
 COOLING                   - Shelf temperature and fan information
 CUSTOMERID                - The customer identifier for this system
 ECOMODE                   - Energy savings mode
 PROVMODE                  - The provisioning mode for the system
 TIME                      - The current time and date for the system
 USERCONFIG                - System user configuration data

officer SEC>>show system 


<cr>は、これ以上キーワードを入力せずに「Enter」キーを押してコマンドラインを完成させることもできる、という意味です。この例では、「show system」だけでも、コマンドラインとして完結していることを示しています。

入力途中のキーワード候補を表示

コマンドラインに何らかの文字列を入力した後、スペースを入れずに「?」を入力すると、カーソル位置に入力可能なキーワードのうち、入力した文字列で始まるものの一覧が表示されます。

■ たとえば、コマンドラインに「a」と入力した後、スペースを入れずに「?」を入力すると、次のように表示されます(実際には「?」は表示されません)。

officer SEC>> a?
AUDIT  ADD  ACTIVATE

officer SEC>> a


■ また、「add ip i」と入力した後で「?」を入力すると、次のように表示されます。

officer SEC>> add ip i?
INTERFACE

ud_ichi SEC>> add ip i

■ 指定した文字列で始まるキーワード候補がないときは、次のように表示されます。この例は、「add ip」の後に「g」で始まるキーワードは指定できないことを示しています。

officer SEC>> add ip g?
Error (000002): There was an unrecognized parameter in the command entered.
officer SEC>> add ip g 


キーワードの補完

前項目で説明した「入力途中のキーワード候補を表示」とよく似ていますが、コマンドラインに何らかの文字列を入力した後、スペースを入れずに「TAB」キーを入力すると、カーソル位置に入力可能なキーワードのうち、指定した文字列で始まるものが1つだけの場合、入力途中のキーワードを補完して完全なキーワードにしてくれます。指定した文字列で始まるキーワードが複数存在する場合は、「?」キーと同じく候補の一覧が表示されます。

■ たとえば、コマンドラインに「se」と入力した後、スペースを入れずに「TAB」キーを入力すると、次のように表示されます(実際にはタブ文字は表示されません)。

officer SEC>>se<TAB>
officer SEC>>set


■ 指定した文字列で始まるキーワード候補がないときは、次のように表示されます。この例は、「add ip」の後に「g」で始まるキーワードは指定できないことを示しています。

officer SEC>> add ip g<TAB>
Error (000002): There was an unrecognized parameter in the command entered.
officer SEC>> add ip g 



パラメーター値の説明

コマンドライン上でキーワードを入力した後、等号(=)を入れ、その後で「?」キーを入力すると、指定したキーワードをパラメーター名とみなし、該当パラメーターに指定すべき値の説明が表示されます。

■ たとえば、コマンドラインで「create hvlan vid=」と入力してから「?」キーを押すと、次のようにvidパラメーターに指定すべき値の説明が表示されます。

officer SEC>> create hvlan vid=?
 2..4094|vid-range         - A virtual LAN identifier

officer SEC>> 


■ 真偽値(TRUE/FALSE、ON/OFF、YES/NO)など、特定の値・キーワードをとるパラメーターの場合は、次のように表示されます。

officer SEC>> set interface 1.0 infiltering =?
 OFF|ON                    - The ingress filtering settings

officer SEC>> set interface 1.0 infiltering


パラメーターの補足

本コマンドリファレンスのパラメーターの説明で「○○-range、○○-list」と記載されているものは、複数の○○(たとえば、複数のポート番号やEPSRドメイン名など)を指定可能なことを意味します。複数の○○を指定する場合、連続したものや、範囲を指定する場合はハイフン「-」で区切り、その他の場合はカンマ「,」で区切ります。

下表は、指定方法の例です。

表 3
type インターフェースのタイプを指定します。インターフェースのタイプは「top」ページの「インターフェース」をご覧ください。
type:id-range ポートのタイプとポート番号を指定します。連続したポート番号を指定する場合はハイフン「-」で区切り、複数のポート番号を指定する場合はカンマ「,」で区切ります。例(ETH:7.0、ETH7.0-7.9、ETH:1.2,1.7)
id-range ポート番号を指定します。連続したポート番号を指定する場合はハイフン「-」で区切り、複数のポート番号を指定する場合はカンマ「,」で区切ります。例(7.0、7.0-7.9、1.2,1.7)
ifname-list インターフェース名を設定している場合に指定できます。
MGMT ACTCFCカードのマネージメントポートを指定する場合に使用します。
vid-range VLAN IDまたはHVLAN IDを指定します。一定の範囲のVIDを指定する場合はハイフン「-」で区切り、複数のVIDを指定する場合はカンマ「,」で区切ります。例(1、1-200、1,20,230)
vlanname-list VLAN名を指定します。複数のVLAN名を指定する場合はカンマ「,」で区切ります。例(DATA、Default,Data,Vlan001)
hvlanname-list ダブルタグVLAN名を指定します。複数のVLAN名を指定する場合はカンマ「,」で区切ります。例(HVLAN100、HVLAN001,HVLAN002)


オンラインヘルプ

各コマンドのオンラインヘルプを見ることができます。コマンドの前にHELPを入力するとオンラインヘルプが表示されます。

Note - コマンドの最後の単語を省略しなければヘルプが表示されないコマンドもいくつか存在します。たとえば、「HELP DISABLE POE INTERFACE」を実行してもエラーになってしまいます。コマンドの最後の単語「INTERFACE」を抜いて「HELP DISABLE POE」とするとヘルプが表示されます。

officer SEC>> HELP DISABLE INTERFACE
ATI 200G Central Fabric Controller Help version 14.2.1 - English Version


SYNTAX:
            DISABLE INTERFACE={type:id-range|id-range|ifname-list} [FORCE]

DESCRIPTION:

            The DISABLE INTERFACE command takes an interface out-of-service
            and changes the administrative state to DOWN. A list or range of
            interfaces is accepted. Once disabled, the interface is given a
            status of OFFLINE.

            A warning is provided for this command and confirmation is
            required.  The FORCE parameter suppresses the warning and bypasses
            the confirmation.


PARAMETERS:
    INTERFACE -
            The INTERFACE parameter allows the filtering of interfaces.  If no
            value or ALL is provided, all interfaces are displayed.  Otherwise,
            interfaces to be displayed may be selected by type or a
            type:id/name list (e.g., ETH:4.4-4.8/name1,name2/ADSL:4.4).

            A list of all interfaces is viewed by executing the SHOW INTERFACE
            command.

    FORCE -
            The FORCE parameter suppresses the warning message and
            bypasses the confirmation normally required for the command.


SEE ALSO:
            ENABLE INTERFACE
            LOOPBACK
            RESET INTERFACE
            SET INTERFACE
            SET INTERFACE DESCRIPTION
            SHOW INTERFACE



端末画面のページ当たり行数

デフォルトの端末設定では、1ページあたり行数が22に設定されています。コマンドの出力結果が22行よりも長い場合は21行ごとに表示が一時停止し、最下行に次のようなメッセージが表示され、キー入力待ち状態になります。

--More--  (<space> = next page, <CR> = one line, Q = quit)


ここでは次のキー操作が可能です。

表 4
space 次の1ページを表示します。
CR (Enter) 次の1行を表示します。
q 表示を中止し、プロンプトに戻ります。


一度表示された行をさかのぼることはできません。

■ ページ単位の一時停止を無効にするには、DISABLE MOREコマンドを使用します。

officer SEC>> DISABLE MORE


エイリアス

エイリアス機能を利用すると、長いコマンド行に短い別名を付けたり、複数のコマンドを一度に実行することができます。本装置には初期設定でエイリアスが複数登録されています。初期設定のエイリアス一覧はCREATE ALIASコマンドの表を参照ください。

■ エイリアスの定義はCREATE ALIASコマンドで行います。たとえば、「ls」でファイル一覧が表示されるようにするには、次のようにします。

officer SEC>> CREATE ALIAS=ls STRING="show files"

エイリアスは入力直後に一回だけ展開され、その後コマンド解析部に送られます。展開されたコマンド行にエイリアスが含まれていても再帰的に展開されることはありません。

■ エイリアスの一覧はSHOW ALIASコマンドで確認できます。

officer SEC>> SHOW ALIAS


■ エイリアスを削除するにはDESTROY ALIASコマンドを使います。

officer SEC>> DESTROY ALIAS=ls



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

PN: 613-001335 Rev.B