NXR,VXRシリーズ

3-10. vethインタフェース設定（veth-interface）

 処理概要

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

 

URIおよびメソッド

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

凡例：

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

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

－ : 未対応

 

実行例

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

メソッド	URI
POST	/api/v2/veth-interface/veth

JSON

リクエスト

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

 

{
"veth": {
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/24"
}
},
"lxc-link": 1
}
}

 

レスポンス

201 Created

 

XML

リクエスト

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

 

<veth-interface>
<veth>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/24</address>
</ipv4-address>
</ipv4>
<lxc-link>1</lxc-link>
</veth>
</veth-interface>

 

レスポンス

201 Created

 

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

メソッド	URI
GET	/api/v2/veth-interface/veth

JSON

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"veth": [
{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.0.1/24"
}
},
"lxc-link": 1
},
{
"number": 1,
"bridge-group": {
"number": 0,
"port": 1
}
}
]
}

 

XML

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<veth-interface>
<veth>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.0.1/24</address>
</ipv4-address>
</ipv4>
<lxc-link>1</lxc-link>
</veth>
<veth>
<number>1</number>
<bridge-group>
<number>0</number>
<port>1</port>
</bridge-group>
</veth>
</veth-interface>

 

TEXT/PLAIN

リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface veth 0
ip address 192.168.0.1/24
lxc-link 1
interface veth 1
bridge-group 0 port 1
no ip address

 

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

メソッド	URI
PUT	/api/v2/veth-interface/veth/{NUM}

JSON

リクエスト

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

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.10.1/24"
}
},
"lxc-link": 1
}

 

レスポンス

204 No content

 

XML

リクエスト

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

 

<veth>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.10.1/24</address>
</ipv4-address>
</ipv4>
<lxc-link>1</lxc-link>
</veth>

 

レスポンス

204 No content

 

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

メソッド	URI
GET	/api/v2/veth-interface/veth/{NUM}

JSON

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"number": 0,
"ipv4": {
"ipv4-address": {
"address": "192.168.10.1/24"
}
},
"lxc-link": 1
}

 

XML

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<veth>
<number>0</number>
<ipv4>
<ipv4-address>
<address>192.168.10.1/24</address>
</ipv4-address>
</ipv4>
<lxc-link>1</lxc-link>
</veth>

 

TEXT/PLAIN

リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

interface veth 0
ip address 192.168.10.1/24
lxc-link 1

 

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

メソッド	URI
DELETE	/api/v2/veth-interface/veth/{NUM}

リクエスト

DELETE /api/v2/veth-interface/veth/0

 

レスポンス

204 No content

 

パラメータ

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

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

• パラメータ表の説明文中の表記について
  < > … 括弧内の値の範囲から選択することを示しています。
  数字,文字列 … 初期値
• パラメータ表の説明文中のデータタイプについて
  A.B.C.D/M … IPv4プレフィックスおよびマスク長
  XX:XX:XX:XX:XX:XX … MACアドレス

 

パラメータおよびレベル					説明
Lv.1	Lv.2	Lv.3	Lv.4	Lv.5
veth-interface	veth	number			インタフェース番号
		description			インタフェースの説明
		ipv4	ipv4-address	address	IPv4アドレス … A.B.C.D/M
				secondary-address	セカンダリIPv4アドレス … A.B.C.D/M
		lxc-link			リンク先LXC番号
		veth-parameter	hw-address		HWアドレス … XX:XX:XX:XX:XX:XX
		bridge-group	number		ブリッジグループ番号
			port		ブリッジポート番号 … <1-128>
			path-cost		STPパスコスト … <0-65535>
			priority		STPプライオリティ … <0-255(128)>