FutureNet

NXR,VXRシリーズ

REST-API編

8. 各種サービス設定

8-19. DHCPv6サーバ設定(dhcp6-server)

 処理概要

DHCPv6サーバ設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
DHCPv6
Server
v2 /api/v2/dhcp6-server
/api/v2/dhcp6-server/server
/api/v2/dhcp6-server/server/{NAME}

凡例:〇対応、-未対応

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

 

実行例

DHCPv6サーバ設定の作成

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

POST /api/v2/dhcp6-server/server
Content-Type: application/json

 

{
"server": {
"name": "ipv6dhcps",
"dns-add-dhcp": "ethernet1"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/dhcp6-server/server
Content-Type: application/xml

 

<dhcp6-server>
<server>
<name>ipv6dhcps</name>
<dns-add-dhcp>ethernet1</dns-add-dhcp>
</server>
</dhcp6-server>

 

レスポンス

201 Created

 

全DHCPv6サーバ設定の取得

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

GET /api/v2/dhcp6-server/server
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"server": [
{
"name": "ipv6dhcps",
"dns-add-dhcp": "ethernet1"
},
{
"name": "ipv6dhcps2",
"dns-add-dhcp": "ethernet2"
}
]
}

 

XML
リクエスト

GET /api/v2/dhcp6-server/server
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<dhcp6-server>
<server>
<name>ipv6dhcps</name>
<dns-add-dhcp>ethernet1</dns-add-dhcp>
</server>
<server>
<name>ipv6dhcps2</name>
<dns-add-dhcp>ethernet2</dns-add-dhcp>
</server>
</dhcp6-server>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dhcp6-server/server
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ipv6 dhcp-server ipv6dhcps
option-send dns-server add ipv6 dhcp-client ethernet 1
ipv6 dhcp-server ipv6dhcps2
option-send dns-server add ipv6 dhcp-client ethernet 2

 

DHCPv6サーバ設定の更新

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

PUT /api/v2/dhcp6-server/server/ipv6dhcps
Content-Type: application/json

 

{
"name": "ipv6dhcps",
"dns": {
"address": "2001:db8:1:1::1"
},
"dns-add-dhcp": "ethernet1"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/dhcp6-server/server/ipv6dhcps
Content-Type: application/xml

 

<server>
<name>ipv6dhcps</name>
<dns>
<address>2001:db8:1:1::1</address>
</dns>
<dns-add-dhcp>ethernet1</dns-add-dhcp>
</server>

 

レスポンス

204 No content

 

DHCPv6サーバ設定の取得

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

GET /api/v2/dhcp6-server/server/ipv6dhcps
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "ipv6dhcps",
"dns": {
"address": "2001:db8:1:1::1"
},
"dns-add-dhcp": "ethernet1"
}

 

XML
リクエスト

GET /api/v2/dhcp6-server/server/ipv6dhcps
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<server>
<name>ipv6dhcps</name>
<dns>
<address>2001:db8:1:1::1</address>
</dns>
<dns-add-dhcp>ethernet1</dns-add-dhcp>
</server>

 

TEXT/PLAIN
リクエスト

GET /api/v2/dhcp6-server/server/ipv6dhcps
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ipv6 dhcp-server ipv6dhcps
option-send dns-server address 2001:db8:1:1::1
option-send dns-server add ipv6 dhcp-client ethernet 1

 

DHCPv6サーバ設定の削除

メソッド URI
DELETE /api/v2/dhcp6-server/server/{NAME}
リクエスト

DELETE /api/v2/dhcp6-server/server/ipv6dhcps

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
dhcp6-server server name DHCPv6サーバ設定名
dns address DNSサーバアドレス … 

  • A.B.C.D
  • X:X::X:X
dns-add-dhcp DHCPv6クライアントで取得したDNSサーバアドレス … DHCPv6クライアントのインタフェース名
domain-name domain ドメイン名 … FQDN
domain-add-dhcp DHCPv6クライアントで取得したドメインサーチリスト … DHCPv6クライアントのインタフェース名
rapid-commit Rapid Commit … [enable | disable]