Search by interface name #1682

Closed
opened 2025-12-29 16:34:23 +01:00 by adam · 3 comments
Owner

Originally created by @dimecho on GitHub (Apr 20, 2018).

Issue type

[x] Feature request
[ ] Bug report
[ ] Documentation

Environment

  • Python version: 3.5.4
  • NetBox version: 2.3.3

Description

If I add a device and call it a "patch-panel" I would like to be able to search the interfaces by names. Example 1B-0101. Currently searching interface by name does not find anything.

Originally created by @dimecho on GitHub (Apr 20, 2018). <!-- Before opening a new issue, please search through the existing issues to see if your topic has already been addressed. Note that you may need to remove the "is:open" filter from the search bar to include closed issues. Check the appropriate type for your issue below by placing an x between the brackets. For assistance with installation issues, or for any other issues other than those listed below, please raise your topic for discussion on our mailing list: https://groups.google.com/forum/#!forum/netbox-discuss Please note that issues which do not fall under any of the below categories will be closed. Due to an excessive backlog of feature requests, we are not currently accepting any proposals which extend NetBox's feature scope. Do not prepend any sort of tag to your issue's title. An administrator will review your issue and assign labels as appropriate. ---> ### Issue type [x] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> <!-- Please describe the environment in which you are running NetBox. (Be sure to verify that you are running the latest stable release of NetBox before submitting a bug report.) If you are submitting a bug report and have made any changes to the code base, please first validate that your bug can be recreated while running an official release. --> ### Environment * Python version: 3.5.4<!-- Example: 3.5.4 --> * NetBox version: 2.3.3<!-- Example: 2.1.3 --> <!-- BUG REPORTS must include: * A list of the steps needed for someone else to reproduce the bug * A description of the expected and observed behavior * Any relevant error messages (screenshots may also help) FEATURE REQUESTS must include: * A detailed description of the proposed functionality * A use case for the new feature * A rough description of any necessary changes to the database schema * Any relevant third-party libraries which would be needed --> ### Description If I add a device and call it a "patch-panel" I would like to be able to search the interfaces by names. Example 1B-0101. Currently searching interface by name does not find anything.
adam closed this issue 2025-12-29 16:34:23 +01:00
Author
Owner

@jeremystretch commented on GitHub (Apr 23, 2018):

As interface names are generally platform-dependent, it doesn't make sense that you'd want to search for e.g. "ge-0/0/0" and get a bunch of Juniper switches, or "eth0" and get a bunch of Linux servers. This request seems to be born out of an attempt to represent patch panels, which NetBox does not yet support (see #20). If you really need to, you can filter interfaces by name in the REST API like this: /api/dcim/interfaces/?name=foo

@jeremystretch commented on GitHub (Apr 23, 2018): As interface names are generally platform-dependent, it doesn't make sense that you'd want to search for e.g. "ge-0/0/0" and get a bunch of Juniper switches, or "eth0" and get a bunch of Linux servers. This request seems to be born out of an attempt to represent patch panels, which NetBox does not yet support (see #20). If you really need to, you can filter interfaces by name in the REST API like this: `/api/dcim/interfaces/?name=foo`
Author
Owner

@dimecho commented on GitHub (May 9, 2018):

@jeremystretch I know it was rejected feature, but if I was to branch and implement the feature myself any pointers? Files and functions that need to be modified? API works exactly as I wanted but need the GUI.

@dimecho commented on GitHub (May 9, 2018): @jeremystretch I know it was rejected feature, but if I was to branch and implement the feature myself any pointers? Files and functions that need to be modified? API works exactly as I wanted but need the GUI.
Author
Owner

@netsiphon commented on GitHub (May 29, 2018):

I already implemented interface search and that part was rejected as part of PR #1465 with somewhat similar reasoning to your request. I was actually looking to use the description field generically as a label and import/export them from current documentation. Don't recall if Jeremy rejected the idea of descriptions in general but he definitely could tell that I was trying to implement some physical tracking and doesn't want to support that outside an official feature. I'd be willing to work on #20 since it aligns with my interests but I'm not sure what kind of consensus is required for that to move forward.

There were changes Jeremy requested that I didn't have a chance to correct but you can check against that PR or pull netsiphon/netbox to see if that is what you are looking for (older version of netbox).

@netsiphon commented on GitHub (May 29, 2018): I already implemented interface search and that part was rejected as part of PR #1465 with somewhat similar reasoning to your request. I was actually looking to use the description field generically as a label and import/export them from current documentation. Don't recall if Jeremy rejected the idea of descriptions in general but he definitely could tell that I was trying to implement some physical tracking and doesn't want to support that outside an official feature. I'd be willing to work on #20 since it aligns with my interests but I'm not sure what kind of consensus is required for that to move forward. There were changes Jeremy requested that I didn't have a chance to correct but you can check against that PR or pull netsiphon/netbox to see if that is what you are looking for (older version of netbox).
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1682