Add support for a vsphere_distributed_port_group data source

[pezhore]

Description

Although we have a resource for creating/manipulating a new distributed port group, there is no data source for retrieving a current distributed port group. This is challenging when attempting to use other resources (e.g. vsphere_entity_permissions) - requiring the end user to find the mo-ref/entity id manually.

The data resource would require a parent distributed virtual switch id and a port group name (used for searching/filtering distributed port groups). For brevity, I chose dvs_id but that could easily be virtualswitch_id or something else that's more robust.

Potential Terraform Configuration

data "vsphere_datacenter" "datacenter" {
  name = "dc1"
}

data "vsphere_distributed_virtual_switch" "dvs" {
  name          = "terraform-test-dvs"
  datacenter_id = data.vsphere_datacenter.datacenter.id
}

data "vsphere_distributed_port_group" "my-dvpg" {
 name   = "terraform-test-dvpg"
 dvs_id = data.vspherer_distributed_virtual_switch.dvs.id
}

References

Community Note

• Please vote on this issue by adding a 👍 reaction to the original issue to help the community and maintainers prioritize this request
• Please do not leave "+1" or other comments that do not add relevant new information or questions, they generate extra noise for issue followers and do not help prioritize the request
• If you are interested in working on this issue or have submitted a pull request, please leave a comment

[cerrakoth]

To add colour to why this would be useful - We would like to start deploying VMs via Terraform in an environment which already contains distributed port groups. We currently would need to create a new dpg managed by Terraform or import the existing dpg to the state which is not an optimal way of doing this.

[burnsjared0415]

so this was just write for vsphere_network to pull back the distribution or standard switch portgroup by network_type and name would it work for this problem?
#2281

[pezhore]

That might work? From my read of the Changelog on that PR, it would seem to cover my use case.

[burnsjared0415]

i updated it so it would look like this

data "vsphere_datacenter" "datacenter" {
  name = "dc-01"
}

data "vsphere_network" "my_port_group" {
  datacenter_id = data.vsphere_datacenter.datacenter.id
  name          = "VM Network"
  network_type = "Network"
  }

give it a run through, we can create a new data source with the same type code but did not know if this would work

[pezhore]

yeah that should work for me.!

[burnsjared0415]

I had to make a couple changes to the code, once it is release it, i will close out this issue

[github-actions]

This functionality has been released in v2.10.0 of the Terraform Provider. Please see the Terraform documentation on provider versioning or reach out if you need any assistance upgrading.

For further feature requests or bug reports with this functionality, please create a new GitHub issue following the template. Thank you!

[github-actions]

I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.