Nautobot API client library
Project description
Pynautobot
Python API client library for Nautobot.
Pynautobot was initially developed as a fork of pynetbox. Pynetbox was originally developed by Zach Moody at DigitalOcean and the NetBox Community.
The complete documentation for pynautobot can be found at Read the Docs.
Questions? Comments? Join us in the #nautobot Slack channel on Network to Code!
Installation
You can install via pip or poetry
Using pip
$ pip install pynautobot
...
Using poetry
$ git clone https://github.com/nautobot/pynautobot.git
...
$ pip install poetry
...
$ poetry shell
Virtual environment already activated: /home/user/pynautobot/.venv
$ poetry install
...
Quick Start
A short introduction is provided here; the full documention for pynautobot is at Read the Docs.
To begin, import pynautobot and instantiate an Api
object, passing the url
and token
.
import pynautobot
nautobot = pynautobot.api(
url="http://localhost:8000",
token="d6f4e314a5b5fefd164995169f28ae32d987704f",
)
The Api object provides access to the Apps in Nautobot.
The Apps provide access to the Models and the field data stored in Nautobot.
Pynautobot uses the Endpoint
class to represent Models.
For example, here is how to access Devices stored in Nautobot:
devices = nautobot.dcim.devices
devices
<pynautobot.core.endpoint.Endpoint object at 0x7fe801e62fa0>
Queries
Pynautobot provides several ways to retrieve objects from Nautobot.
Only the get()
method is show here.
To continue from the example above, the Endpoint
object returned will be used to get
the device named hq-access-01.
switch = devices.get(nam="hq-access-01")
The object returned from the get()
method is an implementation of the Record
class.
This object provides access to the field data from Nautobot.
switch.id
'6929b68d-8f87-4470-8377-e7fdc933a2bb'
switch.name
'hq-access-01'
switch.site
hq
Threading
Pynautobot supports multithreaded calls for .filter()
and .all()
queries. It is highly recommended you have MAX_PAGE_SIZE
in your Nautobot 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 when instantiating the Api
object:
nautobot = pynautobot.api(
url="http://localhost:8000",
token="d6f4e314a5b5fefd164995169f28ae32d987704f",
threading=True,
)
Related projects
Please see our wiki for a list of relevant community projects.
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
Built Distribution
Hashes for pynautobot-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19dd6fbb4663440f0d890137ff58dd5206cb4452f885f3eba7874888ca22727d |
|
MD5 | 2a110c130a227cd268ecd409ca721345 |
|
BLAKE2b-256 | 1991d602cb4155a99fc3f36d0f2c1b37620993711f94cffeb7b026ef2c9baa48 |