Skip to main content

NetBox DHCP

The NetBox DHCP plugin enables NetBox to manage operational DHCP data such as servers, shared networks, subnets, pools, options and host reservations. It serves as a "source of truth" for DHCP servers, such as Kea DHCP, providing data for network automation tools that can be used to configure the DHCP infrastructure.

This works in much the same way in which NetBox provides configuration data for automatic configuration of network components, or NetBox DNS provides the input necessary to configure DNS infrastructure and zone data.

PyPi Stars Badge Forks Badge Issues Badge Pull Requests Badge GitHub contributors License Badge Code Style Ruff Downloads Downloads/Week Downloads/Month

[!WARNING] This is a beta release.

This plugin may contain bugs and cause data loss and other problems. Use caution when using it in production environments.

Frequent backups are strongly recommended!

Requirements

  • NetBox 4.5.0 or higher.
  • Python 3.12 or higher.

Installation & Configuration

Installation

$ source /opt/netbox/venv/bin/activate
(venv) $ python3 -m pip install netbox-plugin-dhcp

NetBox Configuration

Add the plugin to the NetBox configuration file /opt/netbox/netbox/netbox/configuration.py:

PLUGINS = [
    "netbox_dhcp",
]

To permanently keep the plugin installed when updating NetBox via upgrade.sh:

echo netbox-plugin-dhcp >> /opt/netbox/local_requirements.txt

To add the required tables to your database run the following command from your NetBox directory:

./manage.py migrate

Full documentation on using plugins with NetBox: Using Plugins - NetBox Documentation.

Contribute

Contributions are always welcome! Please see the Contribution Guidelines.

Documentation

There is no documentation at this point.

License

MIT

Known Issues

  • There is an issue that sometimes causes a lock conflict while running the test suite. The symptom is that the tests stop at some point and the ./manage.py test netbox_dhcp command never returns. The issue does not seem to affect normal operation, just the tests. The specific tests have been disabled for the time being until the issue is resolved.
  • Documentation is still missing.

These issues will be addressed in upcoming Beta releases.

Download files

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

Source Distribution

netbox_plugin_dhcp-0.1.11.tar.gz (70.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

netbox_plugin_dhcp-0.1.11-py3-none-any.whl (149.4 kB view details)

Uploaded Python 3

File details

Details for the file netbox_plugin_dhcp-0.1.11.tar.gz.

File metadata

  • Download URL: netbox_plugin_dhcp-0.1.11.tar.gz
  • Upload date:
  • Size: 70.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_plugin_dhcp-0.1.11.tar.gz
Algorithm Hash digest
SHA256 4332c1b8fba9bcc16d5fbd5b88708781281047e7b6cd84eb592417cab485836e
MD5 efc915b550241aa3c7f0927298916d41
BLAKE2b-256 eca8b30504872ca2af1c44abefc4bc7d6dbed9d728412dc111db9da3df144e9b

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_dhcp-0.1.11.tar.gz:

Publisher: publish.yml on sys4/netbox-plugin-dhcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file netbox_plugin_dhcp-0.1.11-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_plugin_dhcp-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 e28b4bc65115a304e8d6d349f7a63e2c3f77baded356e1dd9234785b2c0995f7
MD5 05ce9f0ec2a3c4c2799cffbbc7bb2c7d
BLAKE2b-256 2b38d79dea1467fde61b9234bdeb88672d0e83abfa0a5b035844266f11ae8f7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_dhcp-0.1.11-py3-none-any.whl:

Publisher: publish.yml on sys4/netbox-plugin-dhcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.11 This release

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.0

2 files

Supported by

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