Custom model validation exposed through plugins #3498

New Issue

adam · 2025-12-29T18:29:31+01:00

adam commented

2025-12-29 18:29:31 +01:00

Originally created by @lampwins on GitHub (Mar 21, 2020).

Environment

Python version: 2.7
NetBox version: 2.7.10

Proposed Functionality

Expose a plugin interface that allows for custom model validation to be performed when the model's clean() method is called. This interface will look similar to the plugin template content injection interface in which plugin developers specify the model they wish to act on. In this case, the class will implement only a single method validate():

class DeviceModelValidator(ModelValidator):
    model = 'dcim.device'

    def validate(self, obj):
        if obj.name == 'cat':
            raise ValidationError({
                'name': 'No cats allowed on the network!'
            })

As you can see, this method can either raise VailidationError or simply return None if the object passes validation. In the code path, these custom validators will be run at the end of the model's standard clean() method.

Use Case

As users adopt NetBox as a core component in automation solutions, data validity is key. NetBox reports can be used to highlight data consistency and integrity issues, but users must still fix these problems after the fact. By enforcing business logic rules when an object is created or updated, the chances of producing bad data are reduced.

The desire to implement custom validation has come up several times in the community before, but we have not really had a clean enough way to implement this until the plugins framework was born.

See: this comment, https://github.com/netbox-community/netbox/issues/3974, https://github.com/netbox-community/netbox/issues/3163, etc.

Database Changes

None

External Dependencies

The plugins framework introduced in 2.8.

Originally created by @lampwins on GitHub (Mar 21, 2020).  ### Environment * Python version: 2.7 * NetBox version: 2.7.10  ### Proposed Functionality Expose a plugin interface that allows for custom model validation to be performed when the model's `clean()` method is called. This interface will look similar to the plugin template content injection interface in which plugin developers specify the model they wish to act on. In this case, the class will implement only a single method `validate()`: ```python class DeviceModelValidator(ModelValidator): model = 'dcim.device' def validate(self, obj): if obj.name == 'cat': raise ValidationError({ 'name': 'No cats allowed on the network!' }) ``` As you can see, this method can either raise `VailidationError` or simply return `None` if the object passes validation. In the code path, these custom validators will be run at the end of the model's standard `clean()` method.  ### Use Case As users adopt NetBox as a core component in automation solutions, data validity is key. NetBox reports can be used to highlight data consistency and integrity issues, but users must still fix these problems after the fact. By enforcing business logic rules when an object is created or updated, the chances of producing bad data are reduced. The desire to implement custom validation has come up several times in the community before, but we have not really had a clean enough way to implement this until the plugins framework was born. See: [this comment](https://github.com/netbox-community/netbox/issues/3351#issuecomment-513122729), https://github.com/netbox-community/netbox/issues/3974, https://github.com/netbox-community/netbox/issues/3163, etc.  ### Database Changes None  ### External Dependencies The plugins framework introduced in 2.8.

adam added the type: feature topic: plugins labels 2025-12-29 18:29:31 +01:00

adam closed this issue

2025-12-29 18:29:31 +01:00

adam commented

2025-12-29 18:29:31 +01:00

@jeremystretch commented on GitHub (Mar 27, 2020):

I'm going to punt on this for the initial implementation as there's already a lot going on. Let's put a pin in this until we figure out how we're going to handle feature requests for the plugins framework after the v2.8 release.

@jeremystretch commented on GitHub (Mar 27, 2020): I'm going to punt on this for the initial implementation as there's already _a lot_ going on. Let's put a pin in this until we figure out how we're going to handle feature requests for the plugins framework after the v2.8 release.

adam commented

2025-12-29 18:29:31 +01:00

@lampwins commented on GitHub (May 5, 2020):

@jeremystretch can we pick this back up given the relatively light load of plugins related requests? I am happy to take this on.

@lampwins commented on GitHub (May 5, 2020): @jeremystretch can we pick this back up given the relatively light load of plugins related requests? I am happy to take this on.

adam commented

2025-12-29 18:29:31 +01:00

@lampwins commented on GitHub (May 13, 2020):

Blocked by #4640

@lampwins commented on GitHub (May 13, 2020): Blocked by #4640

adam commented

2025-12-29 18:29:31 +01:00

@itdependsnetworks commented on GitHub (Aug 6, 2020):

To further provide some use cases, here are a few I have noted with customers recently

Enforcing Business logic

Ensure that a hostname adheres to the internal naming standard.
Lookup to external system for new site creation, such as salesforce or similar.
Custom field verification such as "owner" on an IP address
Ensure every object is tied to a Tenant
Ensure consistency within subnetworks, e.g. only allow a /24 to be created within this /16

Many users "expect" the IPAM component to operate in a certain way. While it is clear that the base implementation cannot support that logic in order to support many more use cases, within the custom model validation you can add these capabilities.

Ensure that any network that has child networks is a "container"
Ensuring that no IP address within a container but not an active network is allowed. e.g. 10.10.0.0/16 container and only a 10.10.50.0/24 network, you should not be able to create an IP of 10.10.20.20 IP address
Ensure that IP addresses subnet mask matches up with the most specific network it is contained within

@itdependsnetworks commented on GitHub (Aug 6, 2020): To further provide some use cases, here are a few I have noted with customers recently Enforcing Business logic * Ensure that a hostname adheres to the internal naming standard. * Lookup to external system for new site creation, such as salesforce or similar. * Custom field verification such as "owner" on an IP address * Ensure every object is tied to a Tenant * Ensure consistency within subnetworks, e.g. only allow a /24 to be created within this /16 Many users "expect" the IPAM component to operate in a certain way. While it is clear that the base implementation cannot support that logic in order to support many more use cases, within the custom model validation you can add these capabilities. * Ensure that any network that has child networks is a "container" * Ensuring that no IP address within a container but not an active network is allowed. e.g. 10.10.0.0/16 container and only a 10.10.50.0/24 network, you should not be able to create an IP of 10.10.20.20 IP address * Ensure that IP addresses subnet mask matches up with the most specific network it is contained within

adam commented

2025-12-29 18:29:31 +01:00

@jeremystretch commented on GitHub (Mar 29, 2021):

Closing this in favor of #5963, since it doesn't seem practical to require users to develop an entire plugin just to enforce model validation.

@jeremystretch commented on GitHub (Mar 29, 2021): Closing this in favor of #5963, since it doesn't seem practical to require users to develop an entire plugin just to enforce model validation.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#3498