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 -e git+https://github.com/jagter/python-netbox.git#egg=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.6.tar.gz (8.2 kB view details)

Uploaded Source

File details

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

File metadata

File hashes

Hashes for python-netbox-0.0.6.tar.gz
Algorithm Hash digest
SHA256 becd0dc523f40374fde392a58d0566154ca8268b0cd53e761f633872110ef56b
MD5 1ea5324e71d6f2c0c154ecea88dfdb27
BLAKE2b-256 bfba893198d2bec6b5b89d28444791bfe7c7ae480a5a0e8d296492bcedfc920c

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