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.

Requirements

• NetBox v4.2 or later

Installation

1. Install the NetBox Custom Objects package.

pip install netboxlabs-netbox-custom-objects

2. Add netbox_custom_objects to PLUGINS in configuration.py.

PLUGINS = [
    # ...
    'netbox_custom_objects',
]

3. Run NetBox migrations:

$ ./manage.py migrate

Known Limitations

The Public Preview of NetBox Custom Objects is under active development as we proceed towards the General Availability release around NetBox 4.4. The best place to look for the latest list of known limitations is the issues list on the GitHub repository. These include features like Tags, Import/Export, Bulk Edit, Text Search and Branching.