RESTコンフィグレット

概要

Network Configuration Managerでは、REST APIを使用して、REST APIベースのコンフィグ管理、コンフィグレットを実行する機能が実装されています。
RESTコンフィグレットでは、IPアドレスやポリシー、セキュリティルールなどの追加、編集、削除など様々な操作が実装されています。

本ページでは、RESTコンフィグレットを使用するにあたり、装置の追加方法、認証情報の設定、RESTコンフィグレットの実行手順について記載します。

  • サポート対象
    ・Forti-OS
    ・PAN-OS
    ・Arista DCS
    ・HPE Aruba OS
    ・pfSense
  • 専用のREST装置テンプレートが実装されています。
    [コンフィグ自動化]→[装置テンプレート]→[REST装置テンプレート]画面から確認できます。
  • 本機能は、国内未検証です。

装置の追加方法

通常の装置追加と同様、管理対象の装置を手動またはディスカバリ機能で追加します。
装置の追加方法については、こちらのページをご参照ください。

装置を手動で追加した場合、画面が切り替わり、認証情報を入力する[NCM認証]画面が表示されます。
ディスカバリ機能で装置を追加した場合には、[インベントリ]→[装置]画面のホスト名左の鍵アイコンから[NCM認証]画面を表示します。

REST認証の設定手順について、以下をご確認ください。


REST API認証の設定手順

[NCM認証]画面では、REST認証情報または、CLI認証/REST認証をともに設定することが可能です。

Network Configuration Managerの機能を幅広く使用するために、CLI認証とREST認証の両方を設定することを推奨します。
CLI認証については、こちらのページをご参照ください。

以下の手順でREST認証を設定します。

  1. [NCM認証]画面を表示
  2. REST API認証のみを使用する場合には、プロトコルのプルダウンから[REST API]を選択
    ※CLI認証と併用する場合には、CLI用のプロトコルを選択
  3. [REST API]タブより、以下の各認証情報を入力
    ※CLI認証用のプロトコルを選択している場合には、[プライマリ]タブでCLI認証情報を入力し、[REST API]タブで[Use rest API for communication whenever applicable]にチェックを入れる必要があります。
    • ホスト/ドメイン
    • プロトコル(http/https)
    • 認証タイプ(Session/Token)
    • スコープ
    • VDOM
  4. [保存]をクリックし、認証情報を保存

プロトコル[REST API]のみを選択した場合、[保存&テスト]オプションは表示されません。


RESTコンフィグレットの実行手順

REST認証を設定後、以下の手順でRESTコンフィグレットを実行します。

  1. [コンフィグ自動化]→[コンフィグレット]→[REST Configlets]画面を表示
    ※サポート対象装置に対して、各オブジェクト(アドレスやポリシー、サービス)ごとのコンフィグレットがデフォルトで実装されています。
  2. 実行対象のコンフィグレットにチェックを入れ、右のアクションアイコンをクリック
    ※各コンフィグレットはそれ自体がアドレスやポリシー、サービスなどの実行対象であり、アクションアイコンから操作内容(追加、編集、表示、削除、リネーム)を選択します。
  3. 操作内容を選択後、画面が切り替わり、実行対象の装置を選択
    ※編集や削除オプションを選択した場合、対象装置から取得したオブジェクトリストから変更対象のオブジェクトを選択します。
  4. 各パラメーターを入力し[実行]をクリックすると、変更内容を装置に投入します。

RESTコンフィグレットの実行結果

実行したRESTコンフィグレットの実行結果は、以下の画面から確認できます。

  1. [コンフィグ自動化]→[コンフィグレット]→[実行履歴]画面を表示
  2. 一覧から、各コンフィグレットの実行結果のステータスを確認します。
    対象のコンフィグレットをクリックすることで、より詳細な情報を確認できます。

RESTコンフィグレットのメリット

RESTコンフィグレットによる設定変更には、以下のようなメリットがあります。

  • CLI認証による操作と比べ、高速で処理されます。
  • 実行に必要なコンフィグレットがデフォルトで実装されており、コマンド不要で直感的な操作が可能
  • CLI認証における、階層構造(モード)や構文を考慮する必要がなくなります。
       概要