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

Expand search to description and comment fields #267

New Issue
Closed
opened 2025-12-29 16:20:20 +01:00 by adam · 9 comments
adam commented 2025-12-29 16:20:20 +01:00
Owner
Copy Link

Originally created by @JosephRPalmer on GitHub (Jul 21, 2016).

It would be great if IPs were searchable by description for implementations with large numbers of IP addresses.

Originally created by @JosephRPalmer on GitHub (Jul 21, 2016). It would be great if IPs were searchable by description for implementations with large numbers of IP addresses.
adam added the type: feature label 2025-12-29 16:20:20 +01:00
adam closed this issue 2025-12-29 16:20:21 +01:00
adam commented 2025-12-29 16:20:21 +01:00
Author
Owner
Copy Link

@ryanmerolle commented on GitHub (Jul 21, 2016):

This probably ties int #166

@ryanmerolle commented on GitHub (Jul 21, 2016): This probably ties int #166
adam commented 2025-12-29 16:20:21 +01:00
Author
Owner
Copy Link

@farewelldave commented on GitHub (Jul 21, 2016):

Yes, this would be great!

@farewelldave commented on GitHub (Jul 21, 2016): Yes, this would be great!
adam commented 2025-12-29 16:20:22 +01:00
Author
Owner
Copy Link

@malaiam commented on GitHub (Jul 27, 2016):

I just hit this while trying the demo, the search should be really flexible IMHO, almost google like. No matter what you search you should get results in all fields and categories, saving you search in different fields, or making mistakes.

@malaiam commented on GitHub (Jul 27, 2016): I just hit this while trying the demo, the search should be really flexible IMHO, almost google like. No matter what you search you should get results in all fields and categories, saving you search in different fields, or making mistakes.
adam commented 2025-12-29 16:20:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 29, 2016):

I've expanded the scope of this issue to include all objects.

@jeremystretch commented on GitHub (Jul 29, 2016): I've expanded the scope of this issue to include all objects.
adam commented 2025-12-29 16:20:22 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 29, 2016):

38aee33df0 added the following fields to the "q" search filter:

  • Circuits
    • Provider: comments
    • Ciruit: comments, pp_info, xconnect_id
  • DCIM
    • Site: comments
    • Rack: comments
    • Device: comments
  • IPAM
    • VRF: RD, description (new filter)
    • Aggregate: prefix, description (new filter)
    • Prefix: description
    • IPAddress: description
    • VLAN: VID, name, description (new filter)
  • Secrets
    • Secret: name, device.name (new filter)
  • Tenancy
    • Tenant: description, comments
@jeremystretch commented on GitHub (Jul 29, 2016): 38aee33df01ccddb35607bebdbfe233f857c78dd added the following fields to the "q" search filter: - Circuits - Provider: comments - Ciruit: comments, pp_info, xconnect_id - DCIM - Site: comments - Rack: comments - Device: comments - IPAM - VRF: RD, description (new filter) - Aggregate: prefix, description (new filter) - Prefix: description - IPAddress: description - VLAN: VID, name, description (new filter) - Secrets - Secret: name, device.name (new filter) - Tenancy - Tenant: description, comments
adam commented 2025-12-29 16:20:22 +01:00
Author
Owner
Copy Link

@wzyboy commented on GitHub (Aug 2, 2016):

Thanks for adding additional search fields!

We are now using NetBox as a data source for provisioning system. We import server serial numbers and (pre-allocated) IP addresses into NetBox and boot bare-metal servers with PXE (with DHCP temporary IP addresses). A Python script in PXE live system would first collect server serial number (with dmidecode -s system-serial-number) before querying NetBox for permanent IP address of that server for provisioning purpose.

It would be great if serial number could be added as a search field for devices. Thanks!

@wzyboy commented on GitHub (Aug 2, 2016): Thanks for adding additional search fields! We are now using NetBox as a data source for provisioning system. We import server serial numbers and (pre-allocated) IP addresses into NetBox and boot bare-metal servers with PXE (with DHCP temporary IP addresses). A Python script in PXE live system would first collect server serial number (with `dmidecode -s system-serial-number`) before querying NetBox for permanent IP address of that server for provisioning purpose. It would be great if serial number could be added as a search field for devices. Thanks!
adam commented 2025-12-29 16:20:22 +01:00
Author
Owner
Copy Link

@wzyboy commented on GitHub (Aug 2, 2016):

To be clear, I mean the /api/dcim/devices/ API.

@wzyboy commented on GitHub (Aug 2, 2016): To be clear, I mean the `/api/dcim/devices/` API.
adam commented 2025-12-29 16:20:23 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 2, 2016):

The fields I listed above are just the new additions. Serial has always been included in device search (also the serials of installed modules):

    def search(self, queryset, value):
        return queryset.filter(
            Q(name__icontains=value) |
            Q(serial__icontains=value) |
            Q(modules__serial__icontains=value) |
            Q(comments__icontains=value)
        ).distinct()
@jeremystretch commented on GitHub (Aug 2, 2016): The fields I listed above are just the new additions. Serial has always been included in device search (also the serials of installed modules): ``` def search(self, queryset, value): return queryset.filter( Q(name__icontains=value) | Q(serial__icontains=value) | Q(modules__serial__icontains=value) | Q(comments__icontains=value) ).distinct() ```
adam commented 2025-12-29 16:20:23 +01:00
Author
Owner
Copy Link

@wzyboy commented on GitHub (Aug 3, 2016):

Yes, I know I can generally search for foo and all devices with foo values would be returned in JSON. However, if device A has string foo in comments field and device B has string foo in serial field. Device A and B would both be returned when searching for foo. We had to manually check if foo appears in serial field. It would be nice if we can just search for foo in serial field.

@wzyboy commented on GitHub (Aug 3, 2016): Yes, I know I can generally search for `foo` and all devices with `foo` values would be returned in JSON. However, if device A has string `foo` in `comments` field and device B has string `foo` in `serial` field. Device A and B would both be returned when searching for `foo`. We had to manually check if `foo` appears in `serial` field. It would be nice if we can just search for `foo` in `serial` field.
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 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#267
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?