netbox-windows-dhcp

A NetBox plugin that connects NetBox to Windows DHCP Server through PowerShell Universal (PSU). It keeps DHCP scopes, options, exclusions, reservations and leases in step between NetBox and your DHCP servers, in whichever direction you choose.

What it does

• Brings your DHCP servers into NetBox. Import failovers, scopes, option values and exclusion ranges from a live server, then keep them up to date with a scheduled sync.
• Tracks leases and reservations as NetBox IP Addresses, with status, DNS name, client MAC and lease details, and cleans up the ones the server no longer has.
• Lets you choose the source of truth. With the push settings on, NetBox wins and changes are pushed to the DHCP servers, most of them right away. With them off, the DHCP servers win and NetBox mirrors them.
• Handles failover pairs: changes go to the primary and are replicated to the partner. If the primary is down, the sync reads through the secondary.
• Protects what you choose: a tag keeps IPs (or whole prefixes) out of the sync's reach, and maintenance mode pauses a server, failover or scope.
• Keeps you out of trouble: edits the next sync would undo are refused, and a failed read from a server never deletes anything.
• Runs everything as background jobs, recorded in NetBox's changelog and able to fire NetBox event rules.
• Full REST API for all plugin objects.

Requirements

NetBox 4.5 or 4.6, Python 3.12 or later, and a licensed PowerShell Universal install on each Windows DHCP server. See Requirements for the details.

Quick start

pip install netbox-windows-dhcp

Add 'netbox_windows_dhcp' to PLUGINS in configuration.py, run python manage.py migrate, and restart NetBox and its RQ workers. Then set up PSU on each DHCP server and import your first server; the Installation guide walks through every step.

Documentation

Testing

The plugin ships an offline Django test suite (no DHCP server, PSU or network needed). Run it from the NetBox install directory:

python manage.py test netbox_windows_dhcp --keepdb

License

Released under the GNU General Public License v3.0 (or later). See LICENSE.