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

Add description fields to interface connections export #2312

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

Originally created by @dberube1 on GitHub (Jan 28, 2019).

Environment

  • Python version: 3.5.2
  • NetBox version: 2.5.3

Proposed Functionality

Include the interface descriptions for both the A-side and B-side interfaces in the exported csv file generated from the interface connections page. Currently when you export the interface list to csv the descriptions are omitted.

I know this was originally blocked in request #614, but I feel with the added virtualization features that it would be useful to include this data on the export.

Use Case

This would be useful when giving the exported file to anyone that is having to physically work on the equipment, such as cabinet migrations, or server/switch replacement. I use the interface description heavily to document individual network interface name to the PCI slot/port on servers in my environment.

Example: in a VMware environment the physical adapters are named vmnic[0-14]. The interface name vmnic4 is not useable for tracing the physical port on the back of the server. In this case I've used the description field to indicate the following information on servers: "Card type: PCI Slot # / Port #".

Database Changes

No database changes required.

External Dependencies

No external dependencies are required.

Originally created by @dberube1 on GitHub (Jan 28, 2019). <!-- NOTE: 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.5.2 * NetBox version: 2.5.3 <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Include the interface descriptions for both the A-side and B-side interfaces in the exported csv file generated from the interface connections page. Currently when you export the interface list to csv the descriptions are omitted. I know this was originally blocked in request #614, but I feel with the added virtualization features that it would be useful to include this data on the export. <!-- 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 would be useful when giving the exported file to anyone that is having to physically work on the equipment, such as cabinet migrations, or server/switch replacement. I use the interface description heavily to document individual network interface name to the PCI slot/port on servers in my environment. Example: in a VMware environment the physical adapters are named vmnic[0-14]. The interface name vmnic4 is not useable for tracing the physical port on the back of the server. In this case I've used the description field to indicate the following information on servers: "Card type: PCI Slot # / Port #". <!-- 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 No database changes required. <!-- List any new dependencies on external libraries or services that this new feature would introduce. For example, does the proposal require the installation of a new Python package? (Not all new features introduce new dependencies.) --> ### External Dependencies No external dependencies are required.
adam added the status: acceptedtype: feature labels 2025-12-29 17:24:43 +01:00
adam closed this issue 2025-12-29 17:24:43 +01:00
adam commented 2025-12-29 17:24:44 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 29, 2019):

Accepting this enhancement to maintain parity with the built-in list since custom export templates aren't supported for connection lists.

@jeremystretch commented on GitHub (Jan 29, 2019): Accepting this enhancement to maintain parity with the built-in list since custom export templates aren't supported for connection lists.
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 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#2312
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?