FutureNet

NXR,WXRシリーズ

REST-API編

11. IPv4/IPv6ネイバー設定

11-2. スタティックIPv6ネイバー設定(static-neighbor)

 処理概要

スタティックIPv6ネイバー設定に関する処理を実行します。

 

URIおよびメソッド

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

凡例:〇対応、-未対応

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

 

実行例

スタティックIPv6ネイバー設定の作成

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

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

 

{
"neighbor": {
"address": "2001:db8::1",
"hw-address": "00:00:5E:00:53:01",
"interface": "ethernet0"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<static-neighbor>
<neighbor>
<address>2001:db8::1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
<interface>ethernet0</interface>
</neighbor>
</static-neighbor>

 

レスポンス

201 Created

 

全スタティックIPv6ネイバー設定の取得

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

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"neighbor": [
{
"address": "2001:db8::1",
"hw-address": "00:00:5E:00:53:01",
"interface": "ethernet0"
},
{
"address": "2001:db8::2",
"hw-address": "00:00:5E:00:53:02",
"interface": "ethernet0"
}
]
}

 

XML
リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<static-neighbor>
<neighbor>
<address>2001:db8::1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
<interface>ethernet0</interface>
</neighbor>
<neighbor>
<address>2001:db8::2</address>
<hw-address>00:00:5E:00:53:02</hw-address>
<interface>ethernet0</interface>
</neighbor>
</static-neighbor>

 

TEXT/PLAIN
リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

ipv6 neighbor 2001:db8::1 00:00:5E:00:53:01 ethernet 0
ipv6 neighbor 2001:db8::2 00:00:5E:00:53:02 ethernet 0

 

スタティックIPv6ネイバー設定の更新

メソッド URI
PUT /api/v2/static-neighbor/neighbor/{IPv6-ADDRESS}
  • 更新可能なパラメータはHWアドレスのみとなります。インタフェースの更新はできません。

 

JSON
リクエスト

PUT /api/v2/static-neighbor/neighbor/2001:db8::1
Content-Type: application/json

 

{
"address": "2001:db8::1",
"hw-address": "00:00:5E:00:53:10",
"interface": "ethernet0"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/static-neighbor/neighbor/2001:db8::1
Content-Type: application/xml

 

<neighbor>
<address>2001:db8::1</address>
<hw-address>00:00:5E:00:53:10</hw-address>
<interface>ethernet0</interface>
</neighbor>

 

レスポンス

204 No content

 

スタティックIPv6ネイバー設定の取得

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

GET /api/v2/static-neighbor/neighbor/2001:db8::1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"address": "2001:db8::1",
"hw-address": "00:00:5E:00:53:01",
"interface": "ethernet0"
}

 

XML
リクエスト

GET /api/v2/static-neighbor/neighbor/2001:db8::1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<neighbor>
<address>2001:db8::1</address>
<hw-address>00:00:5E:00:53:01</hw-address>
<interface>ethernet0</interface>
</neighbor>

 

TEXT/PLAIN
リクエスト

GET /api/v2/static-neighbor/neighbor/2001:db8::1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ipv6 neighbor 2001:db8::1 00:00:5E:00:53:01 ethernet 0

 

スタティックIPv6ネイバー設定の削除

メソッド URI
DELETE /api/v2/static-neighbor/neighbor/{IPv6-ADDRESS}
JSON
リクエスト

DELETE /api/v2/static-neighbor/neighbor/2001:db8::1
Content-Type: application/json

 

{
"interface": "ethernet0"
}

 

レスポンス

204 No content

 

XML
リクエスト

DELETE /api/v2/static-neighbor/neighbor/2001:db8::1
Content-Type: application/xml

 

<neighbor>
<interface>ethernet0</interface>
</neighbor>

 

レスポンス

204 No content

 

パラメータ

指定可能なパラメータは下記の通りです。
なお、パラメータの詳細については、各製品のユーザーズガイド(CLI版)も合わせてご参照ください。

  • パラメータ表の説明文中のデータタイプについて
    X:X::X:X … IPv6アドレス
    XX:XX:XX:XX:XX:XX … MACアドレス

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
static-neighbor neighbor address IPv6アドレス … X:X::X:X
hw-address MACアドレス … XX:XX:XX:XX:XX:XX
interface インタフェース名