[index] CentreCOM AR550S コマンドリファレンス 2.9

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

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

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

ログイン

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

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

コンソールターミナルを接続するかTelnetで接続すると、「login: 」というログインプロンプトが表示されます。コンソールターミナルを接続してもログインプロンプトが表示されない場合は、「Enter」を何回か押してみてください。
ご購入時の状態では、Manager（管理者）レベルのユーザー「manager」だけが登録されています。初期パスワードは「friend」です。「login:」に対してユーザー名「manager」を、「Password:」に対してパスワード「friend」を入力してください。ログインに成功すると、コマンドプロンプトが表示されます。

    login: manager
    Password: friend（実際には表示されません）

    Manager >

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

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

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

コマンドプロンプト

デフォルトの設定では、どのユーザーレベルでログインしているかによってコマンドプロンプトの表示が異なります。

> Note - SET ASYNコマンドのPROMPTパラメーターでプロンプト文字列を変更している場合は、ユーザーレベルに関わりなく設定した文字列が表示されます。

- Userレベル

      >

- Managerレベル

      Manager >

- Security Officerレベル

      SecOff >

なお、SET SYSTEM NAMEコマンドでシステム名（sysName）を設定しているときは、「>」の前にシステム名が表示されます。複数のシステムを管理しているような場合、システム名にわかりやすい名前を付けておくと各システムを区別しやすくなり便利です。

    Manager > set system name="GW/Saidaiji"

    Info (134003): Operation successful.

    Manager GW/Saidaiji>

コマンドライン編集キー

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

表 1
キー | 機能
→ | 1文字右に移動
← | 1文字左に移動
Ctrl/A | 行頭に移動
Ctrl/E | 行末に移動
DeleteまたはBackspace | カーソルの左にある文字を削除
Ctrl/U | コマンド行の消去
Ctrl/O | 挿入モード（デフォルト）と上書きモードの切り替え
↑またはCtrl/B | コマンド履歴をさかのぼる
↓またはCtrl/F | コマンド履歴を進める
TabまたはCtrl/I | 入力途中のキーワードを補完、あるいは、次に入力可能なキーワードの候補一覧を表示
Ctrl/R | 入力途中のコマンドとマッチする最新のコマンド履歴を表示
Ctrl/Q | SHOW XXXX コマンドの表示を中断

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

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

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

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

`SH FI ↓`

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

■ ログインユーザーの権限（ユーザーレベル）によって実行できるコマンドが異なります。通常の管理作業はManagerレベルで行います。また、セキュリティーモードではSecurity Officerレベルの権限が必要です。
■ コマンドの効果は（エラーがなければ）入力直後にあらわれます。再起動などを行う必要はありません。ただし、設定内容は再起動すると消えてしまうので、再起動後にも同じ設定を使いたいときはCREATE CONFIGコマンドでファイルに保存してください。詳細は「運用・管理」の「コンフィグレーション」などを参考にしてください。

コンソールメッセージ

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

    Manager > add ip int=eth0 ip=192.168.10.1

    Warning (2005267): The IP module is not enabled.

    Manager > enable ip

    Info (1005287): IP module has been enabled.

    Manager > show ip interfaith

    Error (3005012): Parameter "interfaith" not recognised.

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

    レベル (番号): 本文

- 「レベル」はメッセージの重要度を示す単語で、次のどれかになります。
  - Info：コマンドの実行に成功したことを示す
  - Warning：コマンドの実行には成功したが、関連する事柄に注意すべき点があることを示す
  - Error: コマンドの実行に失敗したことを示す

  > Note - コンソールメッセージの「レベル」は、ログメッセージの「ログレベル」とは異なります。「レベル」は、ログメッセージタイプ「021/MSG」のサブタイプ「001/INFO」、「002/WARN」、「003/ERROR」に対応しています。詳しくは、「運用・管理」の「ログ」にある「タイプ/サブタイプ」をご覧ください。

- 「番号」は3つのフィールドからなる7桁のメッセージコードです。

  `smmmnnn
  `
  - 「s」はメッセージの重要度を示す1桁の数字です。1（Info）、2（Warning）、3（Error）の3種類があります。意味は前述の「レベル」と同じです。
  - 「mmm」はメッセージを出力したモジュールを示す3桁の数字です。詳しくは、「運用・管理」の「ログ」にある「モジュールIDとモジュール名」をご覧ください。
  - 「nnn」は個々のメッセージを識別するための3桁の数字です。001〜255は全モジュール共通のメッセージ、256〜999はモジュールごとに異なるメッセージです。
- 「本文」はメッセージ本文（英文）です。

コマンド入力補助機能

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

- 入力候補の表示
- キーワードの補完
- パラメーター値の説明

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

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

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

入力候補の表示

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

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

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

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

コマンドラインの先頭で「?」か「TAB」キーを押す、あるいは、いくつかのキーワードを入力した後にスペースを入れ、その後「?」か「TAB」キーを押すと、次に入力可能なキーワードの一覧が表示されます。
■ たとえば、コマンドラインの先頭で「?」か「TAB」キーを押すと次のように表示されます（実際には「?」やタブ文字は表示されません）。

    Manager > ?（または<TAB>）

     ACTivate     Cause an action to be taken immediately
     ADD          Add new items to existing objects or instances
     CLear        Erase memory (NVS or FLASH) totally - use with extreme caution!
     Connect      Connect to a named Telnet or interactive host service or asyn port
     COPy         Copy a file in NVS or FLASH memory
     CREate       Make a new object or new instance of an object

     ...

     SHow         Display states and settings of all parameters and objects
     SSH          Use Secure Shell to log into a remote device securely
     STARt        Start the packet generator for diagnostic purposes
     STop         Terminate a current ping, trace route, or packet generator
     TELnet       Use Telnet to login to a remote device
     TRAce        Use trace route to see what path packets take to a destination
     UPLoad       Transfer a file from FLASH or NVS memory to a remote server

    Manager >

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

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

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

    Manager > show ?（または<TAB>）

     ACC          Display information about calls, scripts and domain name
     ADSL         Display information about an ADSL interface
     ALIas        List the currently-defined aliases for long command sequences

     ...

     TRAce        Display TRACE configuration and results of the latest command
     TRIGger      Display general trigger settings, or info about specific triggers
     TTy          Display information about one or all of the TTY devices present
     UPNP         Display the Universal Plug and Play state or configuration
     USEr         Display information about RSO or the User Authentication Facility
     VLAN         Display information about the specified VLAN or the debug mode
     VOIP         Display information about VOIP configuration or status
     VRRP         Display diagnostic information about VRRP virtual routers
     WANLB        Display information about WAN Load Balance, resources or sessions
     X25C         Display X25C information
     X25T         Display information about the X.25 DTE or call parameters

    Manager > show

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

    Manager > show system ?（または<TAB>）

     <enter>
     DUMP         Display information that is dumped when an exception is generated
     FACtory      Display information of use to the factory
     MANUfactured Display the date when the unit was manufactured
     SErialnumber Display the hardware serial number of the base unit
     STARTup      Display the status of the unit after startup

    Manager > show system

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

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

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

    Manager > a?

     ACTivate     Cause an action to be taken immediately
     ADD          Add new items to existing objects or instances

    Manager > a

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

    Manager > add ip h?

     HElper       Adds port/s to list of UDP ports to listen for on the interface
     HOst         Adds a user-defined name for an IP host to the host name table

    Manager > add ip h

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

    Manager > add ip g

    Error (3005012): The string "g" was not recognised as a parameter for this comma
    nd. Either an invalid parameter was entered or the parameter was spelt incorrect
    ly.

    Manager >

キーワードの補完

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

    Manager > ad<TAB>

    Manager > add

■ また、「add ip h」と入力した後で「TAB」キーを入力すると、「add ip」の後に「h」で始まる候補は2つあるため、次のように表示されます（「?」キーのときと同じ）。

    Manager > add ip h<TAB>

     HElper       Adds port/s to list of UDP ports to listen for on the interface
     HOst         Adds a user-defined name for an IP host to the host name table

    Manager > add ip h

■ ここで、もう一文字「o」を入力してから「TAB」キーを押すと、候補が1つになるため、次のように補完されます。

    Manager > add ip ho<TAB>

    Manager > add ip host

■ 指定した文字列で始まるキーワード候補がないときは、何も表示されず、コマンドラインも変更されません。この例は、「add ip」の後に「g」で始まるキーワードは指定できないことを示しています。

    Manager > add ip g<TAB>

    Manager > add ip g

パラメーター値の説明

コマンドライン上でキーワードを入力した後、等号（=）を入れ、その後で「?」か「TAB」キーを入力すると、指定したキーワードをパラメーター名と見なし、該当パラメーターに指定すべき値の説明が表示されます。
■ たとえば、コマンドラインで「set switch port=」と入力してから「?」か「TAB」キーを押すと、次のようにPORTパラメーターに指定すべき値の説明が表示されます。

    Manager > set switch port=?（または<TAB>）

     required - the keyword ALL, an Ethernet switch port number, a range of Ethernet
     switch port numbers separated by a hyphen, or a comma-separated list of Etherne
    t switch port numbers and/or ranges

    Manager > set switch port=

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

    Manager > set switch port=1 speed=?（または<TAB>）

     required -  AUTOnegotiate 10MHALf 10MFUll 100MHALf 100MFUll
        1000MHALf 1000MFull 10MHAUto 10MFAuto 10MAUTo 100MHAUto 100MFAuto 100MAUto
        1000MHAUto 1000MFAuto

    Manager > set switch port=1 speed=

    Manager > set portauth idtoggle=?（または<TAB>）

     required -  OFF ON

    Manager > set portauth idtoggle=

■ 指定したキーワードが値を取れない場合は、次のように表示されます。この例は、「enable ip」の「ip」には値を指定できないことを示しています。

    Manager > enable ip=?（または<TAB>）

      No value allowed

    Manager > enable ip=

オンラインヘルプ

オンラインヘルプを見るには、HELPコマンドを使います。
■ オプションなしでHELPコマンドを実行すると、ヘルプファイルのトップページが表示されます。

`HELP ↓`

■ トップページの一覧にしたがい、表示させたいトピックを指定すると該当項目が表示されます。

`HELP IP ↓`

■ トピックによってはさらに深い項目がある場合もあります。その場合は画面の表示にしたがってトピック名を多段で指定します。

`HELP IP INTERFACE ↓`

■ ヘルプファイルはソフトウェアとともに配布されています。HELPコマンドが使用するヘルプファイルはSET HELPコマンドで変更できます。

`SET HELP=help.hlp ↓`

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

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

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

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

表 3
Space | 次の1ページを表示します
Enter | 次の1行を表示します
c | 残りすべてを一気に表示します
q | 表示を中止し、プロンプトに戻ります

一度表示された行をさかのぼることはできません。
■ ページ当たり行数はSET ASYNコマンドで変更できます。

`SET ASYN PAGE=30 ↓`

■ ページ単位の一時停止を無効にするには、PAGEパラメーターにOFFを指定します。

`SET ASYN PAGE=OFF ↓`

■ 一時停止後に「C」キーを押した場合や一時停止を無効にしている場合は、コマンドの出力が完了するまでプロンプトが表示されません。このようなときは、Ctrl/Q（Ctrlキーを押しながらQキーを押す）で表示を中断することができます（コマンドによっては中断できないこともあります）。

エイリアス（別名）

コマンドエイリアス機能を利用すると、長いコマンド行に短い別名を付けることができます。
■ エイリアスの定義はADD ALIASコマンドで行います。たとえば、「ls」でファイル一覧が表示されるようにするには、次のようにします。

`ADD ALIAS=ls STRING="show file" ↓`

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

`SHOW ALIAS ↓`

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

`DELETE ALIAS=ls ↓`

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

PN: J613-M0710-03 Rev.H