1. FutureNet製品活用ガイド
  2. FutureNet NXR,VXRシリーズ
  3. REST-API編

FutureNet

NXR,VXRシリーズ

REST-API編

2. メンテナンス

2-5. ファームウェアの更新（maint/firmware/update）

 処理概要

ファームウェアアップデートに関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
firmware update v1 /api/v1/maint/firmware/update 〇 － ● －
v2 /api/v2/maint/firmware/update 〇 － ● －

凡例：

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

－ : 未対応

※ NXR-G100シリーズ以外の機種ではREST-APIv2の利用を推奨します。

 

実行例

ファームウェアアップデート

メソッド URI
POST /api/{VERSION}/maint/firmware/update
JSON
リクエスト

POST /api/v2/maint/firmware/update
Content-Type: application/json

 

{
"url": "ssh://test@192.168.10.100/nxr530-v211113.bin",
"target": "system",
"password": "testpass"
}

 

レスポンス

202 Accepted

 

XML
リクエスト

POST /api/v2/maint/firmware/update
Content-Type: application/xml

 

<config>
<url>ssh://test@192.168.10.100/nxr530-v211113.bin</url>
<target>system</target>
<password>testpass</password>
</config>

 

レスポンス

202 Accepted

 

ファームウェアアップデートの状況取得

メソッド URI
GET /api/{VERSION}/maint/firmware/update
JSON
リクエスト

GET /api/v2/maint/firmware/update
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json


{
"state": "downloading",
"download": 1,
"version": "21.11.13",
"build": 1
}

 

XML
リクエスト

GET /api/v2/maint/firmware/update
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<firmware>
<state>updating</state>
<version>21.11.13</version>
<build>1</build>
</firmware>

 

TEXT/PLAIN
リクエスト

GET /api/v2/maint/firmware/update
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

state : restarting

 

パラメータ

指定可能なパラメータは下記の通りです。

なお、指定可能なパラメータは製品およびファームウェアのバージョンにより異なりますので、各パラメータの詳細については各製品のユーザーズガイド（CLI版）も合わせてご参照ください。

  • パラメータ表の説明文中の表記について
    [ ] … 括弧内の値のどれかを選択することを示しています。
    数字,文字列 … 初期値
  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス
    X:X::X:X … IPv6アドレス
    FILENAME … ファイル名
    USER … ユーザ名

 

パラメータおよびレベル 説明
Lv.1 Lv.2
config url ファームウェアダウンロード先 …

  • official
  • ssh://USER@[ A.B.C.D | X:X::X:X ]/FILENAME
  • ftp://[ A.B.C.D | X:X::X:X ]/FILENAME
  • diskX:FILENAME
    ※Xはディスク番号 (ex. disk0)
  • http://[ A.B.C.D | X:X::X:X ]/FILENAME
  • https://[ A.B.C.D | X:X::X:X ]/FILENAME
  • https-://[ A.B.C.D | X:X::X:X ]/FILENAME
  • http://USER@[ A.B.C.D | X:X::X:X ]/FILENAME
  • https://USER@[ A.B.C.D | X:X::X:X ]/FILENAME
  • https-://USER@[ A.B.C.D | X:X::X:X ]/FILENAME
target 更新対象 …

  • system
  • mobile1
password パスワード
※SSH,HTTP(S)のベーシック認証でのみ指定
source 送信元アドレス … [ A.B.C.D | X:X::X:X ]
restart アップデート後の再起動 … [ enable | disable ]