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

Free/Used/Reserved ports overview in column table #7585

New Issue
Closed
opened 2025-12-29 20:25:45 +01:00 by adam · 14 comments
adam commented 2025-12-29 20:25:45 +01:00
Owner
Copy Link

Originally created by @PieterL75 on GitHub (Feb 1, 2023).

NetBox version

v3.3.10

Feature type

Change to existing functionality

Proposed functionality

I would like to see a summary of all available/occupied ports on the device list page.
This could be added as a new column that can be added using the 'configure table'

image

Additionally, I would like to have an extra field in the 'Filter' to look for devices with at least X unconnected ports.

Use case

When provisioning a new environment, I need to pick the correct rack where to deploy it. This is mainly done by looking for the required network ports for that environment.
I have a custom report, but having this integrated (in a SavedFilter !!!) would be nice

Database changes

No response

External dependencies

No response

Originally created by @PieterL75 on GitHub (Feb 1, 2023). ### NetBox version v3.3.10 ### Feature type Change to existing functionality ### Proposed functionality I would like to see a summary of all available/occupied ports on the device list page. This could be added as a new column that can be added using the 'configure table' ![image](https://user-images.githubusercontent.com/74899468/216028576-7516e2f0-64a9-4b94-9a1b-c13d2da680e5.png) Additionally, I would like to have an extra field in the 'Filter' to look for devices with at least X unconnected ports. ### Use case When provisioning a new environment, I need to pick the correct rack where to deploy it. This is mainly done by looking for the required network ports for that environment. I have a custom report, but having this integrated (in a SavedFilter !!!) would be nice ### Database changes _No response_ ### External dependencies _No response_
adam added the type: featurepending closurestatus: under review labels 2025-12-29 20:25:45 +01:00
adam closed this issue 2025-12-29 20:25:45 +01:00
adam commented 2025-12-29 20:25:46 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 1, 2023):

I would like to see a summary of all available/occupied ports on the device list page.

Unfortunately it's not as simple as this. First, what do you consider a "port?" Front ports, rear ports, interfaces? All of them combined? This will probably differ by device role (e.g. switch vs. PDU). And then you have to consider qualifiers: Do we count management or disabled interfaces, for example? Lots of caveats come into play here, and a one-size-fits-all solution seems unlikely.

@jeremystretch commented on GitHub (Feb 1, 2023): > I would like to see a summary of all available/occupied ports on the device list page. Unfortunately it's not as simple as this. First, what do you consider a "port?" Front ports, rear ports, interfaces? All of them combined? This will probably differ by device role (e.g. switch vs. PDU). And then you have to consider qualifiers: Do we count management or disabled interfaces, for example? Lots of caveats come into play here, and a one-size-fits-all solution seems unlikely.
adam commented 2025-12-29 20:25:46 +01:00
Author
Owner
Copy Link

@PieterL75 commented on GitHub (Feb 1, 2023):

I agree on that.. One other option is to create two column per port-type (interface, front, rear,...) with the 'occupied' and 'available' count?

Last option : the ability to create 'calculated' custom fields.. We could leverage a jinja2 template to process the object data and generate a output.. then I could write that field myself, and it is highly customizable

@PieterL75 commented on GitHub (Feb 1, 2023): I agree on that.. One other option is to create two column per port-type (interface, front, rear,...) with the 'occupied' and 'available' count? Last option : the ability to create 'calculated' custom fields.. We could leverage a jinja2 template to process the object data and generate a output.. then I could write that field myself, and it is highly customizable
adam commented 2025-12-29 20:25:46 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 1, 2023):

This has some overlap with #6347, which will cache the number of each of type component associated with a device/VM. It doesn't consider whether each is occupied, but it would provide one of the two variables we need. With that in place, it might be feasible to add an individual column for each component type, which would annotate a count of occupied components and compare it to the total number.

I'm going to mark this as blocked by #6347 (which is planned for v3.5 now planned for v3.6) for now, though happy to discuss further.

@jeremystretch commented on GitHub (Feb 1, 2023): This has some overlap with #6347, which will cache the number of each of type component associated with a device/VM. It doesn't consider whether each is occupied, but it would provide one of the two variables we need. With that in place, it might be feasible to add an individual column for each component type, which would annotate a count of occupied components and compare it to the total number. I'm going to mark this as blocked by #6347 (~which is planned for v3.5~ now planned for v3.6) for now, though happy to discuss further.
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@PieterL75 commented on GitHub (Feb 3, 2023):

What about the 'calculated custom field' ?
A jinja2 template could be used to create a return value that is shown in the column. Then we can use that for any purpose.
ex: when displaying an IP address on an interface, I would like to also display the vlan id.

That would give a great flexibility to what people want to see and how they want it.
Maybe some extra guidance on how to display things (progress bar, badge, ...) and you have a total customizable table view without any plugins or serverside coding

@PieterL75 commented on GitHub (Feb 3, 2023): What about the 'calculated custom field' ? A jinja2 template could be used to create a return value that is shown in the column. Then we can use that for any purpose. ex: when displaying an IP address on an interface, I would like to also display the vlan id. That would give a great flexibility to what people want to see and how they want it. Maybe some extra guidance on how to display things (progress bar, badge, ...) and you have a total customizable table view without any plugins or serverside coding
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 3, 2023):

A custom field wouldn't be any different; the data still needs to come from the database. It can't be cached, because the count of free/total ports can change at any time.

@jeremystretch commented on GitHub (Feb 3, 2023): A custom field wouldn't be any different; the data still needs to come from the database. It can't be cached, because the count of free/total ports can change at any time.
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@PieterL75 commented on GitHub (Feb 3, 2023):

I agree on that, it might be slow, but it will be able to create a table field at the convenience of the user.
And with #6347, there will be more direct-accessible counters to use.

This customfield is out of scope of my initial request, but rather an result of thinking how this can be customized.
I can create a separate FR for that

@PieterL75 commented on GitHub (Feb 3, 2023): I agree on that, it might be slow, but it will be able to create a table field at the convenience of the user. And with #6347, there will be more direct-accessible counters to use. This customfield is out of scope of my initial request, but rather an result of thinking how this can be customized. I can create a separate FR for that
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@coloHsq commented on GitHub (Apr 7, 2023):

Hi everyone, I've actually done something similar to have a "per rack" summary of patch panels and PDUs available ports.

Screenshot 2023-04-07 alle 09 42 52

All the count aggregations are done on demand, and for like 300 racks it runs fast enough to be usable.

The querysets I'm using for ports aggregations can probably be adapted for this request.
Let me know if you're interested.

@coloHsq commented on GitHub (Apr 7, 2023): Hi everyone, I've actually done something similar to have a "per rack" summary of patch panels and PDUs available ports. ![Screenshot 2023-04-07 alle 09 42 52](https://user-images.githubusercontent.com/46020242/230566231-3e10ef51-5d3e-4d6e-ba74-febac0e87d1c.png) All the count aggregations are done on demand, and for like 300 racks it runs fast enough to be usable. The querysets I'm using for ports aggregations can probably be adapted for this request. Let me know if you're interested.
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@PieterL75 commented on GitHub (May 30, 2023):

@coloHsq How do you generate those fields ?
Is that through a plugin ?
Interesting to see that you got this working though :-)

@PieterL75 commented on GitHub (May 30, 2023): @coloHsq How do you generate those fields ? Is that through a plugin ? Interesting to see that you got this working though :-)
adam commented 2025-12-29 20:25:47 +01:00
Author
Owner
Copy Link

@coloHsq commented on GitHub (May 30, 2023):

@PieterL75 It's a plugin I've done for the same use case you've said, except for the fact we're using EOR architecture in our data center, so an aggregate count of patch panels port per rack is enough.
Anyway all the ports count fields are generated with count aggregation subquerys annotated on a Rack queryset,
something like this:
Rack.objects.annotate(free_mm=Subquery(mm_free_port_count_qs)).annotate(total_mm=Subquery(mm_tot_port_count_qs))

Anyway, I agree with @jeremystretch, while the calculations it's kinda easy to do, there's a lot of difficulty to define a general solution for this use case, as the parameters needed are strictly tied to user defined data and designs that differs one from another, so, in my opinion, this feature is more suited for a plugin.
I'm probably going to publish this, but it needs some polishing as it's heavily customizeds on my environment and i need to figure out how to make it open and customizable enough to be used by other people.

@coloHsq commented on GitHub (May 30, 2023): @PieterL75 It's a plugin I've done for the same use case you've said, except for the fact we're using EOR architecture in our data center, so an aggregate count of patch panels port per rack is enough. Anyway all the ports count fields are generated with count aggregation subquerys annotated on a Rack queryset, something like this: ` Rack.objects.annotate(free_mm=Subquery(mm_free_port_count_qs)).annotate(total_mm=Subquery(mm_tot_port_count_qs)) ` Anyway, I agree with @jeremystretch, while the calculations it's kinda easy to do, there's a lot of difficulty to define a general solution for this use case, as the parameters needed are strictly tied to user defined data and designs that differs one from another, so, in my opinion, this feature is more suited for a plugin. I'm probably going to publish this, but it needs some polishing as it's heavily customizeds on my environment and i need to figure out how to make it open and customizable enough to be used by other people.
adam commented 2025-12-29 20:25:48 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Dec 27, 2023):

This is no longer blocked, however I still don't see a clear path to an implementation.

@jeremystretch commented on GitHub (Dec 27, 2023): This is no longer blocked, however I still don't see a clear path to an implementation.
adam commented 2025-12-29 20:25:48 +01:00
Author
Owner
Copy Link

@coloHsq commented on GitHub (Jan 5, 2024):

I'm starting to see a practical implementation for this one.
By now, the main problem is to make it flexible enough to be used for most of the use cases, but i've managed to solve a big part of this problem so that i can dynamically filter the elements taken for count aggregations, and this solution can be used with stock tables and filters.
This would allow something like "show me all devices that have at least 5 enabled unconnected qsfp+ ports" (or whatever else filter conditions supported on models that are being counted), so one can define what and how to run the aggregations and save'em in a filter.
I still see this feature as best implemented in a specific plugin, as this relays on subqueries annotated on the main one, and it seems quite unlikely i'll be able to modify the core views querysets, unless we decide that this feature is worth to be placed in the core part.

@coloHsq commented on GitHub (Jan 5, 2024): I'm starting to see a practical implementation for this one. By now, the main problem is to make it flexible enough to be used for most of the use cases, but i've managed to solve a big part of this problem so that i can dynamically filter the elements taken for count aggregations, and this solution can be used with stock tables and filters. This would allow something like "show me all devices that have at least 5 enabled unconnected qsfp+ ports" (or whatever else filter conditions supported on models that are being counted), so one can define what and how to run the aggregations and save'em in a filter. I still see this feature as best implemented in a specific plugin, as this relays on subqueries annotated on the main one, and it seems quite unlikely i'll be able to modify the core views querysets, unless we decide that this feature is worth to be placed in the core part.
adam commented 2025-12-29 20:25:48 +01:00
Author
Owner
Copy Link

@coloHsq commented on GitHub (Feb 21, 2024):

Hi, it's been a while since I said I would release a plugin for this.
but finally here it is : https://github.com/coloHsq/aggregatron.git

@coloHsq commented on GitHub (Feb 21, 2024): Hi, it's been a while since I said I would release a plugin for this. but finally here it is : https://github.com/coloHsq/aggregatron.git
adam commented 2025-12-29 20:25:48 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (May 21, 2024):

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. Do not attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our contributing guide.

@github-actions[bot] commented on GitHub (May 21, 2024): This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. NetBox is governed by a small group of core maintainers which means not all opened issues may receive direct feedback. **Do not** attempt to circumvent this process by "bumping" the issue; doing so will result in its immediate closure and you may be barred from participating in any future discussions. Please see our [contributing guide](https://github.com/netbox-community/netbox/blob/develop/CONTRIBUTING.md).
adam commented 2025-12-29 20:25:48 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (May 22, 2024):

I'm going to close this out as no detailed implementation has been agreed upon. Happy to reopen if someone would like to invest the time and effort in drafting a detailed proposal.

@jeremystretch commented on GitHub (May 22, 2024): I'm going to close this out as no detailed implementation has been agreed upon. Happy to reopen if someone would like to invest the time and effort in drafting a detailed proposal.
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 pending closure status: under review 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#7585
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?