Skip to main content

NetBox Custom Objects

This NetBox plugin introduces the ability to create new object types in NetBox so that users can add models to suit their own needs. NetBox users have been able to extend the NetBox data model for some time using both Tags & Custom Fields and Plugins. Tags and Custom Fields are easy to use, but they have limitations when used at scale, and Plugins are very powerful but require Python/Django knowledge, and ongoing maintenance. Custom Objects provides users with a no-code "sweet spot" for data model extensibility, providing a lot of the power of NetBox plugins, but with the ease of use of Tags and Custom Fields.

You can find further documentation here. See the compatibility matrix for supported NetBox versions.

Installation

  1. Install the NetBox Custom Objects package.
pip install netboxlabs-netbox-custom-objects
  1. Add netbox_custom_objects to PLUGINS in configuration.py.
PLUGINS = [
    # ...
    'netbox_custom_objects',
]
  1. Run NetBox migrations and collect static files:
$ ./manage.py migrate
$ ./manage.py collectstatic
  1. Restart NetBox
sudo systemctl restart netbox netbox-rq

Known Limitations

NetBox Custom Objects is now Generally Available which means you can use it in production and migrations to future versions will work. There are many upcoming features including GraphQL support - the best place to see what's on the way is the issues list on the GitHub repository.

Download files

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

Source Distribution

netboxlabs_netbox_custom_objects-0.6.1.tar.gz (1.0 MB view details)

Uploaded Source

Built Distribution

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

File details

Details for the file netboxlabs_netbox_custom_objects-0.6.1.tar.gz.

File metadata

File hashes

Hashes for netboxlabs_netbox_custom_objects-0.6.1.tar.gz
Algorithm Hash digest
SHA256 7e5f7eb90242ce29666d891559d1fc1204d0a087894071b70531e131b9b1beb7
MD5 53dec5260940b9b1d1021879fb1fabef
BLAKE2b-256 e4faf0f83d7e8340093b303990693944e9b3bfa9b596cd950b19c240b1929ad5

See more details on using hashes here.

Provenance

The following attestation bundles were made for netboxlabs_netbox_custom_objects-0.6.1.tar.gz:

Publisher: release.yaml on netboxlabs/netbox-custom-objects

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

File details

Details for the file netboxlabs_netbox_custom_objects-0.6.1-py3-none-any.whl.

File metadata

File hashes

Hashes for netboxlabs_netbox_custom_objects-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e096afe3a8d6b13cba58b036abb0ee5ed7e428b9cfdc87c910e27c19db226f36
MD5 21a7497e8baa824b309a53e306086e95
BLAKE2b-256 0eeb45c05e4e2d5037f9f622893e919e72bef331776669c38620901b84f475cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for netboxlabs_netbox_custom_objects-0.6.1-py3-none-any.whl:

Publisher: release.yaml on netboxlabs/netbox-custom-objects

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.6.1 This release

2 files

0.6.0

2 files

0.5.3

2 files

0.5.2

2 files

0.5.1

2 files

0.5.0

2 files

0.4.10

2 files

0.4.9

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

0.4.4

2 files

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.2.0

2 files

0.1.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