Adding Commit Upload Rate Field to Circuit Model #136

Open
opened 2026-04-05 16:22:06 +02:00 by MrUnknownDE · 0 comments
Owner

Originally created by @Atomicbeast101 on 3/17/2026

NetBox version

v4.5.4

Feature type

Data model extension

Proposed functionality

Changes to make to include Commit Upload Rate field:

  • Update Circuit Model class to include commit_upload_rate.
  • Update CircuitTable Table class to include commit_upload_rate.
  • Update following Form classes to include commit_upload_rate (reuse CircuitCommitRateChoices for NumberWithOptions widget options):
    • CircuitForm
    • CircuitFilterForm
    • CircuitBulkEditForm
    • CircuitImportForm
  • Update CircuitSerializer Serializer class to include commit_upload_rate.
  • Update CircuitFilterSet FilterSet's Meta class to include commit_upload_rate field.
  • Update CircuitFilter model in GraphQL to include commit_upload_rate.

Outside of core changes, there's some changes to make for testing:

  • Update CircuitTestCase Views class to include commit_upload_rate.
  • Update CircuitTestCase FilterSet class to include commit_upload_rate.

There was a previous request for this but it hasn't been responded by requester so it got closed with no action. Hence why I'm submitting another one that follows the standard practice.

Use case

Having a built-in commit upload rate field for Circuit table will make it easier for companies that have a process where they have port and access speeds (port being the max supported bandwidth it provides and access being the actual bandwidth configured to use; gives flexibility for increasing bandwidth without having to replace the circuit). Circuit Termination has both download and upload fields while Circuit doesn't, so it seems to make sense to include the missing upload field there.

Plus, the other reason is with big companies that uses SDWAN technology, they would have a mix of MPLS/Internet/LTE/Broadband connections that wouldn't have symmetrical speeds to provide diversity to sites to help reduce network outages.

Custom field could be used for tracking the upload commit rate, however, it would show the commit rate value automatically converted to human-friendly (1Gbps or 10Mbps, for example) while the custom field's upload rate would show the full value in Kbps.

Database changes

Adding a new field called Commit Upload Rate (Kbps) (commit_upload_rate) to Circuit model and setting order to appear below existing Commit Rate (Kbps) (commit_rate) field.

External dependencies

N/A

*Originally created by @Atomicbeast101 on 3/17/2026* ### NetBox version v4.5.4 ### Feature type Data model extension ### Proposed functionality Changes to make to include Commit Upload Rate field: - Update Circuit Model class to include commit_upload_rate. - Update CircuitTable Table class to include commit_upload_rate. - Update following Form classes to include commit_upload_rate (reuse CircuitCommitRateChoices for NumberWithOptions widget options): - CircuitForm - CircuitFilterForm - CircuitBulkEditForm - CircuitImportForm - Update CircuitSerializer Serializer class to include commit_upload_rate. - Update CircuitFilterSet FilterSet's Meta class to include commit_upload_rate field. - Update CircuitFilter model in GraphQL to include commit_upload_rate. Outside of core changes, there's some changes to make for testing: - Update CircuitTestCase Views class to include commit_upload_rate. - Update CircuitTestCase FilterSet class to include commit_upload_rate. There was a previous request for [this](https://github.com/netbox-community/netbox/issues/9790) but it hasn't been responded by requester so it got closed with no action. Hence why I'm submitting another one that follows the standard practice. ### Use case Having a built-in commit upload rate field for Circuit table will make it easier for companies that have a process where they have port and access speeds (port being the max supported bandwidth it provides and access being the actual bandwidth configured to use; gives flexibility for increasing bandwidth without having to replace the circuit). Circuit Termination has both download and upload fields while Circuit doesn't, so it seems to make sense to include the missing upload field there. Plus, the other reason is with big companies that uses SDWAN technology, they would have a mix of MPLS/Internet/LTE/Broadband connections that wouldn't have symmetrical speeds to provide diversity to sites to help reduce network outages. Custom field could be used for tracking the upload commit rate, however, it would show the commit rate value automatically converted to human-friendly (1Gbps or 10Mbps, for example) while the custom field's upload rate would show the full value in Kbps. ### Database changes Adding a new field called **Commit Upload Rate (Kbps)** (commit_upload_rate) to Circuit model and setting order to appear below existing **Commit Rate (Kbps)** (commit_rate) field. ### External dependencies N/A
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: github/netbox#136