Package: nbforager
nbforagerOverviewPython package designed to help work with theNetboxREST API.NbApiRequest data from Netbox using filter parameters identical to those in the Web UI filter form. Filter parameters use theORoperator.NbForagerThe 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.NbBranchExtract typed values from a Netbox object dictionary by using a chain of keys.Checked with Python >= 3.8, Netbox >= v3.6.
Fully documented onRead the Docs.QuickstartInstall the package from pypi.orgpipinstallnbforageror from github.com repositorypipinstallgit+https://github.com/vladimirs-git/nbforagerNbForager demonstration.
Assemble Netbox objects within self as a multidimensional dictionary.Request the main object. All nested objects also are requested.
Assemble multidimensional dictionary.frompprintimportpprintfromnbforagerimportNbForagerHOST="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.frompprintimportpprintfromnbforagerimportNbForager,NbBranchHOST="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.fromnbforagerimportNbApiHOST="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 addressesaddresses=nb.ipam.ip_addresses.get()print(len(addresses))# 181# Get all ip-addresses in global routingaddresses=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))# 2addresses=nb.ipam.ip_addresses.get(address="1.2.3.4/24")foraddressinaddresses:# Updateid_=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# Deleteresponse=nb.ipam.ip_addresses.delete(id=id_)print(response)# <Response [204]>