Add VM Count to Clusters Export #1562

New Issue

adam · 2025-12-29T16:32:58+01:00

adam commented

2025-12-29 16:32:58 +01:00

Originally created by @iDemonix on GitHub (Feb 19, 2018).

Issue type

[x] Feature request

Description

When exporting clusters to CSV or similar, one of the most useful pieces of information is the VM Count (which is included in the default Clusters table). Would it be possible to add this (and maybe host count) either to the default export, or allow it to be pulled using an export template?

There are counts on virtualization/clusters/1/ but not api/virtualization/clusters/1/, maybe it'd be worth adding the counts to this too?

Originally created by @iDemonix on GitHub (Feb 19, 2018). ### Issue type [x] Feature request   ### Description When exporting clusters to CSV or similar, one of the most useful pieces of information is the VM Count (which is included in the default Clusters table). Would it be possible to add this (and maybe host count) either to the default export, or allow it to be pulled using an export template? There are counts on `virtualization/clusters/1/` but not `api/virtualization/clusters/1/`, maybe it'd be worth adding the counts to this too?

adam closed this issue

2025-12-29 16:32:58 +01:00

adam commented

2025-12-29 16:32:59 +01:00

@mabazyar commented on GitHub (Feb 20, 2018):

Yeah, confirming, this feature makes our life a lot easier too.

@mabazyar commented on GitHub (Feb 20, 2018): Yeah, confirming, this feature makes our life a lot easier too.

adam commented

2025-12-29 16:32:59 +01:00

@jeremystretch commented on GitHub (Feb 21, 2018):

The built-in CSV export is limited to data directly associated with each object; it is essentially the complement to the CSV import approach. This does not entail statistical information such as VM/host count, however NetBox allows you to create your own custom export template to retrieve this information.

As for the API serializer, AFAICT the only place we currently include counts of child objects is on the site model (count_prefixes, count_devices, etc.). (And incidentally, a count of virtual machines is missing from the serializer.) I'm not against adding similar counts to Cluster and other models, but we probably want to give more thought to how that data is conveyed.

@jeremystretch commented on GitHub (Feb 21, 2018): The built-in CSV export is limited to data directly associated with each object; it is essentially the complement to the CSV import approach. This does not entail statistical information such as VM/host count, however NetBox allows you to create your own custom [export template](http://netbox.readthedocs.io/en/stable/data-model/extras/#export-templates) to retrieve this information. As for the API serializer, AFAICT the only place we currently include counts of child objects is on the site model (`count_prefixes`, `count_devices`, etc.). (And incidentally, a count of virtual machines is missing from the serializer.) I'm not against adding similar counts to Cluster and other models, but we probably want to give more thought to how that data is conveyed.

adam commented

2025-12-29 16:32:59 +01:00

@iDemonix commented on GitHub (Feb 21, 2018):

Hi @jeremystretch, are you saying it's possible to have the count of VMs (for example) in an export template? I wasn't sure if that was possible, but if it is then that's all I was aiming to request - would you mind showing an example or pointing to the docs for that?

@iDemonix commented on GitHub (Feb 21, 2018): Hi @jeremystretch, are you saying it's possible to have the count of VMs (for example) in an export template? I wasn't sure if that was possible, but if it is then that's all I was aiming to request - would you mind showing an example or pointing to the docs for that?

adam commented

2025-12-29 16:33:00 +01:00

@jeremystretch commented on GitHub (Feb 21, 2018):

In the admin UI, go to Extras -> Export Templates and create a new template for "virtualization > cluster". You can do something like this to get the VM count for each cluster:

{% for cluster in queryset %}{{ cluster.name }}: {{ cluster.virtual_machines.count }}
{% endfor %}

@jeremystretch commented on GitHub (Feb 21, 2018): In the admin UI, go to Extras -> Export Templates and create a new template for "virtualization > cluster". You can do something like this to get the VM count for each cluster: ``` {% for cluster in queryset %}{{ cluster.name }}: {{ cluster.virtual_machines.count }} {% endfor %} ```

adam commented

2025-12-29 16:33:00 +01:00

@iDemonix commented on GitHub (Feb 21, 2018):

Thanks Jeremy!

I'll close this issue as that's the exact functionality I was after. Maybe it'd be worth mentioning that counts are possible in the docs for Export Templates as it seems both me and @mabazyar missed it.

@iDemonix commented on GitHub (Feb 21, 2018): Thanks Jeremy! I'll close this issue as that's the exact functionality I was after. Maybe it'd be worth mentioning that counts are possible in the docs for Export Templates as it seems both me and @mabazyar missed it.

Sign in to join this conversation.

Branches Tags

main

update-changelog-comments-docs

feature-removal-issue-type

20911-dropdown

20239-plugin-menu-classes-mutable-state

21097-graphql-id-lookups

feature

fix_module_substitution

20923-dcim-templates

20044-elevation-stuck-lightmode

feature-ip-prefix-link

v4.5-beta1-release

20068-import-moduletype-attrs

20766-fix-german-translation-code-literals

20378-del-script

7604-filter-modifiers-v3

circuit-swap

12318-case-insensitive-uniqueness

20637-improve-device-q-filter

20660-script-load

19724-graphql

20614-update-ruff

14884-script

02496-max-page

19720-macaddress-interface-generic-relation

19408-circuit-terminations-export-templates

20203-openapi-check

fix-19669-api-image-download

7604-filter-modifiers

19275-fixes-interface-bulk-edit

fix-17794-get_field_value_return_list

11507-show-aggregate-and-rir-on-api

9583-add_column_specific_search_field_to_tables

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/netbox#1562