Add fields to restrict visibility/creation of custom fields #3852

New Issue

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

adam commented

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

Originally created by @shane-davidson on GitHub (Jul 10, 2020).

Environment

Python version: 3.8.2
NetBox version: 2.8

Proposed Functionality

Adding an option in custom fields to restrict the custom field visibility based on the model fields equality a specific value.

class CustomField(models.Model):

    restrict= models.CharField(
        default=None,
       choices= "custom choice set showing fields available for filtering"
        help_text='Model field used to restrict visibility of this custom field.'
    )

    restrict_value= models.CharField(
        blank=True,
        help_text='Value to match when restrict field is set'
    )

    restrict_negate= models.BooleanField(
        blank=True,
        help_text='Negates restriction match'
    )

when creating a custom field you have the option to select a field and a value to match.
This field and value will decide if the custom field is visible or not.

Use Case

Create a role for a virtual machine called "app server"
Create a custom field you only want visible on virtual machine with the "app server" role

restrict = "role.name"
restrict_value = "app server"

Create a role for a virtual machine called "database server"
Create a custom field you only want visible on virtual machine with the "database server" role

restrict = "role.name"
restrict_value = "database server"

Create a device with type "Cisco Router"
Create a custom field on device

restrict = "device_type.manufacturer.name"
restrict_value = "Cisco"

OR

restrict = "device_type.manufacturer.model"
restrict_value = "Cisco Router XXX"

Other considerations:

Optional negate on the restriction.
Setting for if new 'restrict' field doesn't match any model field to show or hide the custom fields

Database Changes

New fields on CustomField

External Dependencies

None

Originally created by @shane-davidson on GitHub (Jul 10, 2020). ### Environment * Python version: 3.8.2 * NetBox version: 2.8 ### Proposed Functionality Adding an option in custom fields to restrict the custom field visibility based on the model fields equality a specific value. ``` class CustomField(models.Model): restrict= models.CharField( default=None, choices= "custom choice set showing fields available for filtering" help_text='Model field used to restrict visibility of this custom field.' ) restrict_value= models.CharField( blank=True, help_text='Value to match when restrict field is set' ) restrict_negate= models.BooleanField( blank=True, help_text='Negates restriction match' ) ``` when creating a custom field you have the option to select a field and a value to match. This field and value will decide if the custom field is visible or not. ### Use Case Create a role for a virtual machine called "app server" Create a custom field you only want visible on virtual machine with the "app server" role ``` restrict = "role.name" restrict_value = "app server" ``` Create a role for a virtual machine called "database server" Create a custom field you only want visible on virtual machine with the "database server" role ``` restrict = "role.name" restrict_value = "database server" ``` Create a device with type "Cisco Router" Create a custom field on device ``` restrict = "device_type.manufacturer.name" restrict_value = "Cisco" ``` OR ``` restrict = "device_type.manufacturer.model" restrict_value = "Cisco Router XXX" ``` Other considerations: - Optional negate on the restriction. - Setting for if new 'restrict' field doesn't match any model field to show or hide the custom fields ### Database Changes New fields on CustomField ### External Dependencies None

adam closed this issue

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

adam commented

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

@jeremystretch commented on GitHub (Jul 10, 2020):

We are not currently accepting feature requests for development related to custom fields.

@jeremystretch commented on GitHub (Jul 10, 2020): We are not currently accepting feature requests for development related to custom fields.

adam commented

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

@jeremystretch commented on GitHub (Jul 22, 2020):

Please see #4878

@jeremystretch commented on GitHub (Jul 22, 2020): Please see #4878

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#3852