Searching by MAC address #3871

Closed
opened 2025-12-29 18:31:43 +01:00 by adam · 6 comments
Owner

Originally created by @lps-rocks on GitHub (Jul 20, 2020).

Environment

  • Python version: 3.7.6
  • NetBox version: 2.8.7

Proposed Functionality

Allow global searching of objects via MAC address.

Use Case

This is one of the most common search mechanisms used by networking administrators when tracking down an unknown device or a device that may not be operating properly.

Database Changes

Possibly an index on the mac field for interfaces

Originally created by @lps-rocks on GitHub (Jul 20, 2020). <!-- NOTE: IF YOUR ISSUE DOES NOT FOLLOW THIS TEMPLATE, IT WILL BE CLOSED. This form is only for proposing specific new features or enhancements. If you have a general idea or question, please post to our mailing list instead of opening an issue: https://groups.google.com/forum/#!forum/netbox-discuss NOTE: Due to an excessive backlog of feature requests, we are not currently accepting any proposals which significantly extend NetBox's feature scope. Please describe the environment in which you are running NetBox. Be sure that you are running an unmodified instance of the latest stable release before submitting a bug report. --> ### Environment * Python version: 3.7.6 * NetBox version: 2.8.7 <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Allow global searching of objects via MAC address. <!-- Convey an example use case for your proposed feature. Write from the perspective of a NetBox user who would benefit from the proposed functionality and describe how. ---> ### Use Case This is one of the most common search mechanisms used by networking administrators when tracking down an unknown device or a device that may not be operating properly. <!-- Note any changes to the database schema necessary to support the new feature. For example, does the proposal require adding a new model or field? (Not all new features require database changes.) ---> ### Database Changes Possibly an index on the mac field for interfaces
adam added the type: featurestatus: needs ownerpending closure labels 2025-12-29 18:31:43 +01:00
adam closed this issue 2025-12-29 18:31:43 +01:00
Author
Owner

@mskalecki commented on GitHub (Jul 21, 2020):

Searching by MAC already works well, with the caveat that you need to know if you're looking for a physical device or VM, and you need to do the search using the MAC Address filter in the list view for Devices or Virtual Machines respectively.

In practice, those caveats aren't a big deal, because you can quickly learn to identify VMs by the first 6 characters of their MAC address (the OUI). For example, if I see 00:15:DB, I know it's a Hyper-V VM, and if I see 00:50:56, I know it's a VM on my VMWare cluster.

@mskalecki commented on GitHub (Jul 21, 2020): Searching by MAC already works well, with the caveat that you need to know if you're looking for a physical device or VM, and you need to do the search using the MAC Address filter in the list view for Devices or Virtual Machines respectively. In practice, those caveats aren't a big deal, because you can quickly learn to identify VMs by the first 6 characters of their MAC address (the OUI). For example, if I see 00:15:DB, I know it's a Hyper-V VM, and if I see 00:50:56, I know it's a VM on my VMWare cluster.
Author
Owner

@lps-rocks commented on GitHub (Jul 23, 2020):

Thank you for those spots, I expected the search field to be associated with the model that the mac address is tied to.

Interestingly enough, the 'Interfaces' list /dcim/interfaces/ (which is the model the mac address is tied to) does not have a mac address search field.

May be worth adding the mac address filter to the 'interfaces' page as well as the global search capabilities.

@lps-rocks commented on GitHub (Jul 23, 2020): Thank you for those spots, I expected the search field to be associated with the model that the mac address is tied to. Interestingly enough, the 'Interfaces' list /dcim/interfaces/ (which is the model the mac address is tied to) does not have a mac address search field. May be worth adding the mac address filter to the 'interfaces' page as well as the global search capabilities.
Author
Owner

@jeremystretch commented on GitHub (Jul 24, 2020):

Allow global searching of objects via MAC address. Also, add the ability to search by MAC on the 'dcim/interfaces' in the GUI.

These proposal need to be tracked as two separate feature requests. Please pick one and update your initial post; you may open a separate issue for the other.

@jeremystretch commented on GitHub (Jul 24, 2020): > Allow global searching of objects via MAC address. Also, add the ability to search by MAC on the 'dcim/interfaces' in the GUI. These proposal need to be tracked as two separate feature requests. Please pick one and update your initial post; you may open a separate issue for the other.
Author
Owner

@lps-rocks commented on GitHub (Jul 24, 2020):

Allow global searching of objects via MAC address. Also, add the ability to search by MAC on the 'dcim/interfaces' in the GUI.

These proposal need to be tracked as two separate feature requests. Please pick one and update your initial post; you may open a separate issue for the other.

Done. Opened #4898, and #4899 for the other requests.

@lps-rocks commented on GitHub (Jul 24, 2020): > > Allow global searching of objects via MAC address. Also, add the ability to search by MAC on the 'dcim/interfaces' in the GUI. > > These proposal need to be tracked as two separate feature requests. Please pick one and update your initial post; you may open a separate issue for the other. Done. Opened #4898, and #4899 for the other requests.
Author
Owner

@stale[bot] commented on GitHub (Sep 7, 2020):

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. Please see our contributing guide.

@stale[bot] commented on GitHub (Sep 7, 2020): 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. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
Author
Owner

@stale[bot] commented on GitHub (Sep 23, 2020):

This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.

@stale[bot] commented on GitHub (Sep 23, 2020): This issue has been automatically closed due to lack of activity. In an effort to reduce noise, please do not comment any further. Note that the core maintainers may elect to reopen this issue at a later date if deemed necessary.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3871