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

Transceiver Frequency Attribute for Interface #10784

New Issue
Closed
opened 2025-12-29 21:35:53 +01:00 by adam · 3 comments
adam commented 2025-12-29 21:35:53 +01:00
Owner
Copy Link

Originally created by @jniec-js on GitHub (Feb 20, 2025).

NetBox version

v4.2.2

Feature type

Data model extension

Proposed functionality

I'd like to request a new attribute on the the existing Interface model, "Transceiver frequency (GHz)". This is similar to an existing field on the Interface class, Transmit power, which allows for capturing the configurd transmit power for a specific interface, when done manually.

No unique constraints need be placed upon this new proposed field, currently this request is to just enhance the existing Interface model to include this new field.

Use case

The prupose of this attribute is to capture the frequency assigned to interfaces configured with a specific frequency when utilizing tunable optics in device interfaces.

For example, in a topology utilizing DWDM systems, it can be common to utilize tunable optics on a Network Switch to output signals at specific wavelengths (non-overlapping) into the DWDM system, which are then multiplexed onto a single dark fiber pair.

Database changes

This request would require a new field to https://github.com/netbox-community/netbox/blob/main/netbox/dcim/models/device_components.py#L629, the Interface model. I am proposing the field be called "Transceiver frequency (GHz)", but am open to other considerations and feedback.

External dependencies

No external dependencies would be required.

Originally created by @jniec-js on GitHub (Feb 20, 2025). ### NetBox version v4.2.2 ### Feature type Data model extension ### Proposed functionality I'd like to request a new attribute on the the existing Interface model, "Transceiver frequency (GHz)". This is similar to an existing field on the Interface class, Transmit power, which allows for capturing the configurd transmit power for a specific interface, when done manually. No unique constraints need be placed upon this new proposed field, currently this request is to just enhance the existing Interface model to include this new field. ### Use case The prupose of this attribute is to capture the frequency assigned to interfaces configured with a specific frequency when utilizing tunable optics in device interfaces. For example, in a topology utilizing DWDM systems, it can be common to utilize tunable optics on a Network Switch to output signals at specific wavelengths (non-overlapping) into the DWDM system, which are then multiplexed onto a single dark fiber pair. ### Database changes This request would require a new field to https://github.com/netbox-community/netbox/blob/main/netbox/dcim/models/device_components.py#L629, the Interface model. I am proposing the field be called "Transceiver frequency (GHz)", but am open to other considerations and feedback. ### External dependencies No external dependencies would be required.
adam added the type: feature label 2025-12-29 21:35:53 +01:00
adam closed this issue 2025-12-29 21:35:53 +01:00
adam commented 2025-12-29 21:35:54 +01:00
Author
Owner
Copy Link

@ITJamie commented on GitHub (Feb 20, 2025):

would make a little more sense on the "inventory" model which can be assigned to interfaces?

@ITJamie commented on GitHub (Feb 20, 2025): would make a little more sense on the "inventory" model which can be assigned to interfaces?
adam commented 2025-12-29 21:35:54 +01:00
Author
Owner
Copy Link

@sleepinggenius2 commented on GitHub (Feb 21, 2025):

You already have the rf_channel, rf_channel_frequency, and rf_channel_width fields on the Interface model. I always thought that it would just be nice to allow those to be used for optical interfaces and not only wireless, as they are restricted today. You would obviously also need to increase the max_digits value from 7 to be able to record the THz values you would need for WDM though.

Those face a similar limitation to your proposal though, that you are assuming a single wavelength/frequency used in both directions. We deploy a lot of single-fiber bidirectional optics, which would have different transmit and receive frequencies (the transmit is generally the tunable piece, with a broad spectrum receive). Also, for higher bandwidths, the modulation often requires multiple wavelengths to be inverse-multiplexed, which would require documenting multiple values in each direction.

@sleepinggenius2 commented on GitHub (Feb 21, 2025): You already have the `rf_channel`, `rf_channel_frequency`, and `rf_channel_width` fields on the `Interface` model. I always thought that it would just be nice to allow those to be used for optical interfaces and not only wireless, as they are restricted today. You would obviously also need to increase the `max_digits` value from 7 to be able to record the THz values you would need for WDM though. Those face a similar limitation to your proposal though, that you are assuming a single wavelength/frequency used in both directions. We deploy a lot of single-fiber bidirectional optics, which would have different transmit and receive frequencies (the transmit is generally the tunable piece, with a broad spectrum receive). Also, for higher bandwidths, the modulation often requires multiple wavelengths to be inverse-multiplexed, which would require documenting multiple values in each direction.
adam commented 2025-12-29 21:35:54 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Mar 6, 2025):

The frequency would be an attribute of the pluggable transceiver, not the interface itself. Convention is to model the transceiver separately as an inventory item. You could create a custom field on the InventoryItem model to track this.

You already have the rf_channel, rf_channel_frequency, and rf_channel_width fields on the Interface model.

These are unique to wireless interfaces, to which RF attributes are inherent.

@jeremystretch commented on GitHub (Mar 6, 2025): The frequency would be an attribute of the pluggable transceiver, not the interface itself. Convention is to model the transceiver separately as an inventory item. You could create a custom field on the InventoryItem model to track this. > You already have the rf_channel, rf_channel_frequency, and rf_channel_width fields on the Interface model. These are unique to wireless interfaces, to which RF attributes are inherent.
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#10784
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?