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 a Description for Module Types #6490

New Issue
Closed
opened 2025-12-29 19:41:26 +01:00 by adam · 9 comments
adam commented 2025-12-29 19:41:26 +01:00
Owner
Copy Link

Originally created by @mgoetze5 on GitHub (May 17, 2022).

NetBox version

v3.2.3

Feature type

Data model extension

Proposed functionality

Add a Description field to dcim.module-types model, similar to the Description field in other models.

Use case

Here is a sample sysconfig output from a NetApp A700:

sysconfig: slot 1 OK: X91440A: 40G high performance  
sysconfig: slot 4 OK: X91440A: 40G high performance  
sysconfig: slot 6 OK: X93140A: NetApp NVRAM10  
sysconfig: slot 8 OK: X91440A: 40G high performance  
sysconfig: slot 9 OK: X92071A: PMC PM8072; PCI-E quad-port SAS (PM8072)  
sysconfig: slot 10 OK: X91135A: HBA,4-Port FCP 32Gb PCIe

While it will be pretty obvious what a X91440A or X91135A module type does from the associated interface templates, the purpose of a X93140A or X92071A would be rather harder to discern (especially since NetBox does not currently have a model for SAS ports/cables). It would be nice to have a description field where I could write this module type is a "NetApp NVRAM10" or a "PMC PM8072; PCI-E quad-port SAS (PM8072)".

Database changes

New field.

External dependencies

./.

Originally created by @mgoetze5 on GitHub (May 17, 2022). ### NetBox version v3.2.3 ### Feature type Data model extension ### Proposed functionality Add a Description field to dcim.module-types model, similar to the Description field in other models. ### Use case Here is a sample sysconfig output from a NetApp A700: ``` sysconfig: slot 1 OK: X91440A: 40G high performance sysconfig: slot 4 OK: X91440A: 40G high performance sysconfig: slot 6 OK: X93140A: NetApp NVRAM10 sysconfig: slot 8 OK: X91440A: 40G high performance sysconfig: slot 9 OK: X92071A: PMC PM8072; PCI-E quad-port SAS (PM8072) sysconfig: slot 10 OK: X91135A: HBA,4-Port FCP 32Gb PCIe ``` While it will be pretty obvious what a X91440A or X91135A module type does from the associated interface templates, the purpose of a X93140A or X92071A would be rather harder to discern (especially since NetBox does not currently have a model for SAS ports/cables). It would be nice to have a description field where I could write this module type is a "NetApp NVRAM10" or a "PMC PM8072; PCI-E quad-port SAS (PM8072)". ### Database changes New field. ### External dependencies ./.
adam added the type: feature label 2025-12-29 19:41:26 +01:00
adam closed this issue 2025-12-29 19:41:26 +01:00
adam commented 2025-12-29 19:41:27 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 17, 2022):

The ModuleType model already has a comments field; is that not sufficient?

@jeremystretch commented on GitHub (May 17, 2022): The ModuleType model already has a comments field; is that not sufficient?
adam commented 2025-12-29 19:41:27 +01:00
Author
Owner
Copy Link

@mgoetze5 commented on GitHub (May 17, 2022):

I was thinking of a single-line description rather than a multi-line markdown-capable one but I guess I could use the comments field for this, yes. It just seems inconsistent with how other models work.

@mgoetze5 commented on GitHub (May 17, 2022): I was thinking of a single-line description rather than a multi-line markdown-capable one but I guess I could use the comments field for this, yes. It just seems inconsistent with how other models work.
adam commented 2025-12-29 19:41:27 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 17, 2022):

It's consistent with the DeviceType model, which fills a very similar role.

@jeremystretch commented on GitHub (May 17, 2022): It's consistent with the DeviceType model, which fills a very similar role.
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@mgoetze5 commented on GitHub (May 18, 2022):

Fair enough, for me the name has always been enough to understand what a DeviceType is whereas I'm more likely to be confused about various ModuleTypes, but that's subjective.

@mgoetze5 commented on GitHub (May 18, 2022): Fair enough, for me the name has always been enough to understand what a DeviceType is whereas I'm more likely to be confused about various ModuleTypes, but that's subjective.
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@salvadorb commented on GitHub (Jun 2, 2022):

Hi @jeremystretch,
Not sure if I'm missing something in the way transceivers should be specified in a switch's interface but I haven't find a way to specify for example the Wavelength or DWDM channel.

One example, I created the switch under the Devices section, added 48 SFP+ interfaces to it, but then I haven't find a way to specify that in interface 34 there's a 10G DWDM C43 transceiver inserted, but to add it after the port Description. That workaround works, but there's no way for us to know how many 10G DWDM C43 we do have and where we have some unused.

image

Here is an example of some of the SFP+ transceivers we use, it would be great to have a way to choose one of the following (or more) in a switch interface

  • Regular 1310nm duplex, 10km (LR)
  • Regular 1310nm duplex, 20km (LR+?)
  • Regular 1310nm duplex, 40km (ER?)
  • Regular 1550nm duplex, 40km (ER)
  • Regular 1550nm duplex, 80km (ZR)
  • Bidi 1270Tx-1330Rx, 10km
  • Bidi 1330Tx-1270Rx, 10km
  • Bidi 1270Tx-1330Rx, 40km
  • Bidi 1330Tx-1270Rx, 40km
  • Bidi 1270Tx-1330Rx, 80km
  • Bidi 1330Tx-1270Rx, 80km
  • Bidi 1490Tx-1550Rx, 80km
  • Bidi 1550Tx-1490Rx, 80km
  • CWDM [1270-1610 fixed], 10km (in this case options are 1270, 1290, 1310, 1330, 1350, 1370, 1390, 1410, 1430, 1450, 1470, 1490, 1510, 1530, 1550, 1570, 1590, 1610)
  • CWDM [1270-1610 fixed], 40km
  • CWDM [1270-1610 fixed], 80km
  • DWDM [C21-C60 fixed], 10km
  • DWDM [C21-C60 fixed], 40km
  • DWDM [C21-C60 fixed], 80km
  • DWDM [C21-C60 Tunable], 80km

Best regards,

@salvadorb commented on GitHub (Jun 2, 2022): Hi @jeremystretch, Not sure if I'm missing something in the way transceivers should be specified in a switch's interface but I haven't find a way to specify for example the Wavelength or DWDM channel. One example, I created the switch under the Devices section, added 48 SFP+ interfaces to it, but then I haven't find a way to specify that in interface 34 there's a 10G DWDM C43 transceiver inserted, but to add it after the port Description. That workaround works, but there's no way for us to know how many 10G DWDM C43 we do have and where we have some unused. <img width="1047" alt="image" src="https://user-images.githubusercontent.com/23199382/171650852-d3165af3-a5ff-4f8d-9f1d-f4c88e8ec058.png"> Here is an example of some of the SFP+ transceivers we use, it would be great to have a way to choose one of the following (or more) in a switch interface - Regular 1310nm duplex, 10km (LR) - Regular 1310nm duplex, 20km (LR+?) - Regular 1310nm duplex, 40km (ER?) - Regular 1550nm duplex, 40km (ER) - Regular 1550nm duplex, 80km (ZR) - Bidi 1270Tx-1330Rx, 10km - Bidi 1330Tx-1270Rx, 10km - Bidi 1270Tx-1330Rx, 40km - Bidi 1330Tx-1270Rx, 40km - Bidi 1270Tx-1330Rx, 80km - Bidi 1330Tx-1270Rx, 80km - Bidi 1490Tx-1550Rx, 80km - Bidi 1550Tx-1490Rx, 80km - CWDM [1270-1610 fixed], 10km (in this case options are 1270, 1290, 1310, 1330, 1350, 1370, 1390, 1410, 1430, 1450, 1470, 1490, 1510, 1530, 1550, 1570, 1590, 1610) - CWDM [1270-1610 fixed], 40km - CWDM [1270-1610 fixed], 80km - DWDM [C21-C60 fixed], 10km - DWDM [C21-C60 fixed], 40km - DWDM [C21-C60 fixed], 80km - DWDM [C21-C60 Tunable], 80km Best regards,
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@mgoetze5 commented on GitHub (Jun 2, 2022):

Hi @salvadorb, I believe you're looking for Inventory Items, not Modules.

@mgoetze5 commented on GitHub (Jun 2, 2022): Hi @salvadorb, I believe you're looking for Inventory Items, not Modules.
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@salvadorb commented on GitHub (Jun 2, 2022):

Hi @mgoetze5 in certain area yes, but the need for that is to also know if the right optic is connected to the right CWDM/DWDM mux port and using what cable.

@salvadorb commented on GitHub (Jun 2, 2022): Hi @mgoetze5 in certain area yes, but the need for that is to also know if the right optic is connected to the right CWDM/DWDM mux port and using what cable.
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jun 2, 2022):

Please keep discussion on this issue limited to the feature request, thanks.

@jeremystretch commented on GitHub (Jun 2, 2022): Please keep discussion on this issue limited to the feature request, thanks.
adam commented 2025-12-29 19:41:28 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 27, 2022):

Going to close this out as there doesn't seem to be anything further to discuss.

@jeremystretch commented on GitHub (Jul 27, 2022): Going to close this out as there doesn't seem to be anything further to discuss.
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#6490
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?