概要

弊社エッジゲートウェイ（AGシリーズ）に接続されたSSDのファームウェア更新手段の一つとして提供するツールの利用方法について説明するものです。

本ツールは、現地機器を取り外すことが困難な場合など、限定的な条件下での対応手段として提供しています。通常、SSDのファームウェア更新が必要と判断された場合は、弊社への機器送付による対応を基本としています。詳細はQ&Aをご確認ください。
SSDのファームウェア更新は、すべての機器で必須となる作業ではなく、個体ごとの障害解析の結果に基づき、必要性が確認された場合にのみ実施されるものです。お客様からのご依頼および解析結果により実施有無が決定されます。
本手順は、Linux（bash）操作に習熟した技術者による実施を前提としています。

対象製品

バージョン1.6.1以降の屋内タイプ/屋外タイプエッジゲートウェイ(AG10 / AG20)

対象となる搭載SSDデバイス

AG10/AG20 を前提とします。
AG10/AG20 に接続された Innodisk SATA SSD のファームウェア・バージョンを S24306 に更新する機能を提供します。
SATA SSD のみ対応とし、amnimo X シリーズに搭載のNVMe/USB-SATA は非対応です。
BiCS 3/4/5 世代の SSD のみ対応とし、それ以外の世代は非対応とします。
次の表のBiCS世代、更新可能なファームウェアバージョンおよびSSD容量の組み合わせに該当しない場合は更新対象外です。

BiCS世代対象サイズ元FW Ver 更新FW Ver

BiCS3 64GB / 512GB S19C04B / S20615 S24306

BiCS4 64GB / 512GB S20615 / S22801

BiCS5 128GB / 512GB / 1TB / 2TB S22831 / S23505
容量クラスは SMART 情報 ( smartctl -a -j <dev> ) で取得できる User Capacity から 64GB / 128GB / 512GB / 1TB / 2TB のいずれかに推定できる場合のみ更新可能です。

注意事項

本ツールの実行中に SSD へのアクセスおよび電源操作が行われるとデバイスがブリック化する(使用不可能になる)可能性があります。
実行前に次の点を確認してください。

データのバックアップを事前に行う。
機器に接続された SSD は必ずアンマウントし、SSD へのアクセスおよび電源操作が行われないようにする。
Nx Witness のサービスを実行中の場合は停止する。( 停止するには amsh の管理者モードで 'service nxwitness stop' を実行してください )

本ツールはアンマウントを促すプロンプトを表示し、許可があれば umount を実行しますが、事前に手動でアンマウントしておくことを推奨します。

更新完了後は表示に従ってシステムをハードリブートしてください。 bash で sudo amctrl reboot -t hard を実行することでハードリブートされます。

本ツールは内部で hdparm コマンドによる更新を行います。ファームウェアを更新した直後は smartctl を実行できないため、本ツールは更新後の SMART 情報取得や更新結果の再確認をその場では行いません。smartctl の実行もしないでください。

更新前に保存する SMART JSON には、更新対象 SSD の特定と保守解析のため serial number が含まれます。
このログの保存先は保守用途を前提としており、一般ユーザー公開は想定していません。
( ログの保存先ディレクトリは /var/log/amssdfwup です )

本ツールは smartctl コマンドを使って SSD の情報を確認して実行します。 smartctl が正常に終了できない ( 終了コードが 0 以外 ) 場合は本ツールを実行できません。

パッケージのダウンロード先

https://package.amnimo.com/tools/amnimo-ssdfwup_1.0.0_arm64.deb

各ファームウェアにアクセスする場合は、アカウントとパスワードが必要になります。弊社サポートに別途ご連絡ください。

パッケージの導入

インストール

次のコマンドを実行します。

admin@amnimo:~$ sudo apt install ./amnimo-ssdfwup_1.0.0_arm64.deb

アンインストール

次のコマンドを実行します。

admin@amnimo:~$ sudo apt remove amnimo-ssdfwup

アンインストールを実行しても更新時に保存された SMART JSON (smartctl -a -j) のログは削除されません。
必要に応じて削除してください。

コマンドオプション

admin@amnimo:~$ sudo amssdfwup -h
Usage: amssdfwup [OPTIONS]

Options:
  --check        Check connected SATA SSDs and print information (no update)
  -h, --help     Show this help message and exit

Without options the tool runs interactive update flow.

--check 後ほど説明するチェックモードで実行します。
-h or --help 上記の Usage を表示します。
オプションを指定しない場合、ツールは [Y/N] の対話型更新フローを実行します。

チェックモード

本ツールではチェックモード --check を提供しており、実際の更新処理を行わずに更新対象の SSD の識別情報と適用予定のファームウェアファイル名を表示します。これにより更新対象の SSD を確認できます。
チェックモードはコマンド sudo amssdfwup --check で実行できます。以下は実行例です。

admin@amnimo:~$ sudo amssdfwup --check
INFO: device_list:
/dev/sda
Device: /dev/sda - Model: M.2 (S80) 3TE7 | BiCS: 4 | Capacity: 60,022,480,896 bytes | Current FW: S22801 | Updatable: Yes -> S24306

Updatable: ... は更新の可否を表示しています。

Updatable: Yes -> S24306 更新可能
Updatable: No (no firmware mapping) 更新不可：更新元のSSDファームウェアバージョンが更新の対象外です
Updatable: No (unsupported BiCS) 更新不可：SSDのBiCS世代が更新の対象外
Updatable: No (capacity unknown) 更新不可：SSDの容量が更新の対象外
Updatable: No (not target/current) 更新不可：更新済み、または更新元のファームウェアバージョンが更新の対象外

SSD ファームウェアの更新手順

コマンド実行後は表示されるプロンプトに従って操作してください。

以下はコマンドの実行例です。

admin@amnimo:~$ sudo amssdfwup
[sudo] password for admin:
INFO: device_list:
/dev/sda
INFO: If the Nx Witness service is running, please stop it. In amsh administrator mode, type 'service nxwitness stop'.
Do you want to unmount </dev/sda>? [y/n] y
unmounting: /media/ssd
INFO: target info. : Device: /dev/sda, BiCS3, capacity: 512GB, current: S19C04B, new: S24306, file: QEIJCHHC.bin, model:M.2 (S80) 3TE7
Do you want to start the update? [y/n]
 
Please input y or n.
Do you want to start the update? [y/n] y
INFO: Updating firmware, please wait about 1 minute...
INFO: Please hard-reboot the system. Type 'sudo amctrl reboot -t hard'.
admin@amnimo:~$ sudo amctrl reboot -t hard

次のコマンドを実行して本ツールを起動します。
```
sudo amssdfwup
```
SATA SSD が接続されていない場合、本ツールは次のようなメッセージを表示して実行を終了します。
```
INFO: No target devices found.
```
複数の SSD が接続されている場合、更新対象の SSD を選択するプロンプトが表示されます。更新対象とするデバイス名を Y で選択してください。
接続された SATA SSD が1台の場合は選択するプロンプトは表示されません。
以下は /dev/sda および /dev/sdb に SATA SSD が接続されている場合の例です。
```
INFO: device_list:
/dev/sda
/dev/sdb
Do you want to update this device? </dev/sda> [y/n] y
```
すべて N を選択した場合、本ツールは次のようなメッセージを表示して実行を終了します。
```
INFO: No target devices found.
```
選択した SSD が更新対象の BiCS 世代ではない場合、本ツールは次のようなメッセージを表示して実行を終了します。
```
ERROR: unknown BiCS generation for ID 'XX'
```
選択した SSD の現在のファームウェアバージョンが更新対象外の場合、本ツールは次のようなメッセージを表示して実行を終了します。
```
INFO: The current firmware version is not supported for update. BiCS4, S11111
```
選択した SSD の容量クラスを User Capacity から推定できない場合、または対応する容量クラスのファームウェアが定義されていない場合、本ツールは次のようなメッセージを表示して実行を終了します。
```
ERROR: failed to determine capacity class from SMART information.
```
```
ERROR: no firmware mapping for BiCS4 and capacity '256GB'
```
選択した SSD がマウントされている場合、アンマウントするかどうかのプロンプトが表示されます。アンマウントしても問題ない場合は Y を選択してください。N を選択した場合、本ツールは実行を終了します。
```
Do you want to unmount </dev/sda>? [y/n] y
```
選択した SSD がマウントされていない場合、またはアンマウントすることを選択した場合、SSD を更新するかどうかのプロンプトが表示されます。更新しても問題ない場合は Y を選択してください。N を選択した場合、本ツールは実行を終了します。

以下の例は BiCS4 世代、容量クラス 64GB、現ファームウェアバージョン S22801, モデル:M.2 (S80) 3TE7, シリアルナンバー ABC1234567890DEFG に Q2TNCGAC.bin を適用する場合の表示例です。
```
INFO: target info. : Device: /dev/sda, BiCS4, capacity: 64GB, current: S22801, new: S24306, file: Q2TNCGAC.bin, model:M.2 (S80) 3TE7, S/N:ABC1234567890DEFG
Do you want to start the update? [y/n]
```
本ツールは更新を開始すると完了するまで1分程度待ちます。
```
INFO: Updating firmware, please wait about 1 minute...
```
コマンドが完了したらシステムをハードリブートしてください※。 bash で sudo amctrl reboot -t hard を実行することでハードリブートされます。
```
INFO: Please hard-reboot the system. Type 'sudo amctrl reboot -t hard'.
```
更新後の確認が必要な場合は、再起動後に smartctl などでファームウェアバージョンを確認してください。
システムに smartctl がインストールされていない場合は本パッケージに同梱されている smartctl が使用できます。
以下は実行例です。
```
sudo /usr/share/amssdfwup/smartctl -a /dev/sda
```

ハードウェアリブートではなく、ソフトウェアリブートを実施した場合はSSDの電源リセットが行われず、ファームアップが完了しません。ご注意ください。

Q＆A

Q1. SSDのファームウェア更新とは何ですか？

A.
SSDのファームウェアは、SSD内部の制御処理を管理するソフトウェアです。
本FAQで説明する更新は、SSDメーカーが提供するファームウェアを適用し、内部処理の最適化などを行うものです。

Q2. なぜSSDのファームウェア更新が必要になるのですか？

A.
SSDのファームウェア更新は、すべての機器で必須となるものではありません。
個別の障害や挙動の解析結果に基づき、必要性が確認された場合にのみ実施されます。

SSDメーカーからは、ファームウェア更新により

内部処理の最適化
性能改善（例：メンテナンス処理時間の短縮、Read性能の改善など）

が期待される場合があるとの見解が示されています。

このため、特定の事象に対して当該改善内容が有効と考えられる場合に、お客様のご要望に応じて更新をご提案することがあります。

なお、これらの改善はメーカーの技術的見解に基づくものであり、すべての環境・個体において同様の効果を保証するものではありません。

以下の記事をご確認いただき、SSDの利用方法についてもご注意ください。

独自アプリケーション利用時の SSD 過剰書き込みに関する注意事項

Q3. 今回リリースするS24306ではどのような更新が含まれていますか？

A.
SSDメーカーから提供されている情報によると、新しいファームウェアでは以下のような改善が含まれているとされています。

SSD内部のメンテナンス処理の最適化
Read性能の改善
内部処理に起因する動作時間の短縮

これらは、実際の事象において確認されている挙動（起動時の認識遅延など）の要因の一つと考えられる内部処理に関連する改善として説明されています。

また、メーカーの提供資料においても、各バージョンアップ内容については「改善の可能性がある」と位置付けられています。

そのため、本ファームウェアの適用により同様の事象に対して改善が見込まれる場合がありますが、効果は利用環境や個体差により異なるため、すべてのケースで改善が保証されるものではありません。

以下の記事をご確認いただき、SSDの利用方法についてもご注意ください。

独自アプリケーション利用時の SSD 過剰書き込みに関する注意事項

Q4. すべての装置でSSDファームウェア更新が必要ですか？

A.
いいえ、必要ありません。

SSDファームウェア更新は、すべての装置に対して一律に実施するものではなく、以下のような条件を満たす場合にのみ検討されます。

個別に障害や異常な挙動が確認されている
解析の結果、SSDに起因する可能性がある
SSDメーカーの提供する改善内容が関連し得ると判断された

Q5. SSDファームウェア更新はアムニモ社から指示されるものですか？

A.
SSDファームウェア更新の実施は、弊社側の都合で一律に行うものではありません。

お客様からのご相談および障害解析の結果に基づき、必要性が確認された場合に、お客様と協議のうえ実施可否を決定します。

Q6. SSDファームウェア更新はどのように実施しますか？

A.
SSDファームウェア更新の方法には、主に以下の2つがあります。

弊社での対応（基本）：機器（またはSSD）を弊社へ送付いただき、社内で更新を実施

現地での実施（本ツール）：機器の取り外しが困難な場合などに限り、専用ツールを用いて現地で更新

本FAQで説明する手順は、②の現地実施手段に該当します。

Q7. なぜ現地での更新ではなく、送付対応が推奨されるのですか？

A.
SSDファームウェア更新は、誤った操作を行った場合、SSDが使用不能（復旧不可）となるリスクがあります。

そのため、通常はamnimoにて適切な環境で更新を実施することを推奨しています。
現地での更新は、機器を停止・回収できない場合などに限定した代替手段となります。

Q8. このツールはどのような場合に使用するものですか？

A.
本ツールは、以下の条件を満たす場合に使用することを想定しています。

SSDファームウェア更新の必要性が確認されている
機器の取り外しや送付が困難である
Linux（bash）操作に習熟した技術者が作業できる

Q9. 誰でもこのツールを使用できますか？

A.
本ツールは、Linuxコマンド（bash）の操作に習熟した技術者による実施を前提としています。

安全に実施するため、以下の理解が必要です。

ストレージデバイス操作（/dev/sdX）の理解
マウント／アンマウントの理解
サービス停止（例：Nx Witness）の実施

Q10. 更新を行うと必ず改善しますか？

A.
いいえ、改善を保証するものではありません。

SSDメーカーの提供する更新内容には、内部処理の最適化等が含まれており、
症状の改善につながる可能性はありますが、

利用環境
SSDの個体差
発生している事象の内容

によって効果は異なります。

Q11. 更新に失敗した場合はどうなりますか？

A.
SSDが使用不能（ブリック）になる可能性があります。

特に以下の操作は重大なリスクとなります。

更新中の電源断
SSDへのアクセス継続
誤ったデバイス選択

そのため、十分に理解したうえで実施いただく必要があります。なお、弊社で数百台の更新試験を実施しておりますが、失敗したケースはございません。

Q12. 更新対象かどうかはどのように確認できますか？

A.
本ツールのチェックモードを使用することで確認できます。

sudo amssdfwup --check

出力にて以下が表示されます：

SSDの情報（型番・容量・FW）
更新可否（Updatable: Yes / No）

Q13. 本対応は全機器に適用されるものですか？

A.
いいえ、適用されません。

本対応は、SSDメーカーの提供する技術情報および個別の障害解析結果に基づき判断されるものであり、
すべての機器に一律適用されるものではありません。

アムニモデバイス搭載のSSDのファームアップの方法（バージョンS24306）

概要