Identify devices/VMs with local config context set #5260

New Issue

adam · 2025-12-29T19:26:01+01:00

adam commented

2025-12-29 19:26:01 +01:00

Originally created by @candlerb on GitHub (Aug 31, 2021).

Originally assigned to: @jeremystretch on GitHub.

NetBox version

v2.11.12

Feature type

Change to existing functionality

Proposed functionality

A way to identify those devices and VMs which have local config context data set. Options I can think of:

In the device/VM listing, add "local_context_data" as a selectable column. However that's not great because it could contain a lot of data, although it could be truncated to the first N characters.
In the device/VM listing, add a checkbox column which indicates if "local_context_data" is not empty, similar to "Assigned" on IP addresses; and/or
In the device/VM listing, add a filter for devices with local_context_data set or not set

My preferred choice would be 3, or 2+3.

Use case

I needed to find which devices had local config context data set, and was unable to do so. They are not shown under /extras/config-contexts/ as those are only the configs which are assigned to groups.

I did wonder whether it would be possible to create a query by hand like /dcim/devices/?local_context_data__empty=0 but that doesn't appear to work, in either the GUI or the API.

In the end I was forced to do this via SQL queries:

select id,name,local_context_data from dcim_device where local_context_data is not null;
select id,name,local_context_data from virtualization_virtualmachine where local_context_data is not null;

(Aside: I also needed to remove the local_context_data from those devices, and ended up doing it one by one in the GUI as there's no option to do this on a selected subset using "Edit...". However this is a sufficiently rare requirement that this is reasonable)

Database changes

None

External dependencies

None

Originally created by @candlerb on GitHub (Aug 31, 2021). Originally assigned to: @jeremystretch on GitHub. ### NetBox version v2.11.12 ### Feature type Change to existing functionality ### Proposed functionality A way to identify those devices and VMs which have local config context data set. Options I can think of: 1. In the device/VM listing, add "local_context_data" as a selectable column. However that's not great because it could contain a lot of data, although it could be truncated to the first N characters. 2. In the device/VM listing, add a checkbox column which indicates if "local_context_data" is not empty, similar to "Assigned" on IP addresses; and/or 3. In the device/VM listing, add a filter for devices with local_context_data set or not set My preferred choice would be 3, or 2+3. ### Use case I needed to find which devices had local config context data set, and was unable to do so. They are not shown under `/extras/config-contexts/` as those are only the configs which are assigned to groups. I did wonder whether it would be possible to create a query by hand like `/dcim/devices/?local_context_data__empty=0` but that doesn't appear to work, in either the GUI or the API. In the end I was forced to do this via SQL queries: ``` select id,name,local_context_data from dcim_device where local_context_data is not null; select id,name,local_context_data from virtualization_virtualmachine where local_context_data is not null; ``` (Aside: I also needed to remove the local_context_data from those devices, and ended up doing it one by one in the GUI as there's no option to do this on a selected subset using "Edit...". However this is a sufficiently rare requirement that this is reasonable) ### Database changes None ### External dependencies None

adam added the status: accepted type: feature labels 2025-12-29 19:26:01 +01:00

adam closed this issue

2025-12-29 19:26:01 +01:00

adam commented

2025-12-29 19:26:02 +01:00

@jeremystretch commented on GitHub (Sep 16, 2021):

There's currently (as of v3.0.2) a filter for this in the device filter form; it may have been added as part of the UI overhaul in v3.0. However, it's missing for virtual machines.

@jeremystretch commented on GitHub (Sep 16, 2021): There's currently (as of v3.0.2) a filter for this in the device filter form; it may have been added as part of the UI overhaul in v3.0. However, it's missing for virtual machines.

adam commented

2025-12-29 19:26:02 +01:00

@candlerb commented on GitHub (Sep 16, 2021):

I just checked, and v2.11.12 did have the filter already (I hadn't spotted it). But it's still needed for VMs.

For reference, the query it adds is local_context_data={True|False}

@candlerb commented on GitHub (Sep 16, 2021): I just checked, and v2.11.12 did have the filter already (I hadn't spotted it). But it's still needed for VMs. For reference, the query it adds is `local_context_data={True|False}`

adam commented

2025-12-29 19:26:02 +01:00

@jeremystretch commented on GitHub (Sep 16, 2021):

Whoops, cited the wrong issue in the commit.

@jeremystretch commented on GitHub (Sep 16, 2021): Whoops, cited the wrong issue in the commit.

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