Please add usage examples of customization_spec in the virual machine resource documentation

[MajorDallas]

Community Guidelines

• I have read and agree to the HashiCorp Community Guidelines .
• Vote on this issue by adding a 👍 reaction to the original issue initial description to help the maintainers prioritize.
• Do not leave "+1" or other comments that do not add relevant information or questions.
• If you are interested in working on this issue or have submitted a pull request, please leave a comment.

Description

The customization_spec option to clone blocks and corresponding vsphere_guest_os_customization resources are very new. The resources are documented; however, using one to customize a clone-from-template operation is not. The only example I could find was in #2079 (which gets a +1 from me, as well).

A new bullet point in the relevant section and an example would be greatly appreciated. Example, sans any details I haven't observed from usage attempts so far:

The options available in the clone block are:

• ...
• customization_spec: (Optional) A pre-defined customization spec for this clone. This allows the user to apply a customization spec defined in vCenter. See Customizing Guest Operating Systems for more information. Mutually exclusive with the customize block. Note that as of v2.6.1 this feature does not support providing values that are populated by prompting the user or overriding/filling in options defined/not defined in the GOSC.
  ...

  clone {
    customization_spec {
     id = data.vsphere_guest_os_customization.gosc1.id
   }

Use Case(s)

Users who aren't closely monitoring the release notes of this plugin will benefit from the added visibility for this new feature. I cannot speak for anyone else, but while I did notice the links to the resource docs I did not even consider using them because there was no mention of the possibility in the customizations section; I had to stumble on #2079 while searching about a different but related problem before I thought to try it.

Potential Terraform Provider Configuration

No response

References

https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs/resources/virtual_machine#virtual-machine-customizations
https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs/data-sources/guest_os_customization
https://registry.terraform.io/providers/hashicorp/vsphere/latest/docs/resources/guest_os_customization
#2079

[github-actions]

Hello, MajorDallas! 🖐

Thank you for submitting an issue for this provider. The issue will now enter into the issue lifecycle.

If you want to contribute to this project, please review the contributing guidelines and information on submitting pull requests.