FutureNet

NXR,WXRシリーズ

REST-API編

8. 各種サービス設定

8-25. Wake ON LAN設定(wol)

 処理概要

Wake ON LAN設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
Wake ON LAN v2 /api/v2/wol
/api/v2/wol/wol-list
/api/v2/wol/wol-list/{NAME}

凡例:〇対応、-未対応

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

 

実行例

Wake ON LAN設定の作成

メソッド URI
POST /api/v2/wol/wol-list
JSON
リクエスト

POST /api/v2/wol/wol-list
Content-Type: application/json

 

{
"wol-list": {
"name": "PC",
"type": "ether",
"interface": "ethernet0",
"hw-address": "00:00:5E:00:53:01",
"broadcast": "enable"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/wol/wol-list
Content-Type: application/xml

 

<wol>
<wol-list>
<name>PC</name>
<type>ether</type>
<interface>ethernet0</interface>
<hw-address>00:00:5E:00:53:01</hw-address>
<broadcast>enable</broadcast>
</wol-list>
</wol>

 

レスポンス

201 Created

 

全Wake ON LAN設定の取得

メソッド URI
GET /api/v2/wol/wol-list
JSON
リクエスト

GET /api/v2/wol/wol-list
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"wol-list": [
{
"name": "PC",
"type": "ether",
"interface": "ethernet0",
"hw-address": "00:00:5E:00:53:01",
"broadcast": "enable"
},
{
"name": "PC2",
"type": "udp4",
"address": "192.168.10.255",
"hw-address": "00:00:5E:00:53:02"
}
]
}

 

XML
リクエスト

GET /api/v2/wol/wol-list
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<wol>
<wol-list>
<name>PC</name>
<type>ether</type>
<interface>ethernet0</interface>
<hw-address>00:00:5E:00:53:01</hw-address>
<broadcast>enable</broadcast>
</wol-list>
<wol-list>
<name>PC2</name>
<type>udp4</type>
<address>192.168.10.255</address>
<hw-address>00:00:5E:00:53:02</hw-address>
</wol-list>
</wol>

 

TEXT/PLAIN
リクエスト

GET /api/v2/wol/wol-list
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

wol name PC interface ethernet 0 00:00:5E:00:53:01 ethernet broadcast
wol name PC2 ip 192.168.10.255 00:00:5E:00:53:02

 

Wake ON LAN設定の更新

メソッド URI
PUT /api/v2/wol/wol-list/{NAME}
JSON
リクエスト

PUT /api/v2/wol/wol-list/PC
Content-Type: application/json

 

{
"name": "PC",
"type": "ether",
"interface": "ethernet0",
"hw-address": "00:00:5E:00:53:11",
"broadcast": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/wol/wol-list/PC
Content-Type: application/xml

 

<wol-list>
<name>PC</name>
<type>ether</type>
<interface>ethernet0</interface>
<hw-address>00:00:5E:00:53:11</hw-address>
<broadcast>enable</broadcast>
</wol-list>

 

レスポンス

204 No content

 

Wake ON LAN設定の取得

メソッド URI
GET /api/v2/wol/wol-list/{NAME}
JSON
リクエスト

GET /api/v2/wol/wol-list/PC
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "PC",
"type": "ether",
"interface": "ethernet0",
"hw-address": "00:00:5E:00:53:11",
"broadcast": "enable"
}

 

XML
リクエスト

GET /api/v2/wol/wol-list/PC
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<wol-list>
<name>PC</name>
<type>ether</type>
<interface>ethernet0</interface>
<hw-address>00:00:5E:00:53:11</hw-address>
<broadcast>enable</broadcast>
</wol-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/wol/wol-list/PC
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

wol name PC interface ethernet 0 00:00:5E:00:53:11 ethernet broadcast

 

Wake ON LAN設定の削除

メソッド URI
DELETE /api/v2/wol/wol-list/{NAME}

 

リクエスト

DELETE /api/v2/wol/wol-list/PC

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
wol wol-list name WOL名
type タイプ … [ether | udp4]
address アドレス … 

  • A.B.C.D
  • FQDN
interface インタフェース名
hw-address MACアドレス … XX:XX:XX:XX:XX:XX
port UDPポート番号 … <1-65535>
ethernet-type Ethernetタイプ … <1501-65535>
interval 送信間隔 … <1-65535>(sec)
count 送信回数 … <1-65535>
broadcast broadcastアドレスへの送信 … [enable | disable]