Skip to content

Python で NetBox に情報を追加する

以前に Terraform で NetBox に情報を追加する というメモを書きました。 今回は Python から NetBox に情報を追加してみました。 Python から NetBox を操作するには python-netbox を使うのが簡単です。

検証環境

対象 バージョン
Ubuntu 22.04.3LTS
NetBox 3.7-2.8.0
Python 3.12.2

サンプルスクリプト

まず、pip で python-netbox をインストールしておきます。

1
python3 -m pip install python-netbox

python-netbox の Read the Docs は API 詳細が書かれておらず、全く参考になりません… (どこで API 詳細を調べるのが正解なのでしょうか？…) その為、今回は直接 python-netbox のソースコードで定義されている create_ip_address を読みました。

今回は以下のサンプルスクリプトを用意しました。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
#!/usr/bin/env python3

from netbox import NetBox

netbox = NetBox(
    host="10.0.0.1",
    port=8000,
    use_ssl=False,
    auth_token="0123456789abcdefghij0123456789abcdefghij",
)
netbox.ipam.create_ip_address(address="10.0.0.99/24")

実行結果

サンプルスクリプトを実行すると NetBox 上に IP アドレスが作成されました。

file