FutureNet

NXR,VXRシリーズ

REST-API編

4. ルーティング設定

4-9. ASパスアクセスリスト設定(as-path)

 処理概要

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

 

URIおよびメソッド

機能 Version URI メソッド
POST PUT GET DELETE
ASPath ACL v2 /api/v2/as-path
/api/v2/as-path/access-list
/api/v2/as-path/access-list/{NAME}

凡例:

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

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

- : 未対応

 

実行例

ASパスアクセスリスト名の定義および設定の作成

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

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

 

{
"access-list": {
"name": "aspath_acl",
"rule": {
"permission": "permit",
"regex": "^$"
}
}
}

 

レスポンス

201 Created

 

XML
リクエスト

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

 

<as-path>
<access-list>
<name>aspath_acl</name>
<rule>
<permission>permit</permission>
<regex>^$</regex>
</rule>
</access-list>
</as-path>

 

レスポンス

201 Created

 

ASパスアクセスリスト設定の追加

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

 

JSON
リクエスト

PUT /api/v2/as-path/access-list/aspath_acl
Content-Type: application/json

 

{
"name": "aspath_acl",
"rule": {
"permission": "deny",
"regex": "_65200_"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

PUT /api/v2/as-path/access-list/aspath_acl
Content-Type: application/xml

 

<access-list>
<name>aspath_acl</name>
<rule>
<permission>deny</permission>
<regex>_65200_</regex>
</rule>
</access-list>

 

レスポンス

204 No content

 

ASパスアクセスリスト設定の取得

メソッド URI
GET /api/v2/as-path/access-list/{NAME}
JSON
リクエスト

GET /api/v2/as-path/access-list/aspath_acl
Accept: application/json

 

レスポンス

200 OK
Content-Type: application/json

 

{
"name": "aspath_acl",
"rule": [
{
"permission": "permit",
"regex": "^$"
},
{
"permission": "deny",
"regex": "_65200_"
}
]
}

 

XML
リクエスト

GET /api/v2/as-path/access-list/aspath_acl
Accept: application/xml

 

レスポンス

200 OK
Content-Type: application/xml

 

<access-list>
<name>aspath_acl</name>
<rule>
<permission>permit</permission>
<regex>^$</regex>
</rule>
<rule>
<permission>deny</permission>
<regex>_65200_</regex>
</rule>
</access-list>

 

TEXT/PLAIN
リクエスト

GET /api/v2/as-path/access-list/aspath_acl
Accept: text/plain

 

レスポンス

200 OK
Content-Type: text/plain

 

ip as-path access-list aspath_acl permit ^$
ip as-path access-list aspath_acl deny _65200_

 

ASパスアクセスリスト設定の削除

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

 

JSON
リクエスト

DELETE /api/v2/as-path/access-list/aspath_acl
Content-Type: application/json

 

{
"name": "aspath_acl",
"rule": {
"permission": "permit",
"regex": "^$"
}
}

 

レスポンス

204 No content

 

XML
リクエスト

DELETE /api/v2/as-path/access-list/aspath_acl
Content-Type: application/xml

 

<access-list>
<name>aspath_acl</name>
<rule>
<permission>permit</permission>
<regex>^$</regex>
</rule>
</access-list>

 

レスポンス

204 No content

 

パラメータ

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

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

  • パラメータ表の説明文中の表記について
    [ ] … 括弧内の値のどれかを選択することを示しています。

 

パラメータおよびレベル 説明
Lv.1 Lv.2 Lv.3 Lv.4
as-path access-list name ACL名
rule permission パーミッション … [ permit | deny ]
regex BGP AS PATHにマッチする正規表現