FutureNet

NXR,VXRシリーズ

REST-API編

4. ルーティング設定

4-5. IPv4ルートアクセスリスト設定(acl_route)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
IPv4 route ACL v2 /api/v2/acl_route
/api/v2/acl_route/access-list
/api/v2/acl_route/access-list/{NAME}

凡例:

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

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

- : 未対応

 

実行例

IPv4ルートアクセスリスト名の定義および設定の作成

メソッド URI
POST /api/v2/acl_route/access-list
JSON
リクエスト

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

 

{
"access-list": {
"name": "RACL",
"rule": {
"permission": "permit",
"prefix": {
"address": "192.168.0.0/24"
}
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<acl_route>
<access-list>
<name>RACL</name>
<rule>
<permission>permit</permission>
<prefix>
<address>192.168.0.0/24</address>
</prefix>
</rule>
</access-list>
</acl_route>

 

レスポンス

201 Created

 

IPv4ルートアクセスリスト設定の追加

メソッド URI
PUT /api/v2/acl_route/access-list/{NAME}
  • PUT時は、既存のアクセスリスト名へのルールの追加のみ可能です。

 

JSON
リクエスト

PUT /api/v2/acl_route/access-list/RACL
Content-Type: application/json

 

{
"name": "RACL",
"rule": {
"permission": "permit",
"prefix": {
"address": "192.168.1.0/24"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/acl_route/access-list/RACL
Content-Type: application/xml

 

<access-list>
<name>RACL</name>
<rule>
<permission>permit</permission>
<prefix>
<address>192.168.1.0/24</address>
</prefix>
</rule>
</access-list>

 

レスポンス

204 No content

 

IPv4ルートアクセスリスト設定の取得

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

 

JSON
リクエスト

GET /api/v2/acl_route/access-list/RACL
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "RACL",
"rule": [
{
"permission": "permit",
"prefix": {
"address": "192.168.0.0/24"
}
},
{
"permission": "permit",
"prefix": {
"address": "192.168.1.0/24"
}
}
]
}

 

XML
リクエスト

GET /api/v2/acl_route/access-list/RACL
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<access-list>
<name>RACL</name>
<rule>
<permission>permit</permission>
<prefix>
<address>192.168.0.0/24</address>
</prefix>
</rule>
<rule>
<permission>permit</permission>
<prefix>
<address>192.168.1.0/24</address>
</prefix>
</rule>
</access-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/acl_route/access-list/RACL
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip route access-list RACL permit 192.168.0.0/24
ip route access-list RACL permit 192.168.1.0/24

 

IPv4ルートアクセスリスト設定の削除

メソッド URI
DELETE /api/v2/acl_route/access-list/{NAME}
  • Bodyを指定しなかった場合、指定したNAMEのIPv4ルートアクセスリスト設定を全て削除します。

 

JSON
リクエスト

DELETE /api/v2/acl_route/access-list/RACL
Content-Type: application/json

 

{
"name": "RACL",
"rule": {
"permission": "permit",
"prefix": {
"address": "192.168.0.0/24"
}
}
}

 

レスポンス

204 No content

 

XML
リクエスト

DELETE /api/v2/acl_route/access-list/RACL
Content-Type: application/xml

 

<access-list>
<name>RACL</name>
<rule>
<permission>permit</permission>
<prefix>
<address>192.168.0.0/24</address>
</prefix>
</rule>
</access-list>

 

レスポンス

204 No content

 

パラメータ

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

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

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

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4 Lv.5
acl_route access-list name ACL名
rule permission 動作 … [ permit | deny ]
prefix address プレフィックス …

  • any
  • A.B.C.D/M
exact-match exact-math … [ enable | disable ]