Add description field to role objects #2988

Closed
opened 2025-12-29 18:24:26 +01:00 by adam · 3 comments
Owner

Originally created by @soer7022 on GitHub (Oct 30, 2019).

Proposed Functionality

In the current version of NetBox you can add comments to devices. This is convenient if you want to keep different information, that doesn't require custom fields.

However when creating a device role, such comments would also be useful, to describe behaviour and what the role is used for.

Use Case

See section above

Database Changes

Should require an added comment field to device-roles

External Dependencies

None that I'm aware of

Originally created by @soer7022 on GitHub (Oct 30, 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. --> <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality In the current version of NetBox you can add comments to devices. This is convenient if you want to keep different information, that doesn't require custom fields. However when creating a device role, such comments would also be useful, to describe behaviour and what the role is used for. <!-- 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 See section above <!-- 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 Should require an added comment field to device-roles <!-- 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'm aware of
adam added the status: acceptedtype: feature labels 2025-12-29 18:24:26 +01:00
adam closed this issue 2025-12-29 18:24:26 +01:00
Author
Owner

@zacho112 commented on GitHub (Oct 30, 2019):

I agree on this!

@zacho112 commented on GitHub (Oct 30, 2019): I agree on this!
Author
Owner

@jeremystretch commented on GitHub (Oct 30, 2019):

Reminder: Please use a 👍 reaction to show support for an issue. Individual comments are not reflected in any metric.

@jeremystretch commented on GitHub (Oct 30, 2019): Reminder: Please use a :+1: reaction to show support for an issue. Individual comments are not reflected in any metric.
Author
Owner

@jeremystretch commented on GitHub (Dec 10, 2019):

Expanding the scope of this FR to include:

  • CircuitTypes
  • RackRoles
  • DeviceRoles
  • ipam.Roles (prefixes/VLANs)
  • SecretRoles
@jeremystretch commented on GitHub (Dec 10, 2019): Expanding the scope of this FR to include: * CircuitTypes * RackRoles * DeviceRoles * ipam.Roles (prefixes/VLANs) * SecretRoles
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2988