NXR,VXRシリーズ

4-1. IPv4スタティックルート設定（static-rt4）

 処理概要

IPv4スタティックルート設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
IPv4 static route	v1	/api/v1/static-rt4	〇	－	●	〇
	v2	/api/v2/static-rt4	〇	－	●	〇

凡例：

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

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

－ : 未対応

※ NXR-G100シリーズ以外の機種ではREST-APIv2の利用を推奨します。

 

実行例

IPv4スタティックルート設定の作成

メソッド	URI
POST	/api/{VERSION}/static-rt4

JSON

リクエスト

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

 

{
"route": {
"prefix": "192.168.1.0/24",
"nexthop": "192.168.0.1",
"distance": 10
}
}


 

レスポンス

201 Created

 

XML

リクエスト

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

 

<static-rt4>
<route>
<prefix>192.168.1.0/24</prefix>
<nexthop>192.168.0.1</nexthop>
<distance>10</distance>
</route>
</static-rt4>

 

レスポンス

201 Created

 

IPv4スタティックルート設定の取得

メソッド	URI
GET	/api/{VERSION}/static-rt4

• api/v1は、text/plainに対応していません。

 

JSON

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/json

 

{
"route": [
{
"prefix": "192.168.1.0/24",
"nexthop": "192.168.0.1",
"distance": 10
},
{
"prefix": "192.168.1.0/24",
"interface": "tunnel1",
"distance": 20
}
]
}

 

XML

リクエスト

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

 

レスポンス

200 OK
Content-Type: application/xml

 

<static-rt4>
<route>
<prefix>192.168.1.0/24</prefix>
<nexthop>192.168.0.1</nexthop>
<distance>10</distance>
</route>
<route>
<prefix>192.168.1.0/24</prefix>
<interface>tunnel1</interface>
<distance>20</distance>
</route>
</static-rt4>

 

TEXT/PLAIN

リクエスト

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

 

レスポンス

200 OK
Content-Type: text/plain

 

ip route 192.168.1.0/24 192.168.0.1 10
ip route 192.168.1.0/24 tunnel 1 20

 

IPv4スタティックルート設定の削除

メソッド	URI
DELETE	/api/{VERSION}/static-rt4

JSON

リクエスト

DELETE /api/v2/static-rt4
Content-Type: application/json

 

{
"route": {
"prefix": "192.168.1.0/24",
"nexthop": "192.168.0.1",
"distance": 10
}
}

 

レスポンス

204 No content

 

XML

リクエスト

DELETE /api/v2/static-rt4
Content-Type: application/xml

 

<static-rt4>
<route>
<prefix>192.168.1.0/24</prefix>
<nexthop>192.168.0.1</nexthop>
<distance>10</distance>
</route>
</static-rt4>

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル				説明
Lv.1	Lv.2	Lv.3	Lv.4
static-rt4	route	prefix		宛先IPv4アドレス … A.B.C.D/M mape-rule
		interface		インタフェース名（ex. ppp0）
		nexthop		ネクストホップ … A.B.C.D dhcp
		tag		タグ … <1-65535>
		distance		ディスタンス … <1-255>
		netevent	track-id	トラックID
			action	ネットイベントアクション … [ active | inactive ]
		mape-rule		MAP-Eルール名