Pre-release

This release is a pre-release and may not be stable for production use.

NetBox DNS

The NetBox DNS plugin enables NetBox to manage operational DNS data such as name servers, zones, records and views, as well as registration data for domains. It can automate tasks like creating PTR records, generating zone serial numbers, NS and SOA records, as well as validate names and values values for resource records to ensure zone data is consistent, up-to-date and compliant with to the relevant RFCs.

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 including support for the NetBox Branching plugin. Please test it with Branching, but don't use it in production and make sure you have a backup available. ** ** Really. Do have a backup! **

Objectives

NetBox DNS is designed to be the 'DNS Source of Truth' analogous to NetBox being the 'Network Source of Truth'.

The plugin stores information about DNS name servers, DNS views and zones, and DNS records, making it a data source for automatic provisioning of DNS instances. Registration information about DNS registrars and contacts for DNS domains can also be stored and associated with zones.

The main focus of the plugin is to ensure the quality of the data stored in it. To achieve this, there are many validation and automation mechanisms in place:

  • Validation of record names and values
  • Automatic maintenance of PTR records for IPv6 and IPv4 address records
  • Automatic generation of SOA records, optionally including the serial number of the zone data
  • Validation of changes to the SOA SERIAL number, whether they are done automatically or manually
  • Validation of record types such as CNAME and singletons, to ensure DNS zone validity
  • Support for RFC 2317 delegation of PTR zones for IPv4 subnets longer than 24 bits
  • Templating for zones and records enables faster creations of zones with given boilerplate object relations, such as name servers, tags, tenants or registration information, or records like standard SPF or MX records that are the same for a subset of zones
  • IPAM DNSsync can be used to automatically create address and pointer records for IP addresses by assigning prefixes to DNS views. When an IP address has a DNS name assigned and there are zones with matching names in the DNS views linked to the IP address' prefix, a matching DNS record will be created in these zones
  • DNSSEC support for storing configuration data relevant to DNSSEC operation in NetBox DNS
  • Beta support for the NetBox Branching plugin by contribution from @arthanson

Other main features include:

  • Support for BIND views, providing lightweight namespaces for zones
  • Support for IDN, including the validation of punycode names
  • Full support for the NetBox REST and GraphQL APIs
  • Support for all major NetBox features such as global search, tenancy, change logs, tagging, journaling etc.

Non-objectives

In the same way as NetBox is not a network management application, NetBox DNS does not provide any functionality to manage specific name servers or DNS service providers or to generate input such as configuration and zone files for them. The focus is on the completeness and integrity of the data needed to run DNS zones, not on the peculiarities of a plethora of servers and services that actually use the data. This functionality is left to specialized integration tools, or in many cases it can be easily implemented using Ansible or similar tools based on NetBox DNS data. Example code for some simple use cases is provided.

For integration with a large number of DNS server implementations integration tools like octodns-netbox-dns are available.

For RFC9432 compatible DNS Servers like BIND, a related plugin netbox-plugin-bind-provisioner provides direct integration using DNS native zone distribution.

Requirements

  • NetBox 4.5.0 or higher
  • Python 3.12 or higher

Compatibility with NetBox Versions

NetBox Version NetBox DNS Version Comment
3.5 0.22
3.6 0.22
3.7 0.22
4.0 - 4.1 1.0 Supports legacy IPAM Coupling
4.0 - 4.1 1.1 Supports IPAM DNSsync
4.2 1.2
4.3 1.3 - 1.4
4.4 1.4
4.5 1.5

Installation & Configuration

Installation

$ source /opt/netbox/venv/bin/activate
(venv) $ pip install netbox-plugin-dns

NetBox Configuration

Add the plugin to the NetBox config. ~/netbox/configuration.py

PLUGINS = [
    "netbox_dns",
]

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

echo netbox-plugin-dns >> ~/netbox/local_requirements.txt

To add the required netbox_dns 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

For further information, please refer to the full documentation: Using NetBox DNS

License

MIT

Project links

Data verified by PyPI on Aug 4, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.6.0)

Owner

PyPI data
Data sourced directly from PyPI's database.

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for netboxlabs-publisher from gravatar.com netboxlabs-publisher Avatar for peteeckel from gravatar.com peteeckel

Credits

Author: Peter Eckel

GitHub Statistics

Data verified by PyPI on Aug 4, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

Requires

Python >=3.12

Tags

netbox netbox-plugin dns

Classifiers

Report project as malware

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_dns-1.6b3.tar.gz (152.9 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_dns-1.6b3-py3-none-any.whl (237.4 kB view details)

Uploaded Python 3

File details

Details for the file netbox_plugin_dns-1.6b3.tar.gz.

File metadata

  • Download URL: netbox_plugin_dns-1.6b3.tar.gz
  • Upload date:
  • Size: 152.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for netbox_plugin_dns-1.6b3.tar.gz
Algorithm Hash digest
SHA256 d0a7151bbf0d0e169fda10d82e850bcd03d531f494d19c4bc21d56a1fbbae24b
MD5 4b82bbf1629933928e06c90b362b2c73
BLAKE2b-256 9b011a99a91be562f4d42b6eb1536e34cf235cb01918e1a678537bb483dc76b4

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_dns-1.6b3.tar.gz:

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

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_dns-1.6b3-py3-none-any.whl.

File metadata

File hashes

Hashes for netbox_plugin_dns-1.6b3-py3-none-any.whl
Algorithm Hash digest
SHA256 45cc6903084539814f7cb6a600a0ddfa45a4ec6fdf7e49d6ec3148709ea22702
MD5 509e7a39df60d81e8edb9e3c324c0210
BLAKE2b-256 e970df6a0e1331c21368691531aa8daa6735ed094db7a092ba332a34be84986b

See more details on using hashes here.

Provenance

The following attestation bundles were made for netbox_plugin_dns-1.6b3-py3-none-any.whl:

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

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

Release history Release notifications | RSS feed

Pre-release

1.7b1

2 files

1.6.0

2 files

This release
Pre-release

1.6b3 This release

2 files

Pre-release

1.6b2

2 files

1.5.12

2 files

1.5.11

2 files

1.5.10

2 files

1.5.9

2 files

1.5.8

2 files

1.5.7

2 files

1.5.6

2 files

1.5.5

2 files

1.5.4

2 files

1.5.3

2 files

1.5.2

2 files

1.5.1

2 files

1.5.0

2 files

Pre-release

1.5.0b1

2 files

1.4.8

2 files

1.4.7

2 files

1.4.6

2 files

1.4.5

2 files

1.4.4

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.6

2 files

1.3.5

2 files

1.3.4

2 files

1.3.3

2 files

1.3.2

2 files

1.3.1

2 files

1.3.0

2 files

Pre-release

1.3b2

2 files

Pre-release

1.3b1

2 files

1.2.14

2 files

1.2.13

2 files

1.2.12

2 files

1.2.11

2 files

1.2.10

2 files

1.2.9

2 files

Yanked

1.2.8

2 files

Yanked reason: Severe error in the data model

1.2.7

2 files

Pre-release

1.2.7b3

2 files

Pre-release

1.2.7b2

2 files

1.2.6

2 files

1.2.5

2 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2.0

2 files

Pre-release

1.2b1

2 files

1.1.7

2 files

1.1.6

2 files

1.1.5

2 files

1.1.4

2 files

1.1.3

2 files

1.1.2

2 files

1.1.1

2 files

1.1.0

2 files

Pre-release

1.1.0b7

2 files

Pre-release

1.1.0b6

2 files

Pre-release

1.1.0b5

2 files

Pre-release

1.1.0b4

2 files

Pre-release

1.1b3

2 files

Pre-release

1.1.0b2

2 files

Pre-release

1.1.0b1

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Yanked

1.0b2

2 files

Yanked reason: Beta Release has expired

Yanked

1.0b1

2 files

Yanked reason: Beta Release has expired

0.22.9

2 files

0.22.8

2 files

0.22.6

2 files

0.22.5

2 files

0.22.4

2 files

0.22.3

2 files

0.22.2

2 files

0.22.1

2 files

0.22.0

2 files

0.21.17

2 files

0.21.16

2 files

0.21.15

2 files

0.21.14

2 files

0.21.13

2 files

0.21.12

2 files

0.21.11

1 file

0.21.9

2 files

0.21.8

2 files

0.21.7

2 files

0.21.6

2 files

0.21.4

2 files

0.21.3

2 files

0.21.2

2 files

0.21.0

2 files

0.20.2

2 files

0.20.1

1 file

0.20.0

2 files

0.19.4

2 files

0.19.3

2 files

0.19.2

2 files

0.19.1

2 files

0.19.0

2 files

0.18.10

2 files

0.18.9

2 files

0.18.8

2 files

0.18.7

2 files

0.18.6

2 files

0.18.5

2 files

0.18.4

2 files

0.18.3

2 files

0.18.2

2 files

0.18.1

2 files

0.18.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page