NXR,VXRシリーズ

4-8. IPポリシルール設定（policy-rule）

 処理概要

IPポリシルール設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
Policy Rule	v2	/api/v2/policy-rule	－	－	－	－
		/api/v2/policy-rule/policy-rule-list	〇	－	－	－
		/api/v2/policy-rule/policy-rule-list/{NAME}	－	〇	●	〇

凡例：

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

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

－ : 未対応

 

実行例

IPポリシルール名の定義および設定の作成

メソッド	URI
POST	/api/v2/policy-rule/policy-rule-list

JSON

リクエスト

POST /api/v2/policy-rule/policy-rule-list
Content-Type: application/json

 

{
"policy-rule-list": {
"name": "LOCAL_PBR_OUT",
"rule": {
"source": "192.168.10.1",
"destination": "0.0.0.0/0"
}
}
}

 

レスポンス

201 Created

 

XML

リクエスト

POST /api/v2/policy-rule/policy-rule-list
Content-Type: application/xml

 

<policy-rule>
<policy-rule-list>
<name>LOCAL_PBR_OUT</name>
<rule>
<source>192.168.10.1</source>
<destination>0.0.0.0/0</destination>
</rule>
</policy-rule-list>
</policy-rule>

 

レスポンス

201 Created

 

IPポリシルール設定の追加・更新

メソッド	URI
PUT	/api/v2/policy-rule/policy-rule-list/{NAME}

JSON

リクエスト

PUT /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Content-Type: application/json

 

{
"name": "LOCAL_PBR_OUT",
"rule": {
"source": "192.168.10.2",
"destination": "0.0.0.0/0"
}
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Content-Type: application/xml

 

<policy-rule-list>
<name>LOCAL_PBR_OUT</name>
<rule>
<source>192.168.10.2</source>
<destination>0.0.0.0/0</destination>
</rule>
</policy-rule-list>

 

レスポンス

204 No content

 

IPポリシルール設定の取得

メソッド	URI
GET	/api/v2/policy-rule/policy-rule-list/{NAME}

JSON

リクエスト

GET /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "LOCAL_PBR_OUT",
"rule": [
{
"source": "192.168.10.1",
"destination": "0.0.0.0/0"
},
{
"source": "192.168.10.2",
"destination": "0.0.0.0/0"
}
]
}

 

XML

リクエスト

GET /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<policy-rule-list>
<name>LOCAL_PBR_OUT</name>
<rule>
<source>192.168.10.1</source>
<destination>0.0.0.0/0</destination>
</rule>
<rule>
<source>192.168.10.2</source>
<destination>0.0.0.0/0</destination>
</rule>
</policy-rule-list>

 

TEXT/PLAIN

リクエスト

GET /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip local policy-rule LOCAL_PBR_OUT 192.168.10.1 any
ip local policy-rule LOCAL_PBR_OUT 192.168.10.2 any

 

IPポリシルール設定の削除

メソッド	URI
DELETE	/api/v2/policy-rule/policy-rule-list/{NAME}

• Bodyを指定しなかった場合、指定したNAMEのIPポリシルール設定を全て削除します。

 

JSON

リクエスト

DELETE /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Content-Type: application/json

 

{
"name": "LOCAL_PBR_OUT",
"rule": {
"source": "192.168.10.2",
"destination": "0.0.0.0/0"
}
}

 

レスポンス

204 No content

 

XML

リクエスト

DELETE /api/v2/policy-rule/policy-rule-list/LOCAL_PBR_OUT
Content-Type: application/xml

 

<policy-rule-list>
<name>LOCAL_PBR_OUT</name>
<rule>
<source>192.168.10.2</source>
<destination>0.0.0.0/0</destination>
</rule>
</policy-rule-list>

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル					説明
Lv.1	Lv.2	Lv.3	Lv.4	Lv.5
policy-rule	policy-rule-list	name			ポリシルールリスト名
		rule	source	address	送信元アドレス … any A.B.C.D A.B.C.D/M FQDN
			destination	address	宛先アドレス … any A.B.C.D A.B.C.D/M FQDN
			protocol		プロトコル … [ <0-255> | icmp | tcp | udp ]
			src_port	min	送信元ポート番号 … [ any | <1-65535> ]
				max	送信元ポート番号 … <1-65535> ※範囲指定時のみ有効
			dst_port	min	宛先ポート番号 … [ any | <1-65535> ]
				max	宛先ポート番号 … <1-65535> ※範囲指定時のみ有効