opnsense でAPIを使う。
APIを使うには、キーが必要
APIのリクエストのエンドポイント（OPNSenseのアドレス）
キーの作成
APIの認証キーの作成は、管理画面から行える。
ユーザーをクリック、編集、APIキー作成を選んで作成。作成するとキーファイルがダウンロードされる。
ユーザを選んで
キーを作成。
ファイルがダウンロードされる。
かんたんにリクエストを投げてみる。
作成されたファイルは、イコールで結ばれたキーバリューなのでそのままソースコードやBashに貼り付けて使える。
key=XXX secret=XXX
これを curl コマンドとして作成。
あとはリクエストを投げるだけ。
サンプルで投げたAPIリクエストは、 ファームウェアの更新状況が完了しているか見るもので、マニュアルはここ ( https://docs.opnsense.org/development/api/core/firmware.html ) にある。
設定をAPIでバックアップする
たとえば、設定をAPI経由でバックアップするのは、システムのファームウェアから、os-api-backup のパッケージを追加する。
すると、API経由でXMLがダウンロードできるようになる。
パッケージインストール
リクエスト
key=XXXX
secret=XXXX
host=192.168.1.1
curl -k -u $key:$secret https://${host}/api/backup/backup/download -o config.$(date -I).xml
これで設定のバックアップは自動化できる。pfsense/OPNsenseは良く出来てるよなぁ。
