Skip to main content

Python NetBox Client

Project description

python-netbox is a client for the Netbox (https://github.com/digitalocean/netbox) API. It’s based on the APIv2 which is released since version 2.0.0.

The full documentation can be found here.

Installation

To get the latest version from Github:

$ pip install python-netbox

Usage

To start with the module:

>>> from netbox import NetBox
>>> netbox = NetBox(host='127.0.0.1', port=32768, use_ssl=False, auth_token='token')

Examples

Get all devices:

>>> netbox.dcim.get_devices()

Get devices per rack:

>>> netbox.dcim.get_devices_per_rack('rack_name')

Get device by name

>>> netbox.dcim.get_devices(name='device_name')

Create a site:

>>> netbox.dcim.create_site('site1', 'site1')

Delete a site:

>>> netbox.dcim.delete_site('site1')

Get IP address object:

>>> netbox.ipam.get_ip(device='device_name', interface_id=interface_id)

Support

If you have questions or comments please send an email to thomas@tjrb.nl

Project details


Download files

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

Source Distribution

python-netbox-0.0.10.tar.gz (8.8 kB view details)

Uploaded Source

File details

Details for the file python-netbox-0.0.10.tar.gz.

File metadata

File hashes

Hashes for python-netbox-0.0.10.tar.gz
Algorithm Hash digest
SHA256 d05453b3c8347c14beac9e5140d288e3426bf07be1458cdc100a94b3c1b1ca87
MD5 8ebb49c2a748ff111aaabac78eab4e57
BLAKE2b-256 9ce4547ef8668df4dac17e924a16233d110e8fdd1f59fc0812b30d3111b8c063

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