1.初めに
ASA の REST API には、GUI画面でAPIを簡単に実行・確認する機能があります。
このドキュメントでは ASA の REST API に触れたことの無い方でも簡単に ASA の REST API を触れる方法についてご紹介いたします。
※動作は ASAv, ASA Version 9.14(2)13, rest api 7.15.1 にて確認しています。
なお、REST API エージェントのインストール方法については下記URLに記載がございますので本ドキュメントでは割愛いたします。
2.ASA REST API GUI にアクセス
ASAに REST API エージェントをインストール後、ブラウザから下記URLを入力します。
https://<asa_ip_address>/doc/
正常に開けますと、下記トップページが表示されます。
3.利用例
ここでは利用例として、新規で Network Object Groupを設定(POST)する方法を紹介します。
GUI 画面左のObjects タブ > /api/objects/networkobjectgroups > [POST] をクリックすると画面右にAPI CONSOLE が表示されます。本例では "API-TEST" という名前の Network Object group するため下記内容をAPI CONSOLEに入力します。
{
"kind": "object#NetworkObjGroup",
"name": "API-TEST",
"members": [
{
"kind": "IPv4Address",
"value": "10.0.0.1"
}
]
}
その後、API CONSOLE 画面下にある[POST] ボタンをクリックします。APIの実行が成功すると、ボタンの隣に"Success!" の文字が表示されます。
ASAのCLIから確認すると、下記のように新規で設定されていることが確認できます。
ASAv# show run object-group
object-group network API-TEST
network-object host 10.0.0.1
4.便利な機能の紹介
4-1.サンプルコードの確認
それぞれの機能において、"Examples" をクリックするとサンプルが表示されます。
4-2.実施したAPIのExport
"Export operation in ... " から、 API CONSOLE上で実施した内容を下記 script としてExport することができます。
- Python script
- Perl script
- Javascript
参考