外部メモリの利用

外部メモリの利用

1. 機能概要

本製品では、外部メモリを使った以下の機能を提供します。

  • SDカードブート(ファームウェア、コンフィグ)

    • SDカード内のファームウェアファイル、コンフィグファイルを使用してシステムを起動できます。

  • SDカードブート自動適用(ファームウェア、コンフィグ)

    • SDカードブートで使用したファームウェアやコンフィグを次回起動時にSDカードが無くても適用することができます。

  • ファームウェア更新

    • SDカード内のファームウェアファイルを読み込んで本体のファームウェアを更新することができます。

  • コンフィグファイルの保存・コピー

    • 現在システムで稼働中のrunning-configをSDカード内に保存したり、SDカードから本体Flash ROM、本体Flash ROMからSDカードへコンフィグファイルをコピーできます。

  • ログファイルの保存

    • save logging コマンド実行時にSDカード内にログファイルをバックアップすることができます。

  • 技術サポート情報の保存

    • 技術サポート情報( show tech-support コマンドの実行結果)をSDカード内に保存できます。

  • 統計情報の保存

    • リソース情報、トラフィック情報の観測データを定期的にバックアップします。

    • 観測データの統計情報をCSVファイル形式で保存できます。

  • システム情報のバックアップ・リストア

    • システム情報(コンフィグを含む)をSDカードにバックアップすることができます。

    • バックアップしたシステム情報を本体Flash ROMにリストアすることができます。

2. 用語の定義

特になし

3. 機能詳細

3.1. 利用可能な外部メモリ

利用可能な外部メモリの条件は以下の通りです。

  • カードタイプ: microSDカード/microSDHCカード

  • ファイルフォーマット: FAT16/FAT32

3.2. フォルダ構成

SDカード内は以下のフォルダ構成である必要があります。

機種名   +-- firmware          ファームウェアファイル保存フォルダ
         |
         |
         +-- startup-config    スタートアップコンフィグ保存フォルダ
         |
         |
         +-- log               SYSLOG保存フォルダ
         |
         |
         +-- techsupport       技術サポート情報保存フォルダ
         |
         |
         +-- data              システム共通フォルダ
         |
         |
         +-- backup-system     システムバックアップフォルダ

3.3. SDカードのマウント/アンマウント

SDカードが起動時、または起動後に挿入された時、自動的にマウントされ、利用可能となります。

ファイルの欠損などを防止するため、SDカードを抜く時には事前に unmount sd コマンドを実行するか、Web GUIからアンマウントを実行してください。
SDカードがアンマウント状態のとき、SDカードを利用することができません。
unmount sd コマンド実行後に再度利用したい場合は、以下を実行する必要があります。

  • 一度SDカードを抜き差しする

  • mount sd コマンドを実行する

  • Web GUIからマウントを実行する

3.4. SDカードブート(ファームウェア、コンフィグ)

SDカード内に保存されたファームウェアファイルやコンフィグファイルを利用してシステムを起動することができます。
SDカードブートを利用するためには以下の条件を満たす必要があります。

  • ファームウェアファイルを利用したSDカードブート

    • システム起動時にSDカードが接続されている。

    • SDカード内に以下のファイルが存在する。

      • /swx2310p/firmware/swx2310p.bin

    • boot prioritize sd enable が設定されている。
      ※工場出荷状態では boot prioritize sd enable が設定されています。

  • コンフィグファイルを利用したSDカードブート

    • システム起動時にSDカードが接続されている。

    • SDカード内に以下のファイルが存在する。

      • /swx2310p/startup-config/config.txt

    • startup-config select sd が設定されている。
      ※工場出荷状態では startup-config select sd が設定されています。

なお、SDカードブート自動適用機能(SDカードブート自動適用)を利用することで、SDカードブートに使用したファイルを内蔵Flash ROMへ自動的に適用することもできます。

SDカードブートに成功したか否かは show environment コマンドで確認可能です。

  • ファームウェアファイルを利用したSDカードブートの場合、"Startup Firmware"に"exec(SD)"と表示されます。

  • コンフィグファイルを利用したSDカードブートの場合、"Startup Configuration"に"config(SD)"と表示されます。

コンフィグファイルを利用したSDカードブートの場合、 write , copy running-config startup-config コマンドを実行すると、SDカード内のコンフィグファイルを更新します。
コンフィグファイルを利用したSDカードブートに失敗した場合は、スタートアップコンフィグ #0 が読み込まれます。
また、以下のメッセージがコンソールとSYSLOGに表示されます。

Loading config0 because can't read config in SD card.

3.5. SDカードブート自動適用(ファームウェア、コンフィグ)

SDカードブートに使用したファームウェアやコンフィグを、内蔵Flash ROMに自動適用することができます。
本機能を利用することで、新しく購入した機器(工場出荷状態)に、予め用意しておいたファームウェアとコンフィグを簡単に導入することができます。

3.5.1. 自動適用のための事前準備

本機能を動作させるためには、以下の条件を満たす必要があります。

  • 以下いずれかのSDカードブートを可能な状態にする(詳細はSDカードブートを参照)

    • boot prioritize sd enable が設定されており、SDカードの適切なパスにファームウェアが存在する

    • startup-config select sd が設定されており、SDカードの適切なパスにコンフィグが存在する

  • SDカードブート自動適用機能を有効にする

    • SDカードブート自動適用機能は、 boot auto-apply enable コマンドで有効にすることができます。
      (※工場出荷時は有効)

    • show environment コマンドの「Boot auto-apply」の表示結果により、機能の有効/無効を確認することが可能です。

  • SDカードブート自動適用するためのファイルを用意する

    • ファームウェアを自動適用させる場合

      • SDカード内のfirmwareフォルダに auto-apply.txt (空のテキストファイル)を用意する。

        /swx2310p/firmware/auto-apply.txt
    • コンフィグを自動適用させる場合

      • SDカード内のstartup-configフォルダに auto-apply.txt (空のテキストファイル)を用意する。

        /swx2310p/startup-config/auto-apply.txt
3.5.2. 自動適用の手順

SDカードブートの自動適用の手順は以下のようになります。

  1. 事前準備(自動適用のための事前準備を参照)

  2. SDカードをセットし本製品を起動

  3. SDカードブート完了後、指定ファイルを内蔵Flash ROMへ自動適用(ファームウェアの自動適用時、起動時間が通常より長くなります。)

  4. 自動適用結果の保存(自動適用の結果を参照)

  5. SDカードを自動アンマウント

  6. microSD LEDを自動消灯

3.5.3. 自動適用の結果

自動適用の実行結果はSDカード内に保存されます。

ファイル名と配置パス ログ

/swx2310p/startup-config/auto-apply-result.txt

シリアル : 日時 : 結果

/swx2310p/firmware/auto-apply-result.txt

シリアル : 日時 : 結果

3.5.4. コンフィグの適用先

コンフィグの適用先を任意のコンフィグIDへ変更したい場合は、作成した auto-apply.txt のファイル名を以下のように変更してください。
指定しない場合は、デフォルトのコンフィグID 0が適用先になります。

ファイル名と配置パス コンフィグID

/swx2310p/startup-config/auto-apply.txt

0

/swx2310p/startup-config/auto-apply0.txt

0

/swx2310p/startup-config/auto-apply1.txt

1

/swx2310p/startup-config/auto-apply2.txt

2

/swx2310p/startup-config/auto-apply3.txt

3

/swx2310p/startup-config/auto-apply4.txt

4

3.5.5. 注意事項

本機能を利用する際は、以下に注意してください。

  • 自動適用に成功すると本機能は自動で無効になります。
    自動で無効になることを回避するためには、作成した auto-apply.txt 内の先頭に、以下のように「keep」という文字列を記述する必要があります。

    keep
  • スタック機能が有効の場合、本機能は動作しません。

  • SDカード内に auto-apply.txt が存在しない場合、本機能は動作しません。

  • SDカードブートをしていない場合、 auto-apply.txt が存在していても自動適用は失敗となります。
    SDカードブートを参考に、SDカード内のファイルおよびSDカードブート機能が有効になっていることを確認してください。

  • 自動適用に失敗した場合、本機能は自動で無効にはならず、SDカードのみアンマウントされます。

  • 自動適用機能を使用しない場合は、誤動作を防ぐために auto-apply.txt は必ず削除するようにしてください。

3.6. ファームウェア更新

SDカード内のファームウェアファイルを読み込んで本体のファームウェアを更新することができます。

本機能を利用するためには以下の条件があります。

  • SDカード内に以下のファイルが存在する。

    • /swx2310p/firmware/swx2310p.bin

SDカードが挿入され上記ファイルが存在する場合、 firmware-update sd execute コマンドを実行すると、SDカード内のファームウェアファイルを使ってFlash ROM内のファームウェアを更新します。

firmware-update sd execute コマンドを実行すると、ファームウェアファイルの読み込みが完了したときにSDカードのマウント状態を継続するかユーザーに確認します。SDカードは必要に応じてアンマウント後に抜いてください。
ファームウェア更新による自動再起動時にSDカードを挿したままの状態にすると、SDカード内のファームウェアファイルでシステムが起動されてしまうため、ご注意ください。

スタック構成中にメインスイッチから firmware-update sd execute コマンドを実行すると、メンバースイッチのファームウェアも更新することができます。

3.7. コンフィグファイルの保存・コピー

現在システムで稼働中のrunning-configをSDカード内に保存することができます。( copy running-config startup-config コマンド、 write コマンド)

SDカードから本体Flash ROM、本体Flash ROMからSDカードへコンフィグファイルをコピーできます。( copy startup-config コマンド)

SDカード内のstartup-configを消去、表示できます。( erase startup-config コマンド、 show startup-config コマンド)

SDカード内の以下のフォルダが対象となります。

  • /swx2310p/startup-config

3.8. ログファイルの保存

save logging コマンド実行時にSDカード内にログファイルをバックアップすることができます。

logging backup sd コマンドにより、SDカードへのSYSLOGバックアップを有効にすることが可能です。
SDカードへのSYSLOGバックアップが有効なとき、 save logging コマンドを実行すると、SDカード内に以下の保存日付入りログファイルが保存されます。

  • /swx2310p/log/YYYYMMDD_log.txt ※YYYYMMDD=年月日

SDカード内のログファイルの表示、消去はできません。

3.9. 技術サポート情報の保存

技術サポート情報( show tech-support コマンドの実行結果)をSDカード内に保存できます。
copy tech-support sd コマンドを実行すると、SDカード内に以下の保存日付入り技術サポート情報ファイルが保存されます。

  • /swx2310p/techsupport/YYYYMMDDHHMMSS_techsupport.txt ※YYYYMMDD=年月日、HHMMSS=時分秒

SDカード内の技術サポート情報ファイルの表示、消去はできません。

スタック構成中にメインスイッチから copy tech-support sd コマンドを実行すると、メンバースイッチの技術サポート情報を含んだファイルが保存されます。

3.10. 統計情報の保存

リソース情報、トラフィック情報の観測データを定期的にバックアップします。
SDカードへの統計情報のバックアップを有効にするには、WebGUIの[管理]-[保守]-[統計情報の管理]より設定する必要があります。

また、観測データの統計情報をWebGUIよりCSVファイル形式で保存できます。

3.11. システム情報のバックアップ・リストア

本体のシステム情報をSDカードにバックアップし、バックアップしたシステム情報を任意のスイッチに対してリストアすることができます。
本体にSDカードを接続した状態で backup system コマンドを実行すると、 以下のフォルダにシステム情報のバックアップを作成します。

  • /swx2310p/backup-system

バックアップ実行時に /swx2310p/firmware/ フォルダに swx2310p.bin ファイルが存在した場合、ファームウェアファイルとしてバックアップします。

システム情報のバックアップが格納されているSDカードを任意のスイッチに接続し、 restore system コマンドを実行するとバックアップしたシステム情報をリストアします。
ファームウェアファイルがバックアップされていた場合、そのファイルを使ってファームウェア更新も行います。
リストアが完了するとシステムを再起動します。

システム情報のバックアップには以下が含まれます。

  • 本体に付随する設定

    • startup-config #0 - #4 とそれらに付随する情報

    • startup-config select コマンドの設定値

    • boot prioritize sd コマンドの設定値

  • ファームウェアファイル
    ※バックアップ実行時、SDカードの指定フォルダにファームウェアファイルを保存していた場合に限る

そのため、故障による機器交換などを行う際、バックアップしたシステム情報をリストアするだけで交換前の機器と同じ動作を再現することができます。
バックアップされたシステム情報に対して、編集や削除などを行わないでください。

4. 関連コマンド一覧

関連コマンドについて、以下に示します。
詳細は、コマンドリファレンスを参照願います。

操作項目 操作コマンド

SDカードのマウント

mount sd

SDカードのアンマウント

unmount sd

ログのSDカードバックアップの設定

logging backup sd

ログのバックアップ

save logging

技術サポート情報の保存

copy tech-support sd

ランニングコンフィグの保存

copy running-config startup-config

ランニングコンフィグの保存

write

スタートアップコンフィグのコピー

copy startup-config

スタートアップコンフィグの消去

erase startup-config

スタートアップコンフィグの表示

show startup-config

システム情報のバックアップ

backup system

システム情報のリストア

restore system

5. コマンド実行例

5.1. SDカードのアンマウント

SDカードをアンマウントする。

Yamaha>unmount sd

5.2. SDカードのマウント

SDカードをマウントする。

Yamaha>mount sd

5.3. ログファイルのバックアップ

save logging コマンド実行時にSDカード内にも同時にログファイルをバックアップします。

Yamaha(config)#logging backup sd enable (1)
Yamaha(config)#exit
Yamaha#save logging (2)
1 ログのSDカードバックアップを有効にする
2 ログをバックアップする

5.4. 技術サポート情報の保存

技術サポート情報を保存します。

Yamaha#copy tech-support sd

6. 注意事項

特になし