FutureNet

NXR,WXRシリーズ

REST-API編

11. IPv4/IPv6ネイバー設定

11-1. スタティックARP設定(static-arp)

 処理概要

スタティックARP設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
static-arp v2 /api/v2/static-arp
/api/v2/static-arp/arp
/api/v2/static-arp/arp/{IP-ADDRESS}

凡例:〇対応、-未対応

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

 

実行例

スタティックARP設定の作成

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

POST /api/v2/static-arp/arp
Content-Type: application/json

 

{
"arp": {
"address": "192.0.2.1",
"hw-address": "00:00:5E:00:53:01"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/static-arp/arp
Content-Type: application/xml

 

<static-arp>
<arp>
<address>192.0.2.1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
</arp>
</static-arp>

 

レスポンス

201 Created

 

全スタティックARP設定の取得

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

GET /api/v2/static-arp/arp
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"arp": [
{
"address": "192.0.2.1",
"hw-address": "00:00:5E:00:53:01"
},
{
"address": "192.0.2.2",
"hw-address": "00:00:5E:00:53:02"
}
]
}

 

XML
リクエスト

GET /api/v2/static-arp/arp
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<static-arp>
<arp>
<address>192.0.2.1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
</arp>
<arp>
<address>192.0.2.2</address>
<hw-address>00:00:5E:00:53:02</hw-address>
</arp>
</static-arp>

 

TEXT/PLAIN
リクエスト

GET /api/v2/static-arp/arp
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

arp 192.0.2.1 00:00:5E:00:53:01
arp 192.0.2.2 00:00:5E:00:53:02

 

スタティックARP設定の更新

メソッド URI
PUT /api/v2/static-arp/arp/{IP-ADDRESS}
JSON
リクエスト

PUT /api/v2/static-arp/arp/192.0.2.1
Content-Type: application/json

 

{
"hw-address": "00:00:5E:00:53:10"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/static-arp/arp/192.0.2.1
Content-Type: application/xml

 

<arp>
<hw-address>00:00:5E:00:53:10</hw-address>
</arp>

 

レスポンス

204 No content

 

スタティックARP設定の取得

メソッド URI
GET /api/v2/static-arp/arp/{IP-ADDRESS}
JSON
リクエスト

GET /api/v2/static-arp/arp/192.0.2.1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"address": "192.0.2.1",
"hw-address": "00:00:5E:00:53:01"
}

 

XML
リクエスト

GET /api/v2/static-arp/arp/192.0.2.1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<arp>
<address>192.0.2.1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
</arp>

 

TEXT/PLAIN
リクエスト

GET /api/v2/static-arp/arp/192.0.2.1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

arp 192.0.2.1 00:00:5E:00:53:01

 

スタティックARP設定の削除

メソッド URI
DELETE /api/v2/static-arp/arp/{IP-ADDRESS}
リクエスト

DELETE /api/v2/static-arp/arp/192.0.2.1

 

レスポンス

204 No content

 

パラメータ

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

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

  • パラメータ表の説明文中のデータタイプについて
    A.B.C.D … IPv4アドレス
    XX:XX:XX:XX:XX:XX … MACアドレス

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
static-arp arp address IPアドレス … A.B.C.D
hw-address MACアドレス … XX:XX:XX:XX:XX:XX