運用・管理 / コマンドラインインターフェース（CLI）

本製品に対する設定は、管理用端末から本製品の管理機構であるコマンドラインインターフェース（CLI）にアクセスして行います。

ここでは、CLIに関する基本的なことがらについて説明します。CLIへのアクセス方法については「運用・管理」の「システム」をご覧ください。

ログイン

本製品の管理機構であるコマンドラインインターフェース（CLI）を利用するには、ユーザー名とパスワードを入力してログインする必要があります。ログインせずに管理作業を行うことはできません。

初期設定では、次に示す権限レベル15のユーザーアカウントが登録されています。


初回ログイン時はこのユーザー名とパスワードでログインしてください。パスワードを変更している場合や、他のユーザーを登録している場合は、それぞれ適切なユーザー名とパスワードを使用してログインしてください。
AlliedWare Plus (TM) X.X.X xx/xx/xx xx:xx:xx
AT-vFW-app>

短いメッセージの後（上の例では「AlliedWare Plus ...」）、「awplus>」のようなコマンドプロンプトが表示されればログイン成功です。

コマンドモードとプロンプト

本製品のコマンドラインインターフェース（CLI）には「コマンドモード」の概念があります。各コマンドはあらかじめ決められたモードでしか実行できないため、コマンドを実行するときは適切なモードに移動し、それからコマンドを入力することになります。

コマンドモードは次のような階層構造を持ちます。


モード間の移動方法は次のようになります。


以下、各モードについて解説します。また、コマンドモードによってコマンドプロンプトの表示が異なるため、それもあわせて示します。

実行モード

実行モード（EXECモード）は、状態の確認や設定の保存、ファイルシステムの操作、スクリプトの実行など、その場かぎりのコマンドを実行するためのモードを総称したものです。主として「非特権EXECモード」と「特権EXECモード」の2つからなります。実行モードでは、機器の動作設定を変更するようなコマンドは実行できません。

非特権EXECモードでは、原則として情報表示コマンド（show xxxx）の一部しか実行できず、ファイルの操作もできません。他のモードに移動するための起点と考えてください。
特権EXECモードでは、すべての情報表示コマンド（show xxxx）が実行できるほか、システムの再起動や設定保存、ファイル操作など、さまざまな「実行コマンド」（コマンドの効果がその場かぎりであるコマンド。ネットワーク機器としての動作を変更する「設定コマンド」と対比してこう言う）を実行することができます。

なお、各実行モードで共通に使えるコマンドとして以下のものがあります。

以下、本製品がサポートする設定モードをまとめます。


設定モード

設定モード（コンフィグモード）は、機器の動作設定を変更するコマンドを実行するためのモードを総称したものです。
具体的にはシステム全体にかかわる設定を行うための「グローバルコンフィグモード」と、「インターフェースモード」など特定の要素に対する設定を行うための多数の個別コンフィグモード（サブコンフィグモード）からなります。ネットワーク機器としての動作設定は原則的にすべて設定モードで行います。

なお、各設定モードで共通に使えるコマンドとして以下のものがあります。

本製品がサポートする設定モードは以下のとおりです。


なお、プロンプトの先頭部分はホスト名を表示するための領域です。初期状態ではホスト名として「AT-vFW-app」が設定されており、これが表示されるようになっていますが、hostnameコマンドでホスト名を設定すると、「AT-vFW-app」の代わりに設定したホスト名が表示されるようになります。

本製品を複数管理している場合など、各装置に異なる名前を設定しておくと、現在どの装置にログインしているのかがわかりやすくなり便利です。
AT-vFW-app(config)# hostname myrouter
myrouter(config)#

設定モードで実行モードコマンドを実行

各種設定モードで作業をしている最中に、show xxxxなどの実行モードコマンドを使って機能の状態を確認したいことはよくあります。

通常このような場合には、endコマンドやCtrl/Zキーを使って特権EXECモードに戻り、実行モードコマンドを実行してから、元の設定モードに戻る必要がありますが、doコマンドを使用すれば設定モードのまま各種実行コマンドを実行させることができます。
AT-vFW-app(config)# do show snmp-server community
SNMP community information:
  Community Name ........... public
    Access ................. Read-only
    View ................... none

AT-vFW-app(config)#

ここではグローバルコンフィグモードでdoコマンドを使用していますが、同コマンドはラインモード、インターフェースモードなど、任意の設定モードで使用できます。

なお、doコマンドを使う場合、後述するコマンド入力補助機能は使えません。適宜キーワードの省略形を使うなどしてください。

コマンドライン編集キー

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

表 1
凡例
Ctrl/△ 「Ctrl」キーを押しながら△キーを押す。たとえば「Ctrl/E」は、「Ctrl」キーを押しながら「E」キーを押すことを意味する
Esc,△ 「Esc」キーを押して離し、次に△キーを押して離す。たとえば「Esc,B」は、「Esc」キーを押して離し、次に「B」キーを押すことを意味する
カーソル移動
Ctrl/Fまたは→ 1文字右に移動する
Alt/FまたはEsc,F 1単語右に移動する（カーソル位置にある単語の最後の文字の次に移動する）
Ctrl/Bまたは← 1文字左に移動する
Alt/BまたはEsc,B 1単語左に移動する（カーソル位置にある単語の先頭文字に移動する）
Ctrl/A 行頭に移動する
Ctrl/E 行末に移動する
削除
Ctrl/HまたはBackspace カーソルの左にある文字を削除する
Ctrl/D カーソル位置の文字を削除する。ただしコマンド行が空の状態でCtrl/Dを押した場合は、exitコマンドと同じ動作となる
Alt/DまたはEsc,D カーソル位置以降、最初の空白の直前までを削除する
Ctrl/K カーソル位置から行末までを削除する
Ctrl/U コマンド行を消去する
その他
Ctrl/T カーソル位置の文字とその直前の文字を入れ換える（カーソルが行末にあるときは、直前の文字とその前の文字を入れ換える）
Ctrl/Pまたは↑ コマンド履歴をさかのぼる
Ctrl/Nまたは↓ コマンド履歴を進める
Ctrl/C 非特権EXECモードと特権EXECモードでは、入力中のコマンド行を破棄して新しい行に移る。各種コンフィグモードでは、入力中のコマンド行を破棄して特権EXECモードに戻る。または、実行中のコマンドを中断する（注意事項あり）
Ctrl/Z 各種コンフィグモードから特権EXECモードに戻る。endコマンドと同じ動作
TabまたはCtrl/I 入力途中のキーワードを補完、または、次に入力可能なキーワードの候補一覧を表示する

Ctrl/C入力時の注意事項

実行したコマンドが情報を出力している最中にCtrl/Cを入力すると関連プロセスの異常終了が発生する可能性があります。
出力する情報の量が多いコマンドを実行する場合は以下のいずれかの対応を行ってください。

(1) 端末1ページ当たりの表示行数を制限する
1ページ当たりの表示行数を制限することで、Ctrl/Cを入力する必要性を極力なくすことができます。

表示行数の設定は下記のコマンドで行います。詳細は「運用・管理」/「端末設定」をご覧ください。

(2) 出力をファイルに保存する
コマンドの出力先を端末画面ではなくファイルにリダイレクト（変更）することで、出力される情報をファイルに保存し、Ctrl/Cを入力する必要性をなくすことができます。
これにはリダイレクション記号「>」、またはモディファイア記号「|」とredirectフィルターを使用します。
運用時に大量の情報を出力する必要がある場合は、出力される情報をいったんファイルに保存してからその内容を確認してください。

コマンド例は下記のとおりです。
詳細は「モディファイアとリダイレクション」をご覧ください。

リダイレクション記号「>」を使う例
awplus# show mac address-table > flash:/show_mac_address-table.txt

モディファイア記号「|」とredirectフィルターを使う例
awplus# show mac address-table | redirect flash:/show_mac_address-table.txt

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

コマンド入力時には以下のことがらに注意してください。

すでに述べたとおり、コマンドモードによって実行できるコマンドが異なります。現行モードでどのコマンドを実行できるかは、後述する「コマンド入力補助機能」やコマンドリファレンスで確認してください。

「show」、「enable」などのキーワード（予約語）は大文字小文字を区別しないので、どちらで入力してもかまいません。一方、パラメーターとして与える値は、原則として大文字小文字を区別します。詳細はコマンドリファレンス等でご確認の上入力してください。

キーワードは一意に識別できる範囲で省略可能です。たとえば、特権EXECモードにおいて、show running-configコマンドは次のように省略して入力することができます。
AT-vFW-app# sho run

また、configure terminalコマンドは次のようにして入力することができます。
AT-vFW-app# con t


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

コマンドの効果は、エラーがなければ通常入力直後にあらわれます。再起動などを行う必要はありません。ただし、設定内容は再起動すると消えてしまうので、再起動後にも同じ設定を使いたいときはcopyコマンドやwrite fileコマンド、write memoryコマンドでファイルに保存してください。詳細は「運用・管理」の「コンフィグレーション」をご覧ください。なお、一部のコマンドでは実行後に再起動が必要です。詳細はコマンドリファレンスで確認してください。

現在の設定内容（ランニングコンフィグ）は、show running-configコマンドで確認できます。設定作業時には、こまめにshow running-configコマンドを実行し、設定内容が意図したとおり反映されているか確認しながら進めることをおすすめします。

コマンドの否定形（no形式）

設定モードで実行するコマンドには「否定形」を持つものが多くあります。否定形は、コマンドの先頭に「no」というキーワードを付加した形式で、通常該当コマンドの効果を取り消すために使います。

たとえば、DNSサーバーリストにサーバーを追加するip name-serverコマンドには、「肯定形」として、

(config)# ip name-server SERVER ...


があり、「否定形」としては、

(config)# no ip name-server SERVER ...


があります。

同コマンドにおいて、否定形の構文は登録済みのサーバーをリストから削除するときに使います。

本マニュアルにおいては、肯定形を「通常形式」、否定形を「no形式」と呼びます。コマンドリファレンス編では、通常形式とno形式の両方を持つコマンドの場合、両方の構文を併記し、コマンドの説明部分では最初に通常形式の説明を行い、次にno形式の動作を説明します。

no形式には、おもに次のパターンがあります。


メッセージ

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


なお、コマンドの実行に成功した場合は、通常何も表示されません。エラーメッセージが表示されなかった場合は、コマンドの実行に成功したと考えてください。


コマンド入力補助機能

コマンドラインインターフェース（CLI）には、コマンドの入力を補助する機能がいくつか備わっています。コマンド入力補助機能には次の種類があります。


これらの補助機能を利用するには、コマンドの入力途中で「?」か「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」キーを入力することによって使用します。


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

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

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

たとえば、グローバルコンフィグモードのコマンドラインの先頭で「?」キーを押すと次のように表示されます。

AT-vFW-app(config)# ?
Configure commands:
  aaa                           Authentication, Authorization and Accounting
  arp                           Address Resolution Protocol (ARP)
                                commands
  banner                        Change banner settings
  bgp                           Border Gateway Protocol (BGP)
  boot                          Boot configuration

　・・・

  show                          Show running system information
  snmp-server                   Manage snmp server
  ssh                           Secure Shell
  system                        System properties
  tacacs-server                 TACACS+ server configuration commands
　trigger                       Automatic scripted responses to device events
  undebug                       Disable debugging functions (see also 'debug')
  username                      Establish User Name Authentication
  vrrp                          VRRP configuration
AT-vFW-app(config)#

画面の左側に列挙されているのが、コマンドラインの先頭キーワードとして有効な単語の一覧です。

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



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

AT-vFW-app(config)# show ?
  banner          Display banner message
  crypto          Security Specific Commands
  log             Display logging information
  running-config  Current operating configuration
  ssh             Secure Shell

AT-vFW-app(config)# show

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

AT-vFW-app(config)# show log ?
  config     Display the current logging configuration
  permanent  Display to contents of the permanent log
  tail       Display only the latest log entries
  |          Output modifiers
  >          Output redirection
  <cr>

AT-vFW-app(config)# show log

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

また、コマンドラインで使用できる特殊記号の「|」と「>」については、「モディファイアとリダイレクション」の節で後述します。

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

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

たとえば、グローバルコンフィグモードでコマンドラインに「auth」と入力した後、スペースを入れずに「?」を入力すると、次のように表示されます。

AT-vFW-app(config)# auth?
  auth-mac         MAC-Based Authentication
  auth-web-server  Web authentication server configuration commands

AT-vFW-app(config)# auth

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

AT-vFW-app(config)# ip d?
  dhcp           DHCP Server or Snooping Configuration
  domain-list    Add a domain to the DNS
  domain-lookup  Enable Domain Name Service (DNS)
  domain-name    Set default domain for DNS

AT-vFW-app(config)# ip d

指定した文字列で始まるキーワード候補がないときは、次のようなメッセージ（Unrecognized command）が表示されます。この例は、「ip」の後に「b」で始まるキーワードは指定できないことを示しています。

AT-vFW-app(config)# ip b?
% Unrecognized command
AT-vFW-app(config)# ip b

キーワードの補完

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

たとえば、eth0を対象とするインターフェースモードでコマンドラインに「des」と入力した後、スペースを入れずに「TAB」キーを入力すると、次のように表示されます（実際にはタブ文字は表示されません）。

AT-vFW-app(config)# interface eth0
AT-vFW-app(config-if)# des<TAB> （実際には表示されません）

↓ 次のように補完される

AT-vFW-app(config-if)# description

また、eth0を対象とするインターフェースモードで「ip」と入力した後で「TAB」キーを入力すると、「ip」で始まる候補は2つあるため、次のように表示されます。

AT-vFW-app(config)# interface eth0
AT-vFW-app(config-if)# ip<TAB> （実際には表示されません）
ip ipv6 
AT-vFW-app(config-if)# ip

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

AT-vFW-app(config-if)# ipv<TAB> （実際には表示されません）

↓ 次のように補完される

AT-vFW-app(config-if)# ipv6

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

AT-vFW-app(config-if)# ip g<TAB> （実際には表示されません）
AT-vFW-app(config-if)# ip g

モディファイアとリダイレクション

通常、コマンドを実行すると、コマンドラインインターフェース（CLI）から何らかの文字列が返ってきます。特に情報を確認するためのコマンド（いわゆるshowコマンド）では、大量の情報が出力される場合があります。

このような場合に便利なのが、コマンドラインで使用できる2つの特殊記号、「|」（モディファイア）と「>」（リダイレクション）です。

モディファイアは、コマンドが出力した情報をいったん「フィルター」に通して、内容を加工した上で端末画面に表示させる機能を持ちます。フィルターには次の4種類があります。




リダイレクションは、コマンドの出力を端末画面には出力せず、指定したファイルに書き出す機能を持ちます。前述した「モディファイア」のredirectフィルターと同じ機能です。


たとえば、リダイレクション（>）を使用して、show logコマンドの出力をflash:/tmp/show_log.txtというファイルに書き出すには、次のようにします。
AT-vFW-app# show log > flash:/tmp/show_log.txt 
AT-vFW-app# dir recursive flash:/ 
flash:/
        0 drwx Feb 26 2011 01:41:30  tmp/
      312 -rw- Feb 26 2011 01:02:19  default.cfg
...
flash:/tmp
     1599 -rw- Feb 26 2011 01:41:30  show_log.txt
     1060 -rw- Feb 26 2011 01:40:40  show_system.txt

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

初期設定では、端末画面の1ページ当たり行数は24に設定されています。コマンドの出力結果が24行よりも長い場合は、ページャー機能によって23行ごとに表示が一時停止し、最下行に次のようなメッセージが表示され、キー入力待ち状態になります。

--More--

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

表 3
Space 次の1ページを表示します。
Enter 次の1行を表示します。
q 表示を中止し、プロンプトに戻ります。

現在の端末セッションにおけるページ当たり行数はEXECモード（非特権および特権）のterminal lengthコマンドで変更できます。
AT-vFW-app> terminal length 60

現在の端末セッションにおいて、ページ単位の一時停止を無効にするには、terminal lengthコマンドに0を指定します。
AT-vFW-app> terminal length 0

前記のterminal lengthコマンドは実行コマンドなので、現在の端末セッションにしか影響を与えず、設定を保存しておくこともできません。ページ当たり行数の設定を永続的に変更したい場合は、ラインモードのlengthコマンドを使います。たとえば、仮想端末ポート0～32からのログイン時、ページ当たり行数がつねに60行になるようにするには、次のようにします。
AT-vFW-app(config)# line vty 0 32
AT-vFW-app(config-line)# length 60

端末に関する設定の詳細については、「運用・管理」の「端末設定」をご覧ください。