Add description field for console and power components #2170

Closed
opened 2025-12-29 17:22:59 +01:00 by adam · 2 comments
Owner

Originally created by @esapozhnikov-wish on GitHub (Dec 4, 2018).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version:
  • NetBox version:

Proposed Functionality

Add a Description column to console ports on the console devices.

Use Case

A Description field would be very useful especially for Opengear switches where each port can have an IP address assigned to it.
The Description field can also be used to store console connection form factor info

Database Changes

I believe this will require an addition of a new field to console port table

External Dependencies

None that I am aware of.

Originally created by @esapozhnikov-wish on GitHub (Dec 4, 2018). Originally assigned to: @jeremystretch on GitHub. <!-- 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: <!-- Example: 3.5.4 --> * NetBox version: <!-- Example: 2.4.6 --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality Add a Description column to console ports on the console devices. <!-- 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 A Description field would be very useful especially for Opengear switches where each port can have an IP address assigned to it. The Description field can also be used to store console connection form factor info <!-- 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 I believe this will require an addition of a new field to console port table <!-- 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 None that I am aware of.
adam added the status: accepted label 2025-12-29 17:22:59 +01:00
adam closed this issue 2025-12-29 17:22:59 +01:00
Author
Owner

@jeremystretch commented on GitHub (Dec 11, 2018):

Extending the scope of this to include all console and power components. Interfaces and pass-through ports already have a description field.

@jeremystretch commented on GitHub (Dec 11, 2018): Extending the scope of this to include all console and power components. Interfaces and pass-through ports already have a description field.
Author
Owner

@jeremystretch commented on GitHub (Feb 20, 2019):

This will be merged into develop-2.6 soon.

@jeremystretch commented on GitHub (Feb 20, 2019): This will be merged into `develop-2.6` soon.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2170