FutureNet

NXR,WXRシリーズ

REST-API編

12. システム設定

12-2. システム設定(system)

 処理概要

省電力などシステム設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
System v2 /api/v2/system
/api/v2/system/boot
/api/v2/system/netevent
/api/v2/system/clock
/api/v2/system/power-management
/api/v2/system/configuration-id
/api/v2/system/event-notify

凡例:〇対応、-未対応

  • api/v1は対応していません。

 

実行例

system boot設定の更新

メソッド URI
PUT /api/v2/system/boot
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/boot
Content-Type: application/json

 

{
"boot": {
"config": {
"type": "startup-config",
"url": "https://www.example.jp/config.xml"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/boot
Content-Type: application/xml

 

<system>
<boot>
<config>
<type>startup-config</type>
<url>https://www.example.jp/config.xml</url>
</config>
</boot>
</system>

 

レスポンス

204 No content

 

system boot設定の取得

メソッド URI
GET /api/v2/system/boot
JSON
リクエスト

GET /api/v2/system/boot
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"boot": {
"config": {
"type": "startup-config",
"url": "https://www.example.jp/config.xml"
}
}
}

 

XML
リクエスト

GET /api/v2/system/boot
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<boot>
<config>
<type>startup-config</type>
<url>https://www.example.jp/config.xml</url>
</config>
</boot>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/boot
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system boot config copy https://www.example.jp/config.xml startup-config

 

system netevent設定の更新

メソッド URI
PUT /api/v2/system/netevent
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/netevent
Content-Type: application/json

 

{
"netevent": {
"track-id": 1,
"action": "restart"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/netevent
Content-Type: application/xml

 

<system>
<netevent>
<track-id>1</track-id>
<action>restart</action>
</netevent>
</system>

 

レスポンス

204 No content

 

system netevent設定の取得

メソッド URI
GET /api/v2/system/netevent
JSON
リクエスト

GET /api/v2/system/netevent
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"netevent": {
"track-id": 1,
"action": "restart"
}
}

 

XML
リクエスト

GET /api/v2/system/netevent
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<netevent>
<track-id>1</track-id>
<action>restart</action>
</netevent>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/netevent
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system netevent 1 restart

 

system netevent設定の削除

メソッド URI
DELETE /api/v2/system/netevent

 

リクエスト

DELETE /api/v2/system/netevent

 

レスポンス

204 No content

 

system clock設定の更新

メソッド URI
PUT /api/v2/system/clock
JSON
リクエスト

PUT /api/v2/system/clock
Content-Type: application/json

 

{
"clock": "mobile1"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/clock
Content-Type: application/xml

 

<system>
<clock>mobile1</clock>
</system>

 

レスポンス

204 No content

 

system clock設定の取得

メソッド URI
GET /api/v2/system/clock
JSON
リクエスト

GET /api/v2/system/clock
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"clock": "mobile1"
}

 

XML
リクエスト

GET /api/v2/system/clock
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<clock>mobile1</clock>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/clock
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system clock mobile 1

 

system clock設定の削除

メソッド URI
DELETE /api/v2/system/clock

 

リクエスト

DELETE /api/v2/system/clock

 

レスポンス

204 No content

 

system power-management設定の更新

メソッド URI
PUT /api/v2/system/power-management
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/power-management
Content-Type: application/json

 

{
"power-management": {
"mode": "m2m",
"sleep": {
"init": {
"resume-method": "timer",
"resume-option": 3600
}
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/power-management
Content-Type: application/xml

 

<system>
<power-management>
<mode>m2m</mode>
<sleep>
<init>
<resume-method>timer</resume-method>
<resume-option>3600</resume-option>
</init>
</sleep>
</power-management>
</system>

 

レスポンス

204 No content

 

system power-management設定の取得

メソッド URI
GET /api/v2/system/power-management
JSON
リクエスト

GET /api/v2/system/power-management
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"power-management": {
"mode": "m2m",
"sleep": {
"init": {
"resume-method": "timer",
"resume-option": 3600
}
}
}
}

 

XML
リクエスト

GET /api/v2/system/power-management
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<power-management>
<mode>m2m</mode>
<sleep>
<init>
<resume-method>timer</resume-method>
<resume-option>3600</resume-option>
</init>
</sleep>
</power-management>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/power-management
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system power-management mode m2m
system power-management sleep init-button timer 3600

 

system configuration-id設定の更新

メソッド URI
PUT /api/v2/system/configuration-id
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/configuration-id
Content-Type: application/json

 

{
"configuration-id": "1234567890abc"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/configuration-id
Content-Type: application/xml

 

<system>
<configuration-id>1234567890abc</configuration-id>
</system>

 

レスポンス

204 No content

 

system configuration-id設定の取得

メソッド URI
GET /api/v2/system/configuration-id
JSON
リクエスト

GET /api/v2/system/configuration-id
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"configuration-id": "1234567890abc"
}

 

XML
リクエスト

GET /api/v2/system/configuration-id
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<configuration-id>1234567890abc</configuration-id>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/configuration-id
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system configuration-id 1234567890abc

 

system configuration-id設定の削除

メソッド URI
DELETE /api/v2/system/configuration-id

 

リクエスト

DELETE /api/v2/system/configuration-id

 

レスポンス

204 No content

 

system event-notify設定の更新

メソッド URI
PUT /api/v2/system/event-notify
  • Bodyを指定しなかった場合、設定を削除します。

 

JSON
リクエスト

PUT /api/v2/system/event-notify
Content-Type: application/json

 

{
"event-notify": {
"number": 1,
"priority": "info"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/system/event-notify
Content-Type: application/xml

 

<system>
<event-notify>
<number>1</number>
<priority>info</priority>
</event-notify>
</system>

 

レスポンス

204 No content

 

system event-notify設定の取得

メソッド URI
GET /api/v2/system/event-notify
JSON
リクエスト

GET /api/v2/system/event-notify
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"event-notify": {
"number": 1,
"priority": "info"
}
}

 

XML
リクエスト

GET /api/v2/system/event-notify
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<system>
<event-notify>
<number>1</number>
<priority>info</priority>
</event-notify>
</system>

 

TEXT/PLAIN
リクエスト

GET /api/v2/system/event-notify
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

system event-notify 1 info

 

system event-notify設定の削除

メソッド URI
DELETE /api/v2/system/event-notify

 

リクエスト

DELETE /api/v2/system/event-notify

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

system

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
global system boot system boot設定
netevent system netevent設定
clock system clock … mobileX
※Xはモバイル番号 (ex. mobile1)
power-management system power-management設定
configuration-id system configuration-id
event-notify system event-notify設定

 

boot

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6
boot clear-ppp-data-usage clear-ppp-data-usage … [enable | disable]
firmware type タイプ … [update | list-update]
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
source 送信元アドレス …

  • A.B.C.D
  • X:X::X:X
password hidden 暗号化 … [enable | disable]
※SSHでのみ指定
passphrase パスワード
※SSHでのみ指定
apply 暗号化適用 … [enable | disable]
※SSHでのみ指定。hidden化する場合は必要
hold hold … [enable | disable]
config type タイプ … [config | startup-config | config-and-save]
url 設定ファイルダウンロード先 …

  • 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
source 送信元アドレス …

  • A.B.C.D
  • X:X::X:X
password hidden 暗号化 … [enable | disable]
※SSHでのみ指定
passphrase パスワード
※SSHでのみ指定
apply 暗号化適用 … [enable | disable]
※SSHでのみ指定。hidden化する場合は必要

 

netevent

パラメータおよびレベル 説明
Lv.3 Lv.4
netevent track-id トラックID
action ネットイベントアクション … restart

 

power-management

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6
power-management mode モード … [m2m | balance]
sleep init sleep スリープ … [enable | disable]
resume-method レジューム方法 … [timer | schedule]
resume-option レジュームオプション …

  • timer … <60-31536000>(sec)
  • schedule … <1-255>
resume method-list resume-method レジューム方法 … [serialX | mobileY]
※Xはシリアル番号 (ex. serial1)
※Yはモバイル番号 (ex. mobile1)
resume-option レジュームオプション … [enable | disable]

 

event-notify

パラメータおよびレベル 説明
Lv.3 Lv.4
event-notify number event notify番号
priority プライオリティ … [info | warn | crit | err]