Skip to main content

NetBox API client library

Project description

Pynetbox

Python API client library for NetBox.

Note: Version 6.7 and later of the library only supports NetBox 3.3 and above.

Compatibility

Each pyNetBox Version listed below has been tested with its corresponding NetBox Version.

NetBox Version Plugin Version
4.3 7.5.0
4.2 7.5.0
4.1 7.5.0
4.0.6 7.4.1
4.0.0 7.3.4
3.7 7.3.0
3.6 7.2.0
3.5 7.1.0
3.3 7.0.0

Installation

To install run pip install pynetbox.

Alternatively, you can clone the repo and run python setup.py install.

Quick Start

The full pynetbox API is documented on Read the Docs, but the following should be enough to get started using it.

To begin, import pynetbox and instantiate the API.

import pynetbox
nb = pynetbox.api(
    'http://localhost:8000',
    token='d6f4e314a5b5fefd164995169f28ae32d987704f'
)

The first argument the .api() method takes is the NetBox URL. There are a handful of named arguments you can provide, but in most cases none are required to simply pull data. In order to write, the token argument should to be provided.

Queries

The pynetbox API is setup so that NetBox's apps are attributes of the .api() object, and in turn those apps have attribute representing each endpoint. Each endpoint has a handful of methods available to carry out actions on the endpoint. For example, in order to query all the objects in the devices endpoint you would do the following:

>>> devices = nb.dcim.devices.all()
>>> for device in devices:
...     print(device.name)
...
test1-leaf1
test1-leaf2
test1-leaf3
>>>

Note that the all() and filter() methods are generators and return an object that can be iterated over only once. If you are going to be iterating over it repeatedly you need to either call the all() method again, or encapsulate the results in a list object like this:

>>> devices = list(nb.dcim.devices.all())

Threading

pynetbox supports multithreaded calls for .filter() and .all() queries. It is highly recommended you have MAX_PAGE_SIZE in your Netbox install set to anything except 0 or None. The default value of 1000 is usually a good value to use. To enable threading, add threading=True parameter to the .api:

nb = pynetbox.api(
    'http://localhost:8000',
    threading=True,
)

Running Tests

First, create and activate a Python virtual environment in the pynetbox directory to isolate the project dependencies:

python3 -m venv venv
source venv/bin/activate

Install both requirements files:

pip install -r requirements.txt
pip install -r requirements-dev.txt

The test suite requires Docker to be installed and running, as it will download and launch netbox-docker containers during test execution.

With Docker installed and running, execute the following command to run the test suite:

pytest

Alternative Library

Note: For those interested in a different approach, there is an alternative Python API client library available for NetBox called netbox-python. This library provides a thin Python wrapper over the NetBox API.

netbox-python offers a minimalistic interface to interact with NetBox's API. While it may not provide all the features available in pynetbox, it offers a lightweight and straightforward option for interfacing with NetBox.

To explore further details and access the documentation, please visit the netbox-python.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pynetbox-7.5.0.tar.gz (73.8 kB view details)

Uploaded Source

Built Distribution

pynetbox-7.5.0-py3-none-any.whl (35.8 kB view details)

Uploaded Python 3

File details

Details for the file pynetbox-7.5.0.tar.gz.

File metadata

  • Download URL: pynetbox-7.5.0.tar.gz
  • Upload date:
  • Size: 73.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for pynetbox-7.5.0.tar.gz
Algorithm Hash digest
SHA256 780064c800fb8c079c9828df472203146442ed3dd0b522a28a501204eb00c066
MD5 44f15fd6969348d3f185fb8b0fe994c7
BLAKE2b-256 d30b695021a23c373991d07c1e4cb510287a521318cfc4b29f68ebbecb19fcd2

See more details on using hashes here.

File details

Details for the file pynetbox-7.5.0-py3-none-any.whl.

File metadata

  • Download URL: pynetbox-7.5.0-py3-none-any.whl
  • Upload date:
  • Size: 35.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for pynetbox-7.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ab755a0020c0abb09b4d24c8f8ba89df26f04fa56c35de73302e29a39352f031
MD5 693a7da3f871e2bef721027edb739e51
BLAKE2b-256 44b7a24bc58f0e27f0cd847bf14ffbe9722604f5abe3ec9c12dd8f89cb965be8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page