starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Tag filtering in custom scripts not working #4055

New Issue
Closed
opened 2025-12-29 18:32:52 +01:00 by adam · 3 comments
adam commented 2025-12-29 18:32:52 +01:00
Owner
Copy Link

Originally created by @Kircheneer on GitHub (Sep 1, 2020).

Environment

  • Python version: 3.7.9
  • NetBox version: 2.9.2

Steps to Reproduce

  1. Create any number of Prefixes with a specific tag (for this example it will be 'auto_assign' with id 9)
  2. Create a custom Script with a ObjectVar for a Prefix field:
prefix = ObjectVar(
    queryset=Prefix.objects.filter(tags__name='auto_assign'),  # Works fine in nbshell  
    display_field='prefix'
)
  1. View the custom script field in the GUI

Expected Behavior

The queryset filters to display only those prefixes that have this specific tag

Observed Behavior

All prefixes were shown.

Originally created by @Kircheneer on GitHub (Sep 1, 2020). ### Environment * Python version: 3.7.9 * NetBox version: 2.9.2 ### Steps to Reproduce 1. Create any number of Prefixes with a specific tag (for this example it will be 'auto_assign' with id 9) 2. Create a custom Script with a ObjectVar for a Prefix field: ``` prefix = ObjectVar( queryset=Prefix.objects.filter(tags__name='auto_assign'), # Works fine in nbshell display_field='prefix' ) ``` 3. View the custom script field in the GUI ### Expected Behavior The queryset filters to display only those prefixes that have this specific tag ### Observed Behavior All prefixes were shown.
adam closed this issue 2025-12-29 18:32:52 +01:00
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 1, 2020):

Please see the ObjectVar documentation for the correct way to implement the desired behavior on NetBox v2.9.

@jeremystretch commented on GitHub (Sep 1, 2020): Please see the [ObjectVar documentation](https://netbox.readthedocs.io/en/stable/additional-features/custom-scripts/#objectvar) for the correct way to implement the desired behavior on NetBox v2.9.
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@Kircheneer commented on GitHub (Sep 1, 2020):

Sorry, forgot to mention I tried that, too:

prefix = ObjectVar(
    model=Prefix,
    display_field='prefix',
    query_params={
        'tags__name': 'auto_assign'
    }
)

This returns all prefixes - unfiltered - too. I also tried it with query_params={'tags': 9} which lead to the same result (9 being the id of the 'auto_assign' tag.

@Kircheneer commented on GitHub (Sep 1, 2020): Sorry, forgot to mention I tried that, too: ``` prefix = ObjectVar( model=Prefix, display_field='prefix', query_params={ 'tags__name': 'auto_assign' } ) ``` This returns all prefixes - unfiltered - too. I also tried it with `query_params={'tags': 9}` which lead to the same result (9 being the id of the 'auto_assign' tag.
adam commented 2025-12-29 18:32:53 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Sep 1, 2020):

query_params appends query parameters to the URL used when making an API request for the objects. It uses the same format as when filtering a list of objects in the web UI. Try that first, then check the resulting URL to determine what parameters need to be applied.

@jeremystretch commented on GitHub (Sep 1, 2020): `query_params` appends query parameters to the URL used when making an API request for the objects. It uses the same format as when filtering a list of objects in the web UI. Try that first, then check the resulting URL to determine what parameters need to be applied.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#4055
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?