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

Include Tags in the global search. #10045

New Issue
Closed
opened 2025-12-29 21:26:09 +01:00 by adam · 4 comments
adam commented 2025-12-29 21:26:09 +01:00
Owner
Copy Link

Originally created by @Chiniquy on GitHub (Aug 2, 2024).

Originally assigned to: @pheus on GitHub.

NetBox version

v4.0.7

Feature type

Data model extension

Proposed functionality

I propose that Tags are included in the global search function.

#16147 mentions this but it seems like a feature request was never opened.

Use case

Users may decide to use Tags to document certain aspects of their environment that does not fit into existing fields in Netbox, or if they consider Tags to be more apt for their specific use case. As an example, we use the Tag "Out of Band" on both devices and circuits that are used for out of band management.

Netbox has many ways to document ones environment, and it is difficult for users to remember exactly how everything is documented, so often times the global search will be the first step to find relevant documentation. In this case, a user would search for "OoB" or "Out of Band" and find 0 results in the global search, despite the fact that we have a tag called "Out of Band" and have several devices and circuits with this tag. Allowing Tags to be searchable would allow users to find where and how things are documented much quicker.

Database changes

I don't think any database changes are necessary here?

External dependencies

I am not aware of any new external dependencies.

Originally created by @Chiniquy on GitHub (Aug 2, 2024). Originally assigned to: @pheus on GitHub. ### NetBox version v4.0.7 ### Feature type Data model extension ### Proposed functionality I propose that Tags are included in the global search function. #16147 mentions this but it seems like a feature request was never opened. ### Use case Users may decide to use Tags to document certain aspects of their environment that does not fit into existing fields in Netbox, or if they consider Tags to be more apt for their specific use case. As an example, we use the Tag "Out of Band" on both devices and circuits that are used for out of band management. Netbox has many ways to document ones environment, and it is difficult for users to remember exactly how everything is documented, so often times the global search will be the first step to find relevant documentation. In this case, a user would search for "OoB" or "Out of Band" and find 0 results in the global search, despite the fact that we have a tag called "Out of Band" and have several devices and circuits with this tag. Allowing Tags to be searchable would allow users to find where and how things are documented much quicker. ### Database changes I don't think any database changes are necessary here? ### External dependencies I am not aware of any new external dependencies.
adam added the status: acceptedtype: featurenetboxcomplexity: low labels 2025-12-29 21:26:09 +01:00
adam closed this issue 2025-12-29 21:26:09 +01:00
adam commented 2025-12-29 21:26:10 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Apr 25, 2025):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (Apr 25, 2025): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/main/CONTRIBUTING.md).
adam commented 2025-12-29 21:26:10 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Apr 29, 2025):

Quick question for the maintainers: the request here seems to suggest that searching for a tag name (like "Out of Band") should return all objects tagged with it—not just the tag itself.

Given the guidance in PR #19161 that related objects shouldn't be included in global search results, would that kind of behavior go against current design direction?

On a related note, making the tag name, slug, and description searchable seems like a simple and reasonable improvement - just wanted to confirm where the line is drawn.

@pheus commented on GitHub (Apr 29, 2025): Quick question for the maintainers: the request here seems to suggest that searching for a tag name (like "Out of Band") should return all objects tagged with it—not just the tag itself. Given the guidance in PR [#19161](https://github.com/netbox-community/netbox/pull/19161) that related objects shouldn't be included in global search results, would that kind of behavior go against current design direction? On a related note, making the tag name, slug, and description searchable seems like a simple and reasonable improvement - just wanted to confirm where the line is drawn.
adam commented 2025-12-29 21:26:11 +01:00
Author
Owner
Copy Link

@Chiniquy commented on GitHub (Apr 30, 2025):

Simply returning the tag would be good enough for my use case at least. Then I would just click the tag and view the related objects.

@Chiniquy commented on GitHub (Apr 30, 2025): Simply returning the tag would be good enough for my use case at least. Then I would just click the tag and view the related objects.
adam commented 2025-12-29 21:26:11 +01:00
Author
Owner
Copy Link

@pheus commented on GitHub (Apr 30, 2025):

Thank you for the clarification!
In that case, I’d be happy to contribute this feature. Could it be assigned to me?

@pheus commented on GitHub (Apr 30, 2025): Thank you for the clarification! In that case, I’d be happy to contribute this feature. Could it be assigned to me?
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 complexity: low netbox status: accepted type: feature
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#10045
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?