概要

NetBoxを使ってみようの第6回でプラグインの導入を行ってみます。
NetBoxはプラグインの開発がかなり盛んで、多くのものがすでに公開されています。
今回はそんな中から1つ試しに導入してみようと思います。

全記事

NetBoxのプラグインは多くあり、公式サイトでも数多く掲載されています。

なお公式サイトで公開されているプラグインはNetBoxの管理画面からも確認でき、インストール状況も見れます。

プラグインを選択して、Installを選択すると手順も表示されるため、かなりお手軽です。

それでは実際にインストールを行っていきます。
今回は”NetBox Topology Views”というプラグインをインストールしていきます。

まずNetBoxをインストールしているマシンにSSHで接続して、pythonの仮想環境に入ります。

source /opt/netbox/venv/bin/activate

続いて以下コマンドでプラグインをインストールしておきます。

sudo /opt/netbox/venv/bin/pip3 install netbox-topology-views

こちらはオプションですが、今後NetBoxの更新などを行った際に自動でインストールされるように、インストール対象としても登録しておきます。

echo netbox-topology-views >> local_requirements.txt

続いて設定ファイルにもPluginを追記しておきます。

/opt/netbox/netbox/netbox/configuration.py

PLUGINS = [
        "netbox_topology_views",
]

次はデータベースの移行と静的ファイルの収集を行うスクリプトを実施します。
※仮想環境をActivateしているはずだが、なぜか仮想環境側のpythonを直接実行する必要がありました

sudo /opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py migrate
sudo /opt/netbox/venv/bin/python3 /opt/netbox/netbox/manage.py collectstatic

最後にnetboxのserviceを再起動させたら完了です。

sudo systemctl restart netbox netbox-rq

NetBoxのUIに戻り、ページをリロードしてPluginを確認すると、Installedになっていることが確認できます。

今回追加したPluginは物理機器の接続状況をTopologyとして可視化することができるものになります。
Siteの画面に新しくTopologyというボタンが追加されているので、押してみると可視化できることが確認できました。

今回はNetBoxにプラグインを導入してみました。
インストール方法がUI上で用意されていたり、インストール状況も見れるのはかなり親切でした。
他にも多くのプラグインがあるので、良さそうのを見つけたら追加してみようと思います。

また、本記事で一応予定していたNetBoxの記事は終了となります。
APIなど、まだ全然触りきれていないのでまた機会があったら投稿するかもです。

以上