外部メモリファイルコピー機能

概要

本機能は、ルーター本体へ外部メモリ(USBメモリ、microSDメモリカード)を接続することにより、ルーターと外部メモリ間で各種データの操作を行うものです。使用できる外部メモリは機種によって異なります。

本機能により、以下の動作が可能となります。

  • 外部メモリボタンおよびダウンロードボタンの操作による動作
    • 外部メモリボタンとダウンロードボタンを同時に3秒以上押下し続け、外部メモリから設定ファイルおよびファームウェアファイルをコピーする
  • コマンド入力による動作
    • 外部メモリへSYSLOGメッセージを出力する
    • 外部メモリへ設定ファイルをコピーする
    • 外部メモリから設定ファイルをコピーする
    • 外部メモリからファームウェアファイルをコピーする
    • 外部メモリへ統計情報を出力する

外部メモリの基本的な使用方法、ボタン操作、LEDやブザー音の仕様、SYSLOGメッセージの詳細については、外部メモリの利用の資料をご参照ください。

対応機種とファームウェアリビジョン

ヤマハルーターでは以下の機種およびファームウェアで、外部メモリ機能をサポートします。

機種 ファームウェア
RTX5000 Rev.14.00.15以降
RTX820 Rev.11.03.16以降
RTX1200 Rev.10.01.20以降
RTX800 Rev.10.01.20以降

利用方法

外部メモリボタンおよびダウンロードボタンの操作

外部メモリボタンとダウンロードボタンを同時に3秒間押し続けると、外部メモリ内に保存されているファームウェアファイル、および設定ファイルをルーターの内蔵フラッシュROMへコピーすることができます。コピーは設定ファイル、ファームウェアファイルの順に行われ、成功するとアラームが鳴り、自動的に再起動します。

外部メモリ起動機能のある機種では、起動時に外部メモリが接続されていると、外部メモリに格納されているファームウェアファイルや設定ファイルで動作します。起動時のPOWERランプが点滅している間に外部メモリを抜けば、外部メモリは認識されずに内蔵フラッシュROMのファームウェアファイルと設定ファイルで動作します。POWERランプが点滅する約10秒間はまだ外部メモリを認識していませんので、外部メモリを抜く前に外部メモリボタンを押す必要はありません。
あるいは、external-memory boot permit offコマンドで、外部メモリから起動させないように設定しておくこともできます。
外部メモリのファイルで動作している時には、ファームウェアのバージョンアップ先や設定内容の保存先が外部メモリのファイルになります。

外部メモリ起動機能のない機種では、内蔵フラッシュROMのファームウェアファイルと設定ファイルで動作します。

この操作でコピーする各ファイルは、external-memory config filename コマンドとexternal-memory exec filename コマンドで指定することができます。
工場出荷状態では外部メモリ内の'config.txt'と'機種名.bin'という名前のファイルが、それぞれ設定ファイルとファームウェアファイルとしてルーターの内蔵フラッシュROMにコピーされます。例えばRTX1200の場合、ファームウェアファイルは'rtx1200.bin'という名前になります。

  • 例1:ボタン操作でコピーする設定ファイルを'rt_config.txt'に指定する
    # external-memory config filename sd1:rt_config.txt 0
    
  • 例2:ボタン操作でコピーするファームウェアファイルを'rt_firmware.bin'に指定する
    # external-memory exec filename sd1:rt_firmware.bin 0
    

設定ファイルとファームウェアファイルがルートディレクトリ以外に置かれている場合でも、自動検索してそれらを見つけることができます。詳しくは外部メモリの利用の資料をご参照ください。

  • 例1:microSDメモリカード内で指定ファイル(rt_config.txt)の検索を行い、コピー対象ファイルを取得する
    # external-memory config filename sd1:rt_config.txt 0
    
  • 例2:ルートディレクトリにある指定ファイル(rt_config.txt)をコピー対象ファイルとする
    # external-memory config filename sd1:/rt_config.txt 0
    

指定した設定ファイルとファームウェアファイルがどちらも存在しない状態でボタン操作を行った場合、コピー動作としては何もせず、アラームが鳴ります。

コマンド入力による操作

SYSLOGメッセージを外部メモリへ書き込む

external-memory syslog filename コマンドで、外部メモリに書き込むSYSLOGファイル名を設定します。このコマンドが設定されていないとSYSLOGメッセージの書き込みは行われません。

  • 例:USBメモリへSYSLOGを書き込むように設定する
    # external-memory syslog filename usb1:rt_syslog.log
    
  • 例:microSDメモリカードへSYSLOGを書き込むように設定する
    # external-memory syslog filename sd1:rt_syslog.log
    
  • 例:SYSLOGファイルのサイズを最大100Mbyte、保存するバックアップファイル数を30個に設定する (Rev.11.03 系以降で使用可能)
    # external-memory syslog filename sd1:rt_syslog.log limit=100 backup=30
    

なお、外部メモリ内のファイルへの書き込み時には、必要に応じてバックアップファイルが作成されます。バックアップファイルに関しては「バックアップファイル方式」を参照してください。

設定ファイルをルーターと外部メモリ間でコピーする

copy config コマンドで、設定ファイルをルーターの内蔵フラッシュROMから外部メモリへ書き込む、もしくはその逆の操作を行うことができます。

  • 例1:USBメモリ内の'rt_config1.txt'という設定ファイルを、ルーターの内蔵フラッシュROMにコピーする
    # copy config usb1:rt_config1.txt 0
    
  • 例2:ルーターの内蔵フラッシュROMに保存されている設定ファイルを、'rt_config2.txt'というファイル名でmicroSDメモリカードにコピーする
    # copy config 0 sd1:rt_config2.txt
    

ファームウェアファイルを外部メモリからコピーする

copy exec コマンドでは、外部メモリ内のファームウェアファイルをルーターの内蔵フラッシュROMにコピーすることができます。

  • 例:USBメモリ内の'rt_firmware.bin'というファームウェアファイルを、ルーターの内蔵フラッシュROMにコピーする
    # copy exec usb1:rt_firmware.bin 0
    

なお、copy config およびcopy exec コマンドで内蔵フラッシュROMにコピーした内容は、そのままでは実際の動作に反映されません。コピーした内容を反映させるには、コマンド実行後にルーターを再起動する必要があります。

統計情報を外部メモリへ出力する

statisticsコマンドで統計情報を取得したいものを選んでonにして、external-memory statistics filename prefixコマンドで外部メモリに出力するファイル名を設定します。これらのコマンドが設定されていないと統計情報の出力は行われません。
詳細はコマンドリファレンスを参照してください。

詳細

外部メモリへのSYSLOG保存

バックアップファイル方式

SYSLOGのバックアップファイルの保存方式について説明します。なお、機種、ファームウェアの違いにより、若干動作が異なっていますので、注意してください。

Rev.11.03 系以降の場合

SYSLOGメッセージを外部メモリ内へ保存する時、一連の処理の中で2種類のファイルを使用します。external-memory syslog filename コマンドで指定する、新規SYSLOGメッセージを書き込むためのファイル (以下、mainファイル) と、mainファイルのサイズが本コマンドで指定された上限値、もしくは自動計算によって設定された上限値に達した際の退避先となるファイル (以下、backupファイル) です。

新たに追加するSYSLOGメッセージは常にmainファイルに書き込まれます(下図1)。 ここで、mainファイルのサイズが、external-memory syslog filename コマンドで指定された上限値、もしくは空き容量から自動計算によって設定された上限値に達すると、その時点でmainファイルは一旦閉じられ、mainファイルをbackupファイル名に変更して退避させます(下図2)。そしてmainファイル名で新規にファイルをオープンし、書き込みを再開します(下図3)。 再び、mainファイルのサイズが上限値に達すると、同様にbackupファイルに退避させます。このとき、external-memory syslog filename コマンドで指定された backupファイル数の上限値に達した場合や外部メモリに空き容量がない場合には、backupファイル名に付加された日時データ("_yyyymmdd_hhmmss" 形式で表される文字列)の最も古いbackupファイルが削除されます(下図4)。

1. 新たなSYSLOGメッセージは常にmainファイルに書き込まれる
    +-------------+
    | ~~~~~  |
    | ~~~      |
    | ~~~~    |
    | ~~~~~  |
    | ~~~I     |
    |             |
    |             |
    +-------------+
      mainファイル

2. mainファイルのサイズが上限値に達したらmainファイルをbackupファイルとして退避
    +- - - - - - -+          +-------------+
      ~~~~~  |          | ~~~~~  |
    | ~~~                 | ~~~      |
      ~~~~    |  rename  | ~~~~    |
    | ~~~~~     ======> | ~~~~~  |
      ~~~~    |          | ~~~~    |
    | ~~~                 | ~~~      |
      ~~~~~  |          | ~~~~~  |
    + - - - - - - +          +-------------+
      mainファイル            backupファイル

3. mainファイル名で新規ファイルをオープンして書き込み再開
    +-------------+          +-------------+
    | ~~I       |          | ~~~~~  |
    |             |          | ~~~      |
    |             |          | ~~~~    |
    |             |          | ~~~~~  |
    |             |          | ~~~~    |
    |             |          | ~~~      |
    |             |          | ~~~~~  |
    +-------------+          +-------------+
      mainファイル            backupファイル

4. 再び、mainファイルのサイズが上限値に達したらmainファイルをbackupファイルとして退避
   条件次第で最も古いファイルを削除

    +-------------+          +-------------+    +-------------+   +-------------+          +- - - - - - -+
    | ~~~~~  |          | ~~~~~  |    | ~~~~~  |   | ~~~~~  |          |             |
    | ~~~      |          | ~~~      |    | ~~~      |   | ~~~      |          |             |
    | ~~~~    |  rename  | ~~~~    |    | ~~~~    |   | ~~~~    |  delete  |             |
    | ~~~~~  |  ======> | ~~~~~  |    | ~~~~~  |   | ~~~~~  |  ======> |             |
    | ~~~~    |          | ~~~~    |    | ~~~~    |   | ~~~~    |          |             |
    | ~~~      |          | ~~~      |    | ~~~      |   | ~~~      |          |             |
    | ~~~~~  |          | ~~~~~  |    | ~~~~~  |   | ~~~~~  |          |             |
    +-------------+          +-------------+    +-------------+   +-------------+          +- - - - - - -+
      mainファイル            backupファイル     backupファイル    backupファイル
                              20110103_000000    20110102_000000   20110101_000000

5. mainファイル名で新規ファイルをオープンして書き込み再開
   以降、項番2~4を繰り返す

このとき作成されるbackupファイル名は、mainファイル名の後に退避動作を行った日時を表す "_yyyymmdd_hhmmss" 形式の文字列を付加したものとなります。
以下に "_yyyymmdd_hhmmss" の文字列の意味を示します。

  • yyyy ... 西暦 (4 桁)
  • mm ... 月 (2 桁)
  • dd ... 日 (2 桁)
  • hh ... 時 (2 桁)
  • mm ... 分 (2 桁)
  • ss ... 秒 (2 桁)

例えば、mainファイル名が "syslog.txt" で、2011年1月1日 12時34分56秒 に backupファイルを作成した場合は、backupファイル名は、"syslog_20110101_123456.txt" となります。

外部メモリに十分な空き容量がある場合には、external-memory syslog filename コマンドで指定されたファイルサイズがmainファイルの上限サイズとなり、そのサイズのbackupファイルが指定されたファイル数分保存されます。しかし、十分な空き容量がない場合には、保存されるbackupファイルは、本コマンドで指定されたファイルサイズやbackupファイル数と異なることに注意してください。
また、必要に応じて、rotate external-memory syslog コマンドを実行することで、ファイルサイズに関係なく退避することができます。このとき、既に同名のbackupファイルが存在する場合には、退避は実行されません。
なお、mainファイルの上限サイズの自動計算については次項「SYSLOGファイルサイズの自動計算」を参照してください。

Rev.10.01 系の場合

SYSLOGメッセージを外部メモリ内へ保存する時、一連の処理の中で2種類のファイルを使用します。external-memory syslog filename コマンドで指定する、新規SYSLOGメッセージを書き込むためのファイル(以下、mainファイル)と、mainファイルのサイズが自動計算によって設定された上限値に達した際の退避先となるファイル(以下、backupファイル)です。

新たに追加するSYSLOGメッセージは常にmainファイルに書き込まれます(下図1)。ここで、mainファイルのサイズが自動計算によって設定された上限値に達すると、その時点でmainファイルは一旦閉じられ、mainファイルをbackupファイル名に変更して退避させます(下図2)。そしてmainファイル名で新規にファイルをオープンし、書き込みを再開します(下図3)。

1. 新たなSYSLOGメッセージは常にmainファイルに書き込まれる
    +-------------+
    | ~~~~~  |
    | ~~~      |
    | ~~~~    |
    | ~~~~~  |
    | ~~~I     |
    |             |
    |             |
    +-------------+
      mainファイル

2. mainファイルのサイズが上限値に達したらmainファイルをbackupファイルとして退避
    +- - - - - - -+          +-------------+
      ~~~~~  |          | ~~~~~  |
    | ~~~                 | ~~~      |
      ~~~~    |  rename  | ~~~~    |
    | ~~~~~     ======> | ~~~~~  |
      ~~~~    |          | ~~~~    |
    | ~~~                 | ~~~      |
      ~~~~~  |          | ~~~~~  |
    + - - - - - - +          +-------------+
      mainファイル            backupファイル

3. mainファイル名で新規ファイルをオープンして書き込み再開
    +-------------+          +-------------+
    | ~~I       |          | ~~~~~  |
    |             |          | ~~~      |
    |             |          | ~~~~    |
    |             |          | ~~~~~  |
    |             |          | ~~~~    |
    |             |          | ~~~      |
    |             |          | ~~~~~  |
    +-------------+          +-------------+
      mainファイル            backupファイル

このとき作成されるbackupファイル名は以下の規則に従って決定されます。

  • mainファイル名に拡張子があれば、その拡張子を'.bak'に置き換えた名前
  • mainファイル名に拡張子がなければ、mainファイル名に'.bak'を付加した名前

尚、名前の重複を避けるため、mainファイル名に'.bak'拡張子を含む名前を指定することはできません。

退避動作を行う時点でbackupファイルが既に存在している場合、既存のbackupファイルの内容は消去されるので注意してください。また、mainファイルの上限サイズの自動計算については次項「SYSLOGファイルサイズの自動計算」を参照してください。

SYSLOGファイルサイズの自動計算

外部メモリにSYSLOGメッセージを出力する際、ルーターは外部メモリの空き領域の範囲内でできるだけ多くのメッセージを残すように動作します。具体的には、SYSLOGメッセージの書き込みを開始する前に外部メモリの空き領域を調べ、その領域を各用途向けに以下のような割合で分配します。このとき、mainファイル用、およびbackupファイル用として割り当てられた範囲内でSYSLOGメッセージを書き込みます。

    +-------------------+  ----
    |    config保存用   |   ∧
    |            (注) |
    +-------------------+
    |                   |   外
    |                   |   部
    |   mainファイル用  |   メ
    |                   |   モ
    |                   |   リ
    +-------------------+   空
    |                   |   き
    |                   |   領
    |  backupファイル用 |   域
    |                   |
    |                   |   V
    +-------------------+  ----

  (注)統計情報の保存機能を有する機種では別途、統計情報ファイル保存用の領域が割り当てられる。

mainファイル、またはbackupファイルが既に存在する場合は、それらのファイル領域も空き領域の一部として計算されます。

上図において、外部メモリの空き容量をEn、config保存用の領域をCn、mainファイル用の領域をMn、またbackupファイル用の領域をBnとすると、各領域のサイズはおよそ以下のような計算で求められます。

    Cn: 1MB、もしくはEn/10のうち、どちらか大きい方。但し、En/10の上限は100MB
    Bn: (En - Cn)/2
    Mn: En - Cn - Bn

    ※実際に設定される値は上記計算値よりも若干小さくなる場合があります

また書き込み途中に、外部メモリ内の空き容量の変化によりmainファイルに上限サイズまで書き込めなかった場合は、その時点でのmainファイルをbackupファイルとして退避させ、再び上述の方法で各使用領域を計算します。

動作状態の確認

本機能の動作状態の確認には、show status external-memory コマンドを使用します。以下に、コマンド入力時の表示例を示します。

外部メモリの動作状態を表示
# show status external-memory
ホストコントローラ:     動作中                              ...1
SYSLOG設定                                                  ...2
  書き込み先ファイル名: usb1:rt_syslog.txt [書き込み可]
  退避先ファイル名:     usb1:rt_syslog.bak
  最大ファイルサイズ:   925859840 バイト
  書き込みバッファ:     OK
統計情報設定                                                ...(注)
  書き込み先ファイル名: [設定されていません]                ...(注)
SYSLOG統計
  書き込み回数:         16 (TIMER:16, FULL:0)
  廃棄回数:             0 (FULL:0)
  廃棄行数:             0
ファイル操作統計                                            ...(注)
  記録中止:             0
  オープン失敗:         0
  退避回数:             0
  退避失敗:             0 (DELETE:0, RENAME:0, CLOSE:0)
  書き込みエラー:       0
  再書き込みエラー:     0
 usb1
給電:                   ON                                  ...3
接続中のデバイス:                                           ...4
  デバイス名:           0xXXXX <USB_DEVICE_01>
  ベンダー名:           0xYYYY <USB_VENDOR_01>
  最大転送速度:         480Mbps(High speed)
  記憶容量:             2015200 KB
MASS Storage Class転送統計
  タイムアウト:         0
  ストール:             0
  キャンセル:           0
  I/Oエラー:            0
  その他エラー:         0
 sd1
給電:                   ON
接続中のデバイス:       接続されていません
  1. ホストコントローラが正常に動作しているか否か
  2. SYSLOGの書き込み設定情報(書き込み先ファイル名、バックアップファイル名、書き込み先ファイルの上限サイズ)
    ※(Rev.11.03 系以降の場合)
    退避先ファイル名には、"usb1:rt_syslog_YYYYMMDD_HHMMSS.txt" と表示される
  3. 給電状態(ONまたはOFF。過電流検出により強制的に給電がOFFになっている場合はその旨を表示)
  4. 接続されている外部メモリのデバイス情報(デバイス名、ベンダー名、最大転送速度、記憶容量)
    ※外部メモリが接続されていない場合は表示されません

(注) 統計情報機能がない機種では、この行は表示されません。

SYSLOG保存に関する注意事項

  1. external-memory syslog filename コマンドで指定したSYSLOG記録用のファイルが、挿入された外部メモリに既に存在する場合は、上限のサイズになるまでファイルの末尾から追記されていきます。
  2. SYSLOGの記録は外部メモリとして認識されるまでは開始されません。従ってルーター起動時等に出力されるSYSLOGは外部メモリに記録されず、必ずしもルーター本体で表示されるSYSLOGと外部メモリに記録される内容は一致しません。
  3. 同じ内容のSYSLOGが連続して出力される場合は外部メモリへの書き込みを省略し、"same message repeated N times"のように繰り返された回数だけを記録します。

コマンド仕様

Rev.11.03 系以降

外部メモリに保存するSYSLOGファイル名の指定

[書式]
external-memory syslog filename NAME [CRYPTO PASSWORD]  [limit=SIZE] [backup=NUM]
no external-memory syslog filename [NAME]
[設定値]
  • NAME ... SYSLOGファイル名
    (FILENAMEは、暗号化する場合でファイル名に拡張子を指定しないときは、半角78文字以内、それ以外の場合では、半角83文字以内)
    • usb1:FILENAME ... USB1メモリ内のファイル
    • usb2:FILENAME ... USB2メモリ内のファイル
    • sd1:FILENAME ... microSDメモリカード内のファイル
  • CRYPTO ... SYSLOGを暗号化して保存する場合の暗号アルゴリズムの選択
    • aes128 ... AES128で暗号化する
    • aes256 ... AES256で暗号化する
  • PASSWORD ... ASCII文字列で表したパスワード(半角8文字以上、32文字以内)
  • SIZE ... SYSLOG ファイルの上限サイズ ( 1 - 1024 単位:MB ) 初期値:10
  • NUM ... バックアップファイルの上限数 ( 1 - 100 ) 初期値:10
[説明]

外部メモリに保存する SYSLOG ファイル名を設定する。
FILENAME に .bak 拡張子を含むファイル名は指定できない。また、暗号化しない場合、FILENAME に .rtfg 拡張子を含むファイル名は指定できない。
CRYPTO およびPASSWORD を指定した場合、SYSLOG は暗号化してから外部メモリに書き込まれる。暗号化する場合、FILENAME に .rtfg 拡張子を含めるか、拡張子を省略した名前を指定する必要がある。拡張子を省略した場合、自動的にファイル名に .rtfg 拡張子が追加される。
SYSLOG ファイルが上限サイズに達すると、SYSLOG ファイルのバックアップが行われる。バックアップファイル名は、FILENAME で指定されたファイル名の後にバックアップを行った日時を表す_yyyymmdd_hhmmss 形式の文字列を付加したものとなる。

  • yyyy ... 西暦 (4 桁)
  • mm ... 月 (2 桁)
  • dd ... 日 (2 桁)
  • hh ... 時 (2 桁)
  • mm ... 分 (2 桁)
  • ss ... 秒 (2 桁)

バックアップファイル数が NUM で指定される上限数に達した場合、もしくは外部メモリに空き容量がなくなった場合は、最も古いバックアップファイルを削除してから新しいバックアップファイルが作成される。
本コマンドが設定されていないときは SYSLOG は外部メモリに書き込まれない。

[ノート]

以下の変更を行う場合、FILENAMEを変更しなければならない。

  • SYSLOGを暗号化しないで保存する設定から暗号化して保存する設定に変更する場合
  • SYSLOGを暗号化して保存する設定から暗号化しないで保存する設定に変更する場合
  • 暗号アルゴリズムまたはパスワードを変更する場合
[初期値]

設定されていない

[適用モデル]
RTX5000RTX820

外部メモリに保存された SYSLOG ファイルのローテート(バックアップ)

[書式]
rotate external-memory syslog
[説明]

外部メモリに保存された SYSLOG ファイルのローテート(バックアップ)を行う。
現在書き込み中の SYSLOG ファイルをバックアップファイルに退避し、新たに書き込み用の SYSLOG ファイルを作成する。既に同名のバックアップファイルが存在する場合には実行されない。
また、バックアップファイルを作成する際、バックアップファイル数が external-memory syslog filename コマンドで指定される上限数に達した場合、もしくは外部メモリに空き容量がなくなった場合は、最も古いバックアップファイルを削除してから新しいバックアップファイルが作成される。
バックアップファイル名の書式については、external-memory syslog filename コマンドを参照のこと。
なお、本コマンドは、external-memory syslog filename コマンドで SYSLOG ファイル名が設定されており、かつ、指定された外部ストレージインタフェースに外部メモリが接続されている場合にのみ動作する。

[ノート]

schedule at コマンドで定期的に本コマンドを実行するようにしておくと、日毎、週毎、あるいは月毎のSYSLOG のバックアップファイルを自動で作成することが可能になる。

[設定例]
schedule at 1 */* 00:00 * rotate external-memory syslog    # 毎日バックアップを実行する
schedule at 1 */man 00:00 * rotate external-memory syslog  # 毎週月曜日にバックアップを実行する
schedule at 1 */1 00:00 * rotate external-memory syslog    # 毎月 1日にバックアップを実行する
[適用モデル]
RTX5000RTX820

外部メモリに保存された SYSLOG のクリアとバックアップファイルの削除

[書式]
clear external-memory syslog
[説明]

外部メモリに保存された現在書き込み中の SYSLOG ファイル内のログのクリアとすべての SYSLOG のバックアップファイルの削除を行う。
削除の対象となる SYSLOG のバックアップファイルは、external-memory syslog filename コマンドで指定されたパス内に存在するファイルが対象となる。
なお、本コマンドは、external-memory syslog filename コマンドで SYSLOG ファイル名が設定されており、かつ、指定された外部ストレージインタフェースに外部メモリが接続されている場合にのみ動作する。

[適用モデル]
RTX5000RTX820

Rev.10.01 系の場合

外部メモリに保存するSYSLOGファイル名の指定

[書式]
external-memory syslog filename NAME [CRYPTO PASSWORD]
no external-memory syslog filename [NAME]
[設定値]
  • NAME ... SYSLOGファイル名
    (FILENAMEは64文字以内。ただし、.bak拡張子を含む名前は指定できない)
    • usb1:FILENAME ... USB1メモリ内のファイル
    • usb2:FILENAME ... USB2メモリ内のファイル
    • sd1:FILENAME ... microSDメモリカード内のファイル
  • CRYPTO ... SYSLOGを暗号化して保存する場合の暗号アルゴリズムの選択
    • aes128 ... AES128で暗号化する
    • aes256 ... AES256で暗号化する
  • PASSWORD ... ASCII文字列で表したパスワード(半角8文字以上、32文字以内)
[説明]

外部メモリ内に保存するSYSLOGファイル名を指定する。
バックアップファイルとの名前の重複を避けるため、FILENAMEに.bak拡張子を含むファイル名は指定できない。
CRYPTOおよびPASSWORDを指定した場合、SYSLOGは暗号化してから外部メモリに書き込まれる。暗号化する場合、FILENAMEに.rtfg拡張子を含めるか、拡張子を省略した名前を指定する必要がある。拡張子を省略した場合、自動的にファイル名に.rtfg拡張子を追加する。
ファイルに書き込むことのできるサイズの上限は、外部メモリへの書き込み開始時の空き容量から自動計算され、SYSLOG ファイルが上限サイズに達すると、SYSLOG ファイルのバックアップが行われる。このとき作成されるファイル名は以下の規則に従って決定される。

  • FILENAMEに拡張子が含まれている場合 ... 拡張子を.bak に置き換える
  • FILENAMEに拡張子が含まれていない場合 ... FILENAME.bak とする

本コマンドが設定されていないときは SYSLOG は外部メモリに書き込まれない。

[ノート]

以下の変更を行う場合、FILENAMEを変更しなければならない。

  • SYSLOGを暗号化しないで保存する設定から暗号化して保存する設定に変更する場合
  • SYSLOGを暗号化して保存する設定から暗号化しないで保存する設定に変更する場合
  • 暗号アルゴリズムまたはパスワードを変更する場合
[初期値]

設定されていない

[適用モデル]
RTX1200 RTX800

外部メモリボタンとDOWNLOADボタン同時押下によるファイルコピーを許可するか否かの設定

[書式]
operation external-memory download permit SWITCH
no operation external-memory download permit [SWITCH]
[設定値]
  • SWITCH
    • on ... 許可する
    • off ... 許可しない
[説明]

ボタン操作による外部メモリからのファイルのコピーを許可するか否かを設定する。

読み込む設定ファイルとファームウェアファイルの名前はそれぞれ、external-memory config filename コマンドとexternal-memory exec filename コマンドで設定できる。

[初期値]

on

[適用モデル]
RTX1200 RTX820 RTX800

起動時、あるいは外部メモリボタンとDOWNLOADボタン同時押下により読み込まれる、設定ファイル名の指定

[書式]
external-memory config filename FROM [TO] [PASSWORD]
external-memory config filename off
no external-memory config filename [FROM] [TO] [PASSWORD]
no external-memory config filename [off]
[設定値]
  • FROM ... 外部メモリ内の設定ファイル名を指定する (FILENAMEは64文字以内)
    • usb1:FILENAME ... USB1メモリ内の設定ファイル
    • usb2:FILENAME ... USB2メモリ内の設定ファイル
    • sd1:FILENAME ... microSDカード内の設定ファイル
    • *:FILENAME ... USBメモリおよびmicroSDカード内の設定ファイル
  • TO ... コピー先ファイル名
    • NUM ... 内蔵フラッシュROMの設定ファイル番号(省略時は0)
  • PASSWORD ... 復号パスワード(ASCII文字列で半角8文字以上、32文字以内)
[説明]

外部メモリを差して起動した時に、あるいは外部メモリボタンとDOWNLOADボタンを同時に押下した時に読み込まれる、外部メモリ上の設定ファイル名を指定する。

また外部メモリボタンとDOWNLOADボタンを同時に押下した時は、設定ファイルは内蔵フラッシュROMにコピーされるが、その時のコピー先の内蔵フラッシュROMの設定ファイル番号も指定できる。

外部メモリを指定した場合、その外部メモリからの読み込みだけが行われる。

外部メモリに"*"を指定した場合、指定するファイルの検索はまずmicroSDメモリカードから行われ、指定したファイルがなければUSBメモリが検索される。ボタン操作の場合は該当するボタンの外部メモリだけがファイル検索の対象となる。

FILENAMEは絶対パスを使って指定するかファイル名のみを指定する。ファイル名のみを指定した場合は指定された外部メモリ内から検索される。

複数のファイルがある場合、ディレクトリ階層上最もルートディレクトリに近いものが選ばれる。

offに指定した場合、設定ファイルの検索と読み込みを行わない。

パスワードを指定して暗号化されている設定ファイルを復号して読み込む場合は、PASSWORDに暗号化したときのパスワードを設定する。

[ノート]

RTX1200/RTX800 Rev.10.01.33 以降、および、Rev.11.03 系以降では、FILENAMEは99文字以内。

[設定例]
# external-memory config filename sd1:config.txt

misroSDカード内から"config.txt"を検索し、設定ファイルとして読み込む

# external-memory config filename sd1:/dir1/config.txt

misroSDカード内のディレクトリ"dir1"から"config.txt"を検索し、設定ファイルとして読み込む

[初期値]

*:config.rtfg,*:config.txt 0 (RTX1200, RTX820, RTX800)
sd1:config.rtfg,sd1:config.txt 0 (RTX5000)

[適用モデル]
RTX5000 RTX1200 RTX820 RTX800

起動時、あるいは外部メモリボタンとDOWNLOADボタン同時押下により読み込まれる、ファームウェアファイル名の指定

[書式]
external-memory exec filename FROM [TO]
external-memory exec filename off
no external-memory exec filename [FROM TO]
no external-memory exec filename [off]
[設定値]
  • FROM ... 外部メモリとファームウェアファイル名 (FILENAMEは64文字以内)
    • usb1:FILENAME ... USB1メモリ内のファームウェアファイル名
    • usb2:FILENAME ... USB2メモリ内のファームウェアファイル名
    • sd1:FILENAME ... microSDカード内のファームウェアファイル
    • *:FILENAME ... USBメモリおよびmicroSDカード内のファームウェアファイル
  • TO ... コピー先ファイル名
    • NUM ... 内蔵フラッシュROMの実行形式ファームウェアファイル番号(省略時は0)
  • off ... ファームウェアファイルの検索と読み込みを行わない
[説明]

外部メモリを差して起動した時、あるいは外部メモリボタンとDOWNLOADボタンを同時に押下した時に読み込まれる、外部メモリ上のファームウェアファイル名を指定する。

外部メモリボタンとDOWNLOADボタンを同時に押下した時は、ファームウェアファイルは内蔵フラッシュROMにコピーされるが、その時のコピー先の内蔵フラッシュROMのファームウェアファイル番号も指定できる。

外部メモリを指定した場合、その外部メモリからの読み込みだけが行われる。

外部メモリに"*"を指定した場合、指定するファイルの検索はまずmicroSDメモリカードから行われ、指定したファイルがなければUSBメモリが検索される。ボタン操作の場合は該当するボタンの外部メモリだけがファイル検索の対象となる。

FILENAMEは絶対パスを使って指定するかファイル名のみを指定する。ファイル名のみを指定した場合は指定された外部メモリ内から検索される。

検索の結果複数のファイルが該当する場合、ディレクトリ階層上最もルートディレクトリに近いものが選ばれる。

offに指定した場合、ファームウェアファイルの検索と読み込みを行わない。

[ノート]

RTX1200/RTX800 Rev.10.01.33 以降、および、Rev.11.03 系以降では、FILENAMEは99文字以内。

[設定例]
# external-memory exec filename sd1:rtx1200.bin

misroSDカード内から"rtx1200.bin"を検索し、ファームウェアファイルとして読み込む

# external-memory exec filename sd1:/dir1/rtx1200.bin

misroSDカード内のディレクトリ"dir1"から"rtx1200.bin"を検索し、ファームウェアファイルとして読み込む

[初期値]

*:機種名.bin 0 (RTX1200, RTX820, RTX800)
sd1:機種名.bin 0 (RTX5000)

[適用モデル]
RTX5000 RTX1200 RTX820 RTX800

共通

設定ファイルの複製

[書式]
copy config FROM TO
copy config FROM TO CRYPTO [PASSWORD]
copy config FROM TO [PASSWORD]
[設定値]
  • FROM ... コピー元ファイル名 (FILENAMEは64文字以内)
    • NUM ... 内蔵フラッシュROMの設定ファイル番号(0..4.2)
    • usb1:FILENAME ... USB1メモリ内の設定ファイル名
    • usb2:FILENAME ... USB2メモリ内の設定ファイル名
    • sd1:FILENAME ... microSDカード内の設定ファイル名
  • TO ... コピー先ファイル名 (FILENAMEは64文字以内)
    • NUM ... 内蔵フラッシュROMの設定ファイル番号(0..4)
    • usb1:FILENAME ... USB1メモリ内の設定ファイル名
    • usb2:FILENAME ... USB2メモリ内の設定ファイル名
    • sd1:FILENAME ... microSDカード内の設定ファイル名
  • CRYPTO ... 暗号アルゴリズムの選択
    • aes128 ... AES128で暗号化する
    • aes256 ... AES256で暗号化する
  • PASSWORD ... 暗号化/復号のパスワード(ASCII文字列で半角8文字以上、32文字以内)
[説明]

保存されている設定ファイルを複製する。
コピー元、コピー先の両方に外部メモリのファイルを指定することはできない。
cold start 直後は設定ファイルが存在しないので内蔵フラッシュROM から外部メモリへ設定ファイルのコピーはできない。この場合、一度 save コマンドで設定を保存してから実行する必要がある。
内蔵フラッシュROMへコピーした内容を、実際の動作に反映させるためには、本コマンドの実行後にルーターを再起動する必要がある。

コピー元に外部メモリを指定する場合、FILENAMEに絶対パスを使ってファイルを指定するかファイル名のみを指定する。FILENAMEにファイル名のみを指定した場合は外部メモリ内から自動検索する。
複数のファイルがある場合、ディレクトリ階層上最もルートディレクトリに近く、アルファベット順に先のディレクトリにあるファイルが選ばれる。
コピー先に外部メモリを指定する場合、FILENAMEに絶対パスを使ってファイルを指定する。

外部メモリを対象として暗号化機能を利用することができる。
CRYPTOを指定した場合、設定ファイルを暗号化してから外部メモリにコピーする。暗号化してコピーする場合、ファイル名には.rtfg 拡張子を含めるか、拡張子を省略した名前を指定する必要がある。拡張子を省略した場合、自動的にファイル名に.rtfg 拡張子を追加する。
パスワードを省略した暗号化を行うことができる。

[ノート]

外部メモリ上の暗号化された設定ファイルを復号しないで内蔵フラッシュROMにコピーすることはできない。
第2書式は、内蔵フラッシュROMの設定ファイルを外部メモリへ暗号化してコピーする場合にのみ利用できる。
第3書式は、外部メモリ内の暗号化された設定ファイルを復号して内蔵フラッシュROM内にコピーする場合にのみ利用できる。復号するときの暗号アルゴリズムは自動的に判別するので、復号時には暗号アルゴリズムを指定する必要はない。
外部メモリ内のファイルを指定できるのは、外部メモリインタフェースを持つ機種に限られる。
内蔵フラッシュROMの設定ファイル番号をコピー先ファイルとした場合、元のコピー先ファイルはこのコマンドの実行後は退避ファイルとなる。

外部メモリのディレクトリ構成やファイル数によっては、ファイルの検索に時間がかかることがある。
検索時間を短くするためには、階層の深いディレクトリの作成は避けてルートに近い位置にファイルを格納したり、ファイルを絶対パスで直接指定することが望ましい。自動検索のタイムアウトの時間は external-memory auto-search time コマンドで設定できる。

RTX1200/RTX800 Rev.10.01.33 以降、および、Rev.11.03 系以降では、FILENAMEは99文字以内。

[適用モデル]
RTX5000RTX1200RTX820RTX800

ファームウェアファイルを内蔵フラッシュROMにコピー

[書式]
copy exec FROM TO
[設定値]
  • FROM ... コピー元ファイル名 (FILENAMEは64文字以内)
    • NUM ... 内蔵FlashROMの実行形式ファームウェアファイル番号(0)
    • usb1:FILENAME ... USB1メモリ内の実行形式ファームウェアファイル名
    • usb2:FILENAME ... USB2メモリ内の実行形式ファームウェアファイル名
    • sd1:FILENAME ... microSDカード内の実行形式ファームウェアファイル名
  • TO ... コピー先ファイル名
    • NUM ... 内蔵FlashROMの実行形式ファームウェアファイル番号(0..1)
[説明]

実行形式ファームウェアファイルを内蔵フラッシュROMにコピーする。
内蔵フラッシュROMへコピーした内容を、実際の動作に反映させるためには、本コマンドの実行後にルーターを再起動する必要がある。

コピー元に外部メモリを指定する場合、FILENAMEに絶対パスを使ってファイルを指定するかファイル名のみを指定する。FILENAMEにファイル名のみを指定した場合は外部メモリ内から自動検索する。
複数のファイルがある場合、ディレクトリ階層上最もルートディレクトリに近く、アルファベット順に先のディレクトリにあるファイルが選ばれる。

[ノート]

外部メモリ内のファイルを指定できるのは、外部メモリインタフェースを持つ機種に限られる。
コピー先ファームウェアファイル番号に0以外を指定できるのはファームウェア多重機能を持つ機種に限られる。

外部メモリのディレクトリ構成やファイル数によっては、ファイルの検索に時間がかかることがある。
検索時間を短くするためには、階層の深いディレクトリの作成は避けてルートに近い位置にファイルを格納したり、ファイルを絶対パスで直接指定することが望ましい。

自動検索のタイムアウトの時間は external-memory auto-search time コマンドで設定できる。

RTX1200/RTX800 Rev.10.01.33 以降、および、Rev.11.03 系以降では、FILENAMEは99文字以内。

[適用モデル]
RTX5000 RTX1200 RTX820 RTX800

ページトップへ戻る