netbox3

netbox3

Overview

Python package designed to help work with the Netbox_ REST API.

• NbApi_ Request data from Netbox using filter parameters identical to those in the Web UI filter form. Filter parameters use the OR operator.
• NbForager_ The REST API returns objects that contain a brief representation of related objects. NbForager replaces brief data with full and objects look like a recursive multidimensional dictionary.
• NbBranch_ Extract typed values from a Netbox object dictionary by using a chain of keys.

Checked with Python >= 3.8, Netbox >= v3.6. Fully documented on Read the Docs_.

---

Quickstart

Install the package from pypi.org

.. code:: bash

pip install netbox3

or from github.com repository

.. code:: bash

pip install git+https://github.com/vladimirs-git/netbox3

NbForager demonstration. Assemble Netbox objects within self as a multidimensional dictionary.

Request the main object. All nested objects also are requested. Assemble multidimensional dictionary.

.. code:: python

from pprint import pprint

from netbox3 import NbForager

HOST = "demo.netbox.dev"
TOKEN = "1234567890123456789012345678901234567890"
nbf = NbForager(host=HOST, token=TOKEN, threads=10)

# Request devices with all nested object: device-roles, tenants, tags, etc.
nbf.dcim.devices.get(nested=True)
print(f"{len(nbf.root.dcim.devices)=}")
print(f"{len(nbf.root.dcim.device_roles)=}")
print(f"{len(nbf.root.tenancy.tenants)=}")
print(f"{len(nbf.root.extras.tags)=}")
# len(nbf.root.dcim.devices)=78
# len(nbf.root.dcim.device_roles)=10
# len(nbf.root.tenancy.tenants)=5
# len(nbf.root.extras.tags)=2


# Assemble objects within self as multidimensional dictionary.
tree = nbf.join_tree()
pprint(list(tree.dcim.devices.values())[0])
# {"id": 1,
#  "name": "dmi01-akron-rtr01",
#  "rack": {"id": 1,
#           "site": {"id": 2,
#                    "tenant": {"id": 5,
#                               "group": {"id": 1,
#                                         "name": "Customers",
#                                         ...
#           "tenant": {"id": 5,
#                      "group": {"id": 1,
#                                "name": "Customers",
#                                ...
# ...

Request objects using filtering parameters. Assemble multidimensional dictionary.

.. code:: python

from pprint import pprint

from netbox3 import NbForager, NbBranch

HOST = "demo.netbox.dev"
TOKEN = "1234567890123456789012345678901234567890"
nbf = NbForager(host=HOST, token=TOKEN)

# Request specific devices and all sites from Netbox.
# Note that the site in the device only contains basic data and
# does not include tags, region and other extended data.
nbf.dcim.devices.get(q="PP:B")
nbf.dcim.sites.get()
device = nbf.root.dcim.devices[88]
pprint(device)
# {"id": 88,
#  "name": "PP:B117",
#  "site": {"display": "MDF",
#           "id": 21,
#           "name": "MDF",
#           "slug": "ncsu-065",
#           "url": "https://demo.netbox.dev/api/dcim/sites/21/"},
#  ...

# Assemble objects within self as multidimensional dictionary.
# Note that the device now includes site region and all other data.
tree = nbf.join_tree()
device = tree.dcim.devices[88]
pprint(device)
# {"id": 88,
#  "name": "PP:B117",
#  "site": {"display": "MDF",
#           "id": 21,
#           "name": "MDF",
#           "slug": "ncsu-065",
#           "url": "https://demo.netbox.dev/api/dcim/sites/21/"
#           "region": {"_depth": 2,
#                      "display": "North Carolina",
#                      "id": 40,
#                      "name": "North Carolina",
#                      "slug": "us-nc",
#                      "url": "https://demo.netbox.dev/api/dcim/regions/40/"},
#           "tenant": {"display": "NC State University",
#                      "id": 13,
#                      "name": "NC State University",
#                      "slug": "nc-state",
#                      "url": "https://demo.netbox.dev/api/tenancy/tenants/13/"},
#           ...
# ...

# Access site attribute through a device.
region = device["site"]["region"]["name"]
print(f"{region=}")  # region="North Carolina"

# Use NbBranch to ensure the data type if any dictionary in the chain is missing.
region = NbBranch(device).str("site", "region", "name")
print(f"{region=}")  # region="North Carolina"

NbApi demonstration. Create, get, update and delete ip-addresses.

.. code:: python

from netbox3 import NbApi

HOST = "demo.netbox.dev"
TOKEN = "1234567890123456789012345678901234567890"
nb = NbApi(host=HOST, token=TOKEN)

# Create 2 addresses with different methods (different outputs)
response = nb.ipam.ip_addresses.create(address="1.2.3.4/24", tags=[2], status="active")
print(response)  # <Response [201]>
data = nb.ipam.ip_addresses.create_d(address="1.2.3.4/24", tags=[3], status="reserved")
print(data)  # {"id": 183, "display": "1.2.3.4/24", ...

# Get all addresses
addresses = nb.ipam.ip_addresses.get()
print(len(addresses))  # 181

# Get all ip-addresses in global routing
addresses = nb.ipam.ip_addresses.get(vrf="null")
print(len(addresses))  # 30

# Get newly created ip-addresses by complex filter
# Note, you can use parameters similarly to the ``OR`` operator.
# Filter addresses in the global routing AND
# (have either the tag "bravo" OR "charlie") AND
# (have a status of either active OR reserved).
addresses = nb.ipam.ip_addresses.get(or_q=["1.2.3", "4.5.6"],
                                     vrf="null",
                                     or_tag=["bravo", "charlie"],
                                     status=["active", "reserved"])
print(len(addresses))  # 2

addresses = nb.ipam.ip_addresses.get(address="1.2.3.4/24")
for address in addresses:
    # Update
    id_ = address["id"]
    response = nb.ipam.ip_addresses.update(id=id_, description="text")
    print(response)  # <Response [200]>
    print(nb.ipam.ip_addresses.get(id=id_)[0]["description"])  # text

    # Delete
    response = nb.ipam.ip_addresses.delete(id=id_)
    print(response)  # <Response [204]>

---

.. _Netbox: https://github.com/netbox-community/netbox .. _Read the Docs: https://netbox3.readthedocs.io/en/latest/ .. _NbApi: https://netbox3.readthedocs.io/en/latest/api/nb_api.html#nbapi .. _NbForager: https://netbox3.readthedocs.io/en/latest/foragers/nb_forager.html#nbforager .. _NbBranch: https://netbox3.readthedocs.io/en/latest/branch/nb_branch.html#nbbranch