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 USB version to USB console port types (interface speed) #3991

New Issue
Closed
opened 2025-12-29 18:32:29 +01:00 by adam · 5 comments
adam commented 2025-12-29 18:32:29 +01:00
Owner
Copy Link

Originally created by @ypid on GitHub (Aug 18, 2020).

Environment

  • Python version: 3.7.3
  • NetBox version: 2.8.9

Proposed Functionality

USB console port types should include the interface speed (USB version). Compared to network interfaces, USB is missing interface speed info.

https://en.wikipedia.org/wiki/USB#Receptacle_(socket)_identification

For backwards compatibility, a unspecific USB port (A, B, C) might still be retained.

For new device types, only precise USB ports should be selectable. When importing device types, the unspecific USB ports are probably needed for backwards compatibility also for a while.

Alternative in case this misses the scope of Netbox, maybe add the field "Description" that is present for devices but not device types. So that the admin could pre-populate such details there.

Use Case

For attaching peripherals, for example attaching an external disk via USB to a NAS or server, the USB interface speed makes a difference.

Database Changes

Yes.

External Dependencies

None that I am aware of.

Originally created by @ypid on GitHub (Aug 18, 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.3 * NetBox version: 2.8.9 <!-- Describe in detail the new functionality you are proposing. Include any specific changes to work flows, data models, or the user interface. --> ### Proposed Functionality USB console port types should include the interface speed (USB version). Compared to network interfaces, USB is missing interface speed info. https://en.wikipedia.org/wiki/USB#Receptacle_(socket)_identification For backwards compatibility, a unspecific USB port (A, B, C) might still be retained. For new device types, only precise USB ports should be selectable. When importing device types, the unspecific USB ports are probably needed for backwards compatibility also for a while. Alternative in case this misses the scope of Netbox, maybe add the field "Description" that is present for devices but not device types. So that the admin could pre-populate such details there. <!-- 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 For attaching peripherals, for example attaching an external disk via USB to a NAS or server, the USB interface speed makes a difference. <!-- 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 Yes. <!-- 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 type: feature label 2025-12-29 18:32:29 +01:00
adam closed this issue 2025-12-29 18:32:29 +01:00
adam commented 2025-12-29 18:32:30 +01:00
Author
Owner
Copy Link

@DanSheps commented on GitHub (Aug 18, 2020):

We generally don't denote speed (A/B/C) however we will denote type (mini, micro, etc).

@DanSheps commented on GitHub (Aug 18, 2020): We generally don't denote speed (A/B/C) however we will denote type (mini, micro, etc).
adam commented 2025-12-29 18:32:30 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 18, 2020):

NetBox currently provides the following options for USB console ports:

(TYPE_USB_A, 'USB Type A'),
(TYPE_USB_B, 'USB Type B'),
(TYPE_USB_C, 'USB Type C'),
(TYPE_USB_MINI_A, 'USB Mini A'),
(TYPE_USB_MINI_B, 'USB Mini B'),
(TYPE_USB_MICRO_A, 'USB Micro A'),
(TYPE_USB_MICRO_B, 'USB Micro B'),

For attaching peripherals, for example attaching an external disk via USB to a NAS or server, the USB interface speed makes a difference.

This is not a valid use of the console port model, as these are not console connections. NetBox does not support modeling such peripheral components.

@jeremystretch commented on GitHub (Aug 18, 2020): NetBox currently provides the following options for USB console ports: ``` (TYPE_USB_A, 'USB Type A'), (TYPE_USB_B, 'USB Type B'), (TYPE_USB_C, 'USB Type C'), (TYPE_USB_MINI_A, 'USB Mini A'), (TYPE_USB_MINI_B, 'USB Mini B'), (TYPE_USB_MICRO_A, 'USB Micro A'), (TYPE_USB_MICRO_B, 'USB Micro B'), ``` > For attaching peripherals, for example attaching an external disk via USB to a NAS or server, the USB interface speed makes a difference. This is not a valid use of the console port model, as these are not console connections. NetBox does not support modeling such peripheral components.
adam commented 2025-12-29 18:32:30 +01:00
Author
Owner
Copy Link

@ypid commented on GitHub (Aug 18, 2020):

Fine with me.

Alternative in case this misses the scope of Netbox, maybe add the field "Description" that is present for devices but not device types. So that the admin could pre-populate such details there.

Would that be an option to allow some forms of "misuse" as I seem to be doing it then with Netbox? I guess it should then also be added to other components. For this I see more "valid" use cases like device types where LAN1 has specific hardware configuration (like with consumer "access points" where one port is usually directly connected to the CPU, the others to a integrated switch so it makes sense to differentiate them even if their name does not tell this technical side of it).

@ypid commented on GitHub (Aug 18, 2020): Fine with me. > Alternative in case this misses the scope of Netbox, maybe add the field "Description" that is present for devices but not device types. So that the admin could pre-populate such details there. Would that be an option to allow some forms of "misuse" as I seem to be doing it then with Netbox? I guess it should then also be added to other components. For this I see more "valid" use cases like device types where LAN1 has specific hardware configuration (like with consumer "access points" where one port is usually directly connected to the CPU, the others to a integrated switch so it makes sense to differentiate them even if their name does not tell this technical side of it).
adam commented 2025-12-29 18:32:30 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Aug 18, 2020):

A description field was added for all device type components under #4793 for the upcoming v2.9 release, however I don't see how that would be relevant to this issue.

I'm going to close this issue as it seems that the proposed use case is firmly out of scope.

@jeremystretch commented on GitHub (Aug 18, 2020): A description field was added for all device type components under #4793 for the upcoming v2.9 release, however I don't see how that would be relevant to this issue. I'm going to close this issue as it seems that the proposed use case is firmly out of scope.
adam commented 2025-12-29 18:32:31 +01:00
Author
Owner
Copy Link

@ypid commented on GitHub (Aug 18, 2020):

#4793 should solve it for me, thanks!

@ypid commented on GitHub (Aug 18, 2020): #4793 should solve it for me, thanks!
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 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#3991
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?