FutureNet

NXR,WXRシリーズ

REST-API編

7. VPN設定

7-2. L2TPv3設定(l2tpv3)

 処理概要

L2TPv3設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
L2TPv3 v2 /api/v2/l2tpv3
/api/v2/l2tpv3/global
/api/v2/l2tpv3/l2tpv3-tunnel
/api/v2/l2tpv3/l2tpv3-tunnel/tunnel
/api/v2/l2tpv3/l2tpv3-tunnel/tunnel/{NUM}
/api/v2/l2tpv3/l2tpv3-xconnect
/api/v2/l2tpv3/l2tpv3-xconnect/xconnect
/api/v2/l2tpv3/l2tpv3-xconnect/xconnect/{NUM}
/api/v2/l2tpv3/l2tpv3-group
/api/v2/l2tpv3/l2tpv3-group/group
/api/v2/l2tpv3/l2tpv3-group/group/{NUM}

凡例:〇対応、-未対応

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

 

実行例

L2TPv3グローバル設定の更新

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

 

JSON
リクエスト

PUT /api/v2/l2tpv3/global
Content-Type: application/json

 

{
"global": {
"hostname": "nxra",
"router-id": "192.168.10.1",
"pmtu": "enable"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/l2tpv3/global
Content-Type: application/xml

 

<l2tpv3>
<global>
<hostname>nxra</hostname>
<router-id>192.168.10.1</router-id>
<pmtu>enable</pmtu>
</global>
</l2tpv3>

 

レスポンス

204 No content

 

L2TPv3グローバル設定の取得

メソッド URI
GET /api/v2/l2tpv3/global
JSON
リクエスト

GET /api/v2/l2tpv3/global
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"global": {
"hostname": "nxra",
"router-id": "192.168.10.1",
"pmtu": "enable"
}
}

 

XML
リクエスト

GET /api/v2/l2tpv3/global
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<l2tpv3>
<global>
<hostname>nxra</hostname>
<router-id>192.168.10.1</router-id>
<pmtu>enable</pmtu>
</global>
</l2tpv3>

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/global
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 hostname nxra
l2tpv3 router-id 192.168.10.1
l2tpv3 mac-learning enable
l2tpv3 path-mtu-discovery enable

 

L2TPv3トンネル設定の作成

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

POST /api/v2/l2tpv3/l2tpv3-tunnel/tunnel
Content-Type: application/json

 

{
"tunnel": {
"tid": 1,
"description": "NXR_B",
"remote": {
"address": "192.0.2.2",
"hostname": "nxrb",
"router-id": "192.168.10.2"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/l2tpv3/l2tpv3-tunnel/tunnel
Content-Type: application/xml

 

<l2tpv3-tunnel>
<tunnel>
<tid>1</tid>
<description>NXR_B</description>
<remote>
<address>192.0.2.2</address>
<hostname>nxrb</hostname>
<router-id>192.168.10.2</router-id>
</remote>
</tunnel>
</l2tpv3-tunnel>

 

レスポンス

201 Created

 

全L2TPv3トンネル設定の取得

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

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"tunnel": [
{
"tid": 1,
"description": "NXR_B",
"remote": {
"address": "192.0.2.2",
"hostname": "nxrb",
"router-id": "192.168.10.2"
}
},
{
"tid": 2,
・・・・・

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<l2tpv3-tunnel>
<tunnel>
<tid>1</tid>
<description>NXR_B</description>
<remote>
<address>192.0.2.2</address>
<hostname>nxrb</hostname>
<router-id>192.168.10.2</router-id>
</remote>
</tunnel>
<tunnel>
<tid>2</tid>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 tunnel 1
description NXR_B
tunnel address 192.0.2.2
tunnel hostname nxrb
tunnel router-id 192.168.10.2
l2tpv3 tunnel 2
・・・・・

 

L2TPv3トンネル設定の更新

メソッド URI
PUT /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/{NUM}
JSON
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1
Content-Type: application/json

 

{
"tid": 1,
"description": "NXR_B",
"remote": {
"address": "192.0.2.2",
"hostname": "nxrb",
"router-id": "192.168.10.2"
},
"protocol": "udp"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1
Content-Type: application/xml

 

<tunnel>
<tid>1</tid>
<description>NXR_B</description>
<remote>
<address>192.0.2.2</address>
<hostname>nxrb</hostname>
<router-id>192.168.10.2</router-id>
</remote>
<protocol>udp</protocol>
</tunnel>

 

レスポンス

204 No content

 

L2TPv3トンネル設定の取得

メソッド URI
GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/{NUM}
JSON
リクエスト

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"tid": 1,
"description": "NXR_B",
"remote": {
"address": "192.0.2.2",
"hostname": "nxrb",
"router-id": "192.168.10.2"
},
"protocol": "udp"
}

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<tunnel>
<tid>1</tid>
<description>NXR_B</description>
<remote>
<address>192.0.2.2</address>
<hostname>nxrb</hostname>
<router-id>192.168.10.2</router-id>
</remote>
<protocol>udp</protocol>
</tunnel>

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 tunnel 1
description NXR_B
tunnel address 192.0.2.2
tunnel hostname nxrb
tunnel router-id 192.168.10.2
tunnel protocol udp

 

L2TPv3トンネル設定の削除

メソッド URI
DELETE /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/{NUM}
リクエスト

DELETE /api/v2/l2tpv3/l2tpv3-tunnel/tunnel/1

 

レスポンス

204 No content

 

L2TPv3 Xconnect設定の作成

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

POST /api/v2/l2tpv3/l2tpv3-xconnect/xconnect
Content-Type: application/json

 

{
"xconnect": {
"xid": 1,
"description": "NXR_B",
"tid": 1,
"interface": "ethernet0",
"end-id": 1,
"interval": 30,
"adjust-tcp-mss": "enable",
"mss": "auto"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/l2tpv3/l2tpv3-xconnect/xconnect
Content-Type: application/xml

 

<l2tpv3-xconnect>
<xconnect>
<xid>1</xid>
<description>NXR_B</description>
<tid>1</tid>
<interface>ethernet0</interface>
<end-id>1</end-id>
<interval>30</interval>
<adjust-tcp-mss>enable</adjust-tcp-mss>
<mss>auto</mss>
</xconnect>
</l2tpv3-xconnect>

 

レスポンス

201 Created

 

全L2TPv3 Xconnect設定の取得

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

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"xconnect": [
{
"xid": 1,
"description": "NXR_B",
"tid": 1,
"interface": "ethernet0",
"end-id": 1,
"interval": 30,
"adjust-tcp-mss": "enable",
"mss": "auto"
},
{
"xid": 2,
・・・・・

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<l2tpv3-xconnect>
<xconnect>
<xid>1</xid>
<description>NXR_B</description>
<tid>1</tid>
<interface>ethernet0</interface>
<end-id>1</end-id>
<interval>30</interval>
<adjust-tcp-mss>enable</adjust-tcp-mss>
<mss>auto</mss>
</xconnect>
<xconnect>
<xid>2</xid>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 xconnect 1
description NXR_B
tunnel 1
xconnect ethernet 0
xconnect end-id 1
retry-interval 30
ip tcp adjust-mss auto
l2tpv3 xconnect 2
・・・・・

 

L2TPv3 Xconnect設定の更新

メソッド URI
PUT /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/{NUM}
JSON
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1
Content-Type: application/json

 

{
"xid": 1,
"description": "NXR_B",
"tid": 1,
"interface": "ethernet0",
"end-id": 1,
"interval": 30,
"adjust-tcp-mss": "enable",
"mss": "auto",
"split-horizon": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1
Content-Type: application/xml

 

<xconnect>
<xid>1</xid>
<description>NXR_B</description>
<tid>1</tid>
<interface>ethernet0</interface>
<end-id>1</end-id>
<interval>30</interval>
<adjust-tcp-mss>enable</adjust-tcp-mss>
<mss>auto</mss>
<split-horizon>enable</split-horizon>
</xconnect>

 

レスポンス

204 No content

 

L2TPv3 Xconnect設定の取得

メソッド URI
GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/{NUM}
JSON
リクエスト

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"xid": 1,
"description": "NXR_B",
"tid": 1,
"interface": "ethernet0",
"end-id": 1,
"interval": 30,
"adjust-tcp-mss": "enable",
"mss": "auto",
"split-horizon": "enable"
}

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<xconnect>
<xid>1</xid>
<description>NXR_B</description>
<tid>1</tid>
<interface>ethernet0</interface>
<end-id>1</end-id>
<interval>30</interval>
<adjust-tcp-mss>enable</adjust-tcp-mss>
<mss>auto</mss>
<split-horizon>enable</split-horizon>
</xconnect>

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 xconnect 1
description NXR_B
tunnel 1
xconnect ethernet 0
xconnect end-id 1
retry-interval 30
ip tcp adjust-mss auto
split-horizon enable

 

L2TPv3 Xconnect設定の削除

メソッド URI
DELETE /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/{NUM}
リクエスト

DELETE /api/v2/l2tpv3/l2tpv3-xconnect/xconnect/1

 

レスポンス

204 No content

 

L2TPv3グループ設定の作成

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

POST /api/v2/l2tpv3/l2tpv3-group/group
Content-Type: application/json

 

{
"group": {
"gid": 1,
"primary-xid": 1,
"secondary-xid": 2,
"mac-advertise": "enable"
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/l2tpv3/l2tpv3-group/group
Content-Type: application/xml

 

<l2tpv3-group>
<group>
<gid>1</gid>
<primary-xid>1</primary-xid>
<secondary-xid>2</secondary-xid>
<mac-advertise>enable</mac-advertise>
</group>
</l2tpv3-group>

 

レスポンス

201 Created

 

全L2TPv3グループ設定の取得

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

GET /api/v2/l2tpv3/l2tpv3-group/group
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"group": [
{
"gid": 1,
"primary-xid": 1,
"secondary-xid": 2,
"mac-advertise": "enable"
},
{
"gid": 2,
・・・・・

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-group/group
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<l2tpv3-group>
<group>
<gid>1</gid>
<primary-xid>1</primary-xid>
<secondary-xid>2</secondary-xid>
<mac-advertise>enable</mac-advertise>
</group>
<group>
<gid>2</gid>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-group/group
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 group 1
xconnect 1 2
mac-advertise enable
l2tpv3 group 2
・・・・・

 

L2TPv3グループ設定の更新

メソッド URI
PUT /api/v2/l2tpv3/l2tpv3-group/group/{NUM}
JSON
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-group/group/1
Content-Type: application/json

 

{
"gid": 1,
"primary-xid": 1,
"secondary-xid": 2,
"preempt": "enable",
"mac-advertise": "enable"
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/l2tpv3/l2tpv3-group/group/1
Content-Type: application/xml

 

<group>
<gid>1</gid>
<primary-xid>1</primary-xid>
<secondary-xid>2</secondary-xid>
<preempt>enable</preempt>
<mac-advertise>enable</mac-advertise>
</group>

 

レスポンス

204 No content

 

L2TPv3グループ設定の取得

メソッド URI
GET /api/v2/l2tpv3/l2tpv3-group/group/{NUM}
JSON
リクエスト

GET /api/v2/l2tpv3/l2tpv3-group/group/1
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"gid": 1,
"primary-xid": 1,
"secondary-xid": 2,
"preempt": "enable",
"mac-advertise": "enable"
}

 

XML
リクエスト

GET /api/v2/l2tpv3/l2tpv3-group/group/1
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<group>
<gid>1</gid>
<primary-xid>1</primary-xid>
<secondary-xid>2</secondary-xid>
<preempt>enable</preempt>
<mac-advertise>enable</mac-advertise>
</group>

 

TEXT/PLAIN
リクエスト

GET /api/v2/l2tpv3/l2tpv3-group/group/1
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

l2tpv3 group 1
xconnect 1 2
preempt enable
mac-advertise enable

 

L2TPv3グループ設定の削除

メソッド URI
DELETE /api/v2/l2tpv3/l2tpv3-group/group/{NUM}
リクエスト

DELETE /api/v2/l2tpv3/l2tpv3-group/group/1

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

l2tpv3

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
l2tpv3 global hostname ホスト名
router-id ルータID … A.B.C.D
mac-learning MACアドレス学習 … [enable | disable]
always-mac-learning MACアドレス学習always … [enable | disable]
unique-mac-learning MACアドレス学習unique … [enable | disable]
mac-aging MACアドレス学習時間 … <30-1000>(sec)
loop-detect ループ検出 … [enable | disable]
send-known-unicast Known-unicast … [enable | disable]
udp-source-port 送信元UDPポート … <1024-65535>
udp-pmtu UDP path-mtu-discovery … [enable | disable]
pmtu path-mtu-discovery … [enable | disable]
snmp L2TPv3 SNMP … [enable | disable]
snmp-trap L2TPv3 SNMPトラップ … [enable | disable]
tos ToS … [enable | disable]
tunnel-tos tunnel-tos … <0-252>
fast-forwarding L2TPv3 fast-forwarding … [enable | disable]
l2tpv3-tunnel tunnel L2TPv3トンネル設定
l2tpv3-xconnect xconnect L2TPv3 Xconnect設定
l2tpv3-group group L2TPv3グループ設定

 

tunnel

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
tunnel tid L2TPv3トンネル番号
description L2TPv3トンネルの説明
remote address リモートアドレス …

  • A.B.C.D
  • X:X::X:X
  • FQDN
  • any
address-family アドレスファミリ … [ip | ipv6]
hostname リモートホスト名
router-id リモートルータID … A.B.C.D
port 宛先UDPポート … <1024-65535>
password hidden 暗号化 … [enable | disable]
passphrase パスワード
apply 暗号化適用 … [enable | disable]
※hidden化する場合は必要
avp-hidden AVP Hiding … [enable | disable]
protocol プロトコル … [ip | udp]
local hostname ローカルホスト名
router-id ローカルルータID … A.B.C.D
digest メッセージダイジェスト … [md5 | sha1]
hello Helloインターバル … <0-3600>(sec)
vendor ベンダーID … [ietf | century | cisco]
netevent track-id トラックID
action ネットイベントアクション … disconnect

 

xconnect

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5
xconnect xid L2TPv3 Xconnect番号
description L2TPv3 Xconnectの説明
tid L2TPv3トンネル番号
interface Xconnectインタフェース名
end-id リモートエンドID … <1-4294967295>
vlan-id VLAN IDタグ付与 … <1-4094>
interval リトライインターバル … <0-1000>(sec)
adjust-tcp-mss IPv4 TCP MSS調整 … [enable | disable]
mss IPv4 TCP MSS値 … <500-1460>(bytes)、オートの場合はauto
loop-detect Loop Detection … [enable | disable]
send-known-unicast Known-unicast … [enable | disable]
send-circuit-down Send-circuit-down … [enable | disable]
split-horizon Split Horizon … [enable | disable]
tos Xconnect-tos … [inherit | <0-252>]
unique-mac-learning MACアドレス学習unique … [enable | disable]
filter in L2TPv3受信フィルタ … ACL名
vendor out L2TPv3送信フィルタ … ACL名

 

group

パラメータおよびレベル 説明
Lv.3 Lv.4
group gid L2TPv3グループ番号
primary-xid プライマリXconnect番号
secondary-xid セカンダリXconnect番号
preempt プリエンプト … [enable | disable]
enforce-secondary-down Secondaryセッション強制切断 … [enable | disable]
active-hold Active Hold … [enable | disable]
mac-advertise MAC Advertise Frame送信 … [enable | disable]