NXR,VXRシリーズ

5-3. IPv4 Web認証アクセスリスト設定（acl_webauth）

 処理概要

IPv4 Web認証アクセスリスト設定に関する処理を実行します。

 

URIおよびメソッド

機能	Version	URI	メソッド
			POST	PUT	GET	DELETE
IPv4 WebAuth ACL	v2	/api/v2/acl_webauth	－	－	－	－
		/api/v2/acl_webauth/access-list	〇	－	－	－
		/api/v2/acl_webauth/access-list/{NAME}	－	〇	●	〇

凡例：

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

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

－ : 未対応

 

実行例

IPv4 Web認証アクセスリスト名の定義および設定の作成

メソッド	URI
POST	/api/v2/acl_webauth/access-list

JSON

リクエスト

POST /api/v2/acl_webauth/access-list
Content-Type: application/json

 

{
"access-list": {
"name": "eth0_WEB_FORWARD-IN",
"rule": {
"permission": "permit",
"destination": "192.168.0.0/24",
"source": "192.168.1.0/24"
}
}
}

 

レスポンス

201 Created

 

XML

リクエスト

POST /api/v2/acl_webauth/access-list
Content-Type: application/xml

 

<acl_webauth>
<access-list>
<name>eth0_WEB_FORWARD-IN</name>
<rule>
<permission>permit</permission>
<destination>192.168.0.0/24</destination>
<source>192.168.1.0/24</source>
</rule>
</access-list>
</acl_webauth>

 

レスポンス

201 Created

 

IPv4 Web認証アクセスリスト設定の追加

メソッド	URI
PUT	/api/v2/acl_webauth/access-list/{NAME}

• PUT時は、既存のアクセスリスト名へのルールの追加のみ可能です。

 

JSON

リクエスト

PUT /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Content-Type: application/json

 

{
"name": "eth0_WEB_FORWARD-IN",
"rule": {
"permission": "deny",
"destination": "192.168.0.0/24",
"source": "192.168.2.0/24",
"protocol": "tcp",
"dst_port": {
"min": 880
},
"src_port": {
"min": "any"
}
}
}

 

レスポンス

204 No content

 

XML

リクエスト

PUT /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Content-Type: application/xml

 

<access-list>
<name>eth0_WEB_FORWARD-IN</name>
<rule>
<permission>deny</permission>
<destination>192.168.0.0/24</destination>
<source>192.168.2.0/24</source>
<protocol>tcp</protocol>
<dst_port>
<min>880</min>
</dst_port>
<src_port>
<min>any</min>
</src_port>
</rule>
</access-list>

 

レスポンス

204 No content

 

IPv4 Web認証アクセスリスト設定の取得

メソッド	URI
GET	/api/v2/acl_webauth/access-list/{NAME}

JSON

リクエスト

GET /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "eth0_WEB_FORWARD-IN",
"rule": [
{
"permission": "permit",
"destination": "192.168.0.0/24",
"source": "192.168.1.0/24"
},
{
"permission": "deny",
"destination": "192.168.0.0/24",
"source": "192.168.2.0/24",
"protocol": "tcp",
"dst_port": {
"min": 880
},
"src_port": {
"min": "any"
}
}
]
}

 

XML

リクエスト

GET /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<access-list>
<name>eth0_WEB_FORWARD-IN</name>
<rule>
<permission>permit</permission>
<destination>192.168.0.0/24</destination>
<source>192.168.1.0/24</source>
</rule>
<rule>
<permission>deny</permission>
<destination>192.168.0.0/24</destination>
<source>192.168.2.0/24</source>
<protocol>tcp</protocol>
<dst_port>
<min>880</min>
</dst_port>
<src_port>
<min>any</min>
</src_port>
</rule>
</access-list>

 

TEXT/PLAIN

リクエスト

GET /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip web-auth access-list eth0_WEB_FORWARD-IN permit 192.168.1.0/24 192.168.0.0/24
ip web-auth access-list eth0_WEB_FORWARD-IN deny 192.168.2.0/24 192.168.0.0/24 tcp any 880

 

IPv4 Web認証アクセスリスト設定の削除

メソッド	URI
DELETE	/api/v2/acl_webauth/access-list/{NAME}

• Bodyを指定しなかった場合、指定したNAMEのIPv4 Web認証アクセスリスト設定を全て削除します。

 

JSON

リクエスト

DELETE /api/v2/acl_webauth/access-list/eth0_WEB_FORWARD-IN
Content-Type: application/json

 

{
"name": "eth0_WEB_FORWARD-IN",
"rule": {
"permission": "permit",
"destination": "192.168.0.0/24",
"source": "192.168.1.0/24"
}
}

 

レスポンス

204 No content

 

XML

リクエスト

DELETE /api/v2/acl_v4/access-list/eth0_WEB_FORWARD-IN
Content-Type: application/xml

 

<access-list>
<name>eth0_WEB_FORWARD-IN</name>
<rule>
<permission>permit</permission>
<destination>192.168.0.0/24</destination>
<source>192.168.1.0/24</source>
</rule>
</access-list>

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル					説明
Lv.1	Lv.2	Lv.3	Lv.4	Lv.5
acl_webauth	access-list	name			ACL名
		rule	permission		動作 … [ permit | deny ]
			destination		宛先IPv4アドレス … any A.B.C.D A.B.C.D/M FQDN
			source		送信元IPv4アドレス … any A.B.C.D A.B.C.D/M FQDN
			protocol		プロトコル … [ icmp | tcp | udp | <0-255> ]
			icmp_type		ICMPタイプ … <0-255>
			icmp_code		ICMPコード … <0-255>
			dst_port	min	宛先ポート番号 … [ any | <1-65535> ]
				max	宛先ポート番号 … <1-65535> ※範囲指定時のみ有効
			src_port	min	送信元ポート番号 … [ any | <1-65535> ]
				max	送信元ポート番号 … <1-65535> ※範囲指定時のみ有効
			tcp_flag		TCPフラグ … syn
			src_mac		送信元MACアドレス … XX:XX:XX:XX:XX:XX