Allow customization of queryset get_for_* functions #1385

New Issue

MrUnknownDE · 2026-04-06T00:29:29+02:00

MrUnknownDE commented

2026-04-06 00:29:29 +02:00

Originally created by @Omripresent on 8/26/2025

NetBox version

v4.1.11

Feature type

New functionality

Proposed functionality

Netbox has an opinionated way of scoping VLAN to devices/VMs when done by locations, site groups, and regions, forcing the location and its ancestors VLAN groups to be assignable to a given device/VM.

I would be useful for some deployments to allow customization of that functionality by allowing admins to define their desired logic with functions in extras.py that if set can override the builtin get_for_* functions in the relevant querysets.

Our current workaround is to customize the docker image by replacing the querysets.py files where needed, this workaround comes at the cost of comparing the modified files on every upgrade to avoid using old code in other parts of the file.

Use case

Use case 1 - Parent location sees all:

There are times when devices in a given location can be assigned VLANs associated with all descendant locations

if device.location:
    q |= Q(
        scope_type=ContentType.objects.get_by_natural_key('dcim', 'location'),
        scope_id__in=device.location.get_descendants(include_self=True)
    )

Use case 2 - Isolated locations:

In some cases admins might need to make sure locations are fully isolated and would need to match the exclusive location alone and no other VLANs

if device.location:
    q |= Q(
        scope_type=ContentType.objects.get_by_natural_key('dcim', 'location'),
        scope_id=device.location
    )

Database changes

N/A

External dependencies

N/A

*Originally created by @Omripresent on 8/26/2025* ### NetBox version v4.1.11 ### Feature type New functionality ### Proposed functionality Netbox has an opinionated way of scoping VLAN to devices/VMs when done by locations, site groups, and regions, forcing the location and its ancestors VLAN groups to be assignable to a given device/VM. I would be useful for some deployments to allow customization of that functionality by allowing admins to define their desired logic with functions in extras.py that if set can override the builtin get_for_* functions in the relevant querysets. Our current workaround is to customize the docker image by replacing the querysets.py files where needed, this workaround comes at the cost of comparing the modified files on every upgrade to avoid using old code in other parts of the file. ### Use case ### Use case 1 - Parent location sees all: There are times when devices in a given location can be assigned VLANs associated with all descendant locations ```python if device.location: q |= Q( scope_type=ContentType.objects.get_by_natural_key('dcim', 'location'), scope_id__in=device.location.get_descendants(include_self=True) ) ``` ### Use case 2 - Isolated locations: In some cases admins might need to make sure locations are fully isolated and would need to match the exclusive location alone and no other VLANs ```python if device.location: q |= Q( scope_type=ContentType.objects.get_by_natural_key('dcim', 'location'), scope_id=device.location ) ``` ### Database changes N/A ### External dependencies N/A

MrUnknownDE closed this issue

2026-04-06 00:29:29 +02:00

Sign in to join this conversation.

Branches Tags

main

21455-sql-indexes-audit

21357-register-model-actions

feature

20924-plugin-ui-components

21766-improve-test-coverage-for-sortable-table-columns

21157-export-template-public-models

21025-pre-render-config-contexts

21364-swagger

feature-ip-prefix-link

20911-dropdown-3

fix_module_substitution

21160-filterset

20911-dropdown-2

20044-elevation-stuck-lightmode

7604-filter-modifiers-v3

20660-script-load

19724-graphql

14884-script

19720-macaddress-interface-generic-relation

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

No Label type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature type: feature

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github/netbox#1385