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.7.tar.gz (8.3 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: python-netbox-0.0.7.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for python-netbox-0.0.7.tar.gz
Algorithm Hash digest
SHA256 f394c30ce5384f212fe3d14735327a2c3bf5a1440ac1593374ac24b2ac589b07
MD5 535c2ccedda2161d02a2700cf3206a1e
BLAKE2b-256 4bda847d3e5d21a44f7d84c994493a1dae6f141e91123b6014e8d7b1977316ae

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