FutureNet

NXR,VXRシリーズ

REST-API編

3. インタフェース設定

3-5. TAPインタフェース設定(tap-interface)

 処理概要

TAPインタフェース設定に関する処理を実行します。

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
tap interface v2 /api/v2/tap-interface
/api/v2/tap-interface/tap
/api/v2/tap-interface/tap/{NUM}

凡例:

● : 読み取り専用ユーザも含めアクセス可

〇 : 読み取り専用ユーザはアクセス不可

- : 未対応

 

実行例

TAPインタフェース設定の作成

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

POST /api/v2/tap-interface/tap
Content-Type: application/json

 

{
"tap": {
"number": 0,
"bridge-group": {
"number": 0,
"port": 1
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

POST /api/v2/tap-interface/tap
Content-Type: application/xml

 

<tap-interface>
<tap>
<number>0</number>
<bridge-group>
<number>0</number>
<port>1</port>
</bridge-group>
</tap>
</tap-interface>

 

レスポンス

201 Created

 

全TAPインタフェース設定の取得

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

GET /api/v2/tap-interface/tap
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"tap": [
{
"number": 0,
"bridge-group": {
"number": 0,
"port": 1
}
},
{
"number": 1,
・・・・・

 

XML
リクエスト

GET /api/v2/tap-interface/tap
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<tap-interface>
<tap>
<number>0</number>
<bridge-group>
<number>0</number>
<port>1</port>
</bridge-group>
</tap>
<tap>
<number>1</number>
・・・・・

 

TEXT/PLAIN
リクエスト

GET /api/v2/tap-interface/tap
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

interface tap 0
bridge-group 0 port 1
interface tap 1
・・・・・

 

TAPインタフェース設定の更新

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

PUT /api/v2/tap-interface/tap/0
Content-Type: application/json

 

{
"number": 0,
"bridge-group": {
"number": 1,
"port": 1
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/tap-interface/tap/0
Content-Type: application/xml

 

<tap>
<number>0</number>
<bridge-group>
<number>1</number>
<port>1</port>
</bridge-group>
</tap>

 

レスポンス

204 No content

 

TAPインタフェース設定の取得

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

GET /api/v2/tap-interface/tap/0
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"bridge-group": {
"number": 0,
"port": 1
}
}

 

XML
リクエスト

GET /api/v2/tap-interface/tap/0
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<tap>
<number>0</number>
<bridge-group>
<number>0</number>
<port>1</port>
</bridge-group>
</tap>

 

TEXT/PLAIN
リクエスト

GET /api/v2/tap-interface/tap/0
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

interface tap 0
bridge-group 0 port 1

 

TAPインタフェース設定の削除

メソッド URI
DELETE /api/v2/tap-interface/tap/{NUM}
  • TAPインタフェース上でVLANを設定している場合は、削除できません。

 

リクエスト

DELETE /api/v2/tap-interface/tap/0

 

レスポンス

204 No content

 

パラメータ

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

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

  • パラメータ表の説明文中の表記について
    < > … 括弧内の値の範囲から選択することを示しています。
    [ ] … 括弧内の値のどれかを選択することを示しています。
    数字,文字列 … 初期値

 

tap-interface

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3
tap-interface tap number インタフェース番号
description インタフェースの説明
bridge-group ブリッジグループ設定
l2tpv3 L2TPv3設定

 

bridge-group

パラメータおよびレベル 説明
Lv.3 Lv.4
bridge-group number ブリッジグループ番号
port ブリッジポート番号 … <1-128>
path-cost STPパスコスト … <0-65535>
priority STPプライオリティ … <0-255(128)>

 

l2tpv3

パラメータおよびレベル 説明
Lv.3 Lv.4 Lv.5 Lv.6 Lv.7
l2tpv3 l2rp l2rp-group id L2RP ID … <1-255>
type L2RPマスタタイプ … [ priority | active ]
priority L2RPプライオリティ … <1-255(100)>
preempt L2RPプリエンプト … [ enable | disable ]
block-reset ブロックリセット … [ enable | disable ]
timers advertise L2RP広告間隔 … <1-60>(sec)
delay L2RP遅延時間 … <0-60>(sec)
port-reset ポートリセット … <0-1>
filter in L2TPv3フィルタ(in) … ACL名
out L2TPv3フィルタ(out) … ACL名