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

Alternate name / location for interfaces #1771

New Issue
Closed
opened 2025-12-29 17:18:59 +01:00 by adam · 1 comment
adam commented 2025-12-29 17:18:59 +01:00
Owner
Copy Link

Originally created by @wenners on GitHub (Jun 6, 2018).

Issue type

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

Environment

  • Python version: 2.7.5
  • NetBox version: 2.3.1

Description

A detailed description of the proposed functionality

Interfaces, especially for servers in my usecase, should have a second, alternate field for the name indicatiing the location of the interface.

A use case for the new feature

In our setup we want use netbox as singe source of truth (tm) for mainly two use cases.
The first one is building up hardware and cabling it. Therefore I need an interface name which is meaningful to the DC folks - something like "onboard#1" or "PCI2-2" so they know where to plug the cable.
In the second use case netbox is the source for our config management. But in that case "onboard#1" is relatively useless, something like enp2s0f0 of enp14s0f1 is needed to identify the right interface.
I know that I could use the description field of an interface to add the text for the first use case but this is only available for the device. It is not available in device type which means I would need to add this to each and every device I add to netbox. Having this in the device type already it would be inherited to each device I create with this special type.
Therefor I opt for having a alternate name or location field for the interfaces in device type.

A rough description of any necessary changes to the database schema

Adding a new field "AltName" or "Location" to the interface spec in DeviceType and Device

Any relevant third-party libraries which would be needed

Nope

Originally created by @wenners on GitHub (Jun 6, 2018). ### Issue type [x] Feature request [ ] Bug report [ ] 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: 2.7.5 * NetBox version: 2.3.1 <!-- 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 #### A detailed description of the proposed functionality Interfaces, especially for servers in my usecase, should have a second, alternate field for the name indicatiing the location of the interface. #### A use case for the new feature In our setup we want use netbox as singe source of truth (tm) for mainly two use cases. The first one is building up hardware and cabling it. Therefore I need an interface name which is meaningful to the DC folks - something like "onboard#1" or "PCI2-2" so they know where to plug the cable. In the second use case netbox is the source for our config management. But in that case "onboard#1" is relatively useless, something like enp2s0f0 of enp14s0f1 is needed to identify the right interface. I know that I could use the description field of an interface to add the text for the first use case but this is only available for the device. It is not available in device type which means I would need to add this to each and every device I add to netbox. Having this in the device type already it would be inherited to each device I create with this special type. Therefor I opt for having a alternate name or location field for the interfaces in device type. #### A rough description of any necessary changes to the database schema Adding a new field "AltName" or "Location" to the interface spec in DeviceType and Device #### Any relevant third-party libraries which would be needed Nope
adam closed this issue 2025-12-29 17:18:59 +01:00
adam commented 2025-12-29 17:19:00 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 6, 2018):

The recommended approach is to always name the interface as it appears to the operating system, to avoid breaking things like LLDP neighbor validation.

If you need to make additional notes about where interfaces are physically located, they can be stored in the comments on the DeviceType. This ensures that the information is readily available while avoid duplication.

@jeremystretch commented on GitHub (Jun 6, 2018): The recommended approach is to always name the interface as it appears to the operating system, to avoid breaking things like LLDP neighbor validation. If you need to make additional notes about where interfaces are physically located, they can be stored in the comments on the DeviceType. This ensures that the information is readily available while avoid duplication.
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#1771
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?