Update docs example for templates that use ISO transport

Clarifies that templates that use ISO transport, a CD-ROM backed by a client device must be included and provides and example. Closes #1292 Signed-off-by: Ryan Johnson <[email protected]>
hashicorp · Feb 3, 2022 · 8399d5f · 8399d5f
1 parent 6e7a9e0
commit 8399d5f
Showing 1 changed file with 24 additions and 3 deletions.
diff --git a/website/docs/r/virtual_machine.html.markdown b/website/docs/r/virtual_machine.html.markdown
@@ -160,7 +160,6 @@ resource "vsphere_virtual_machine" "vm" {
   disk {
     label            = "disk0"
     size             = data.vsphere_virtual_machine.template.disks.0.size
-    eagerly_scrub    = data.vsphere_virtual_machine.template.disks.0.eagerly_scrub
     thin_provisioned = data.vsphere_virtual_machine.template.disks.0.thin_provisioned
   }
   clone {
@@ -544,7 +543,6 @@ resource "vsphere_virtual_machine" "vm" {
   disk {
     name             = "disk0"
     size             = data.vsphere_virtual_machine.template_from_ovf.disks.0.size
-    eagerly_scrub    = data.vsphere_virtual_machine.template_from_ovf.disks.0.eagerly_scrub
     thin_provisioned = data.vsphere_virtual_machine.template_from_ovf.disks.0.thin_provisioned
   }
   clone {
@@ -1291,7 +1289,30 @@ The options available in the `ovf_deploy` block are:
 
 ### Using vApp Properties for OVF/OVA Configuration
 
-You can use the `properties` section of the `vapp` block to supply configuration parameters to a virtual machine cloned from a template that originated from an imported OVF/OVA file. Both GuestInfo and ISO transport methods are supported. For templates that use ISO transport, a CD-ROM backed by a client device must be included. See the section on [CD-ROM options](#cd-rom-options) for more information. 
+You can use the `properties` section of the `vapp` block to supply configuration parameters to a virtual machine cloned from a template that originated from an imported OVF/OVA file. Both GuestInfo and ISO transport methods are supported. 
+
+For templates that use ISO transport, a CD-ROM backed by a client device must be included. 
+
+**Example**:
+
+```hcl
+resource "vsphere_virtual_machine" "vm" {
+  # ... other configuration ...
+  clone {
+    template_uuid = data.vsphere_virtual_machine.template_from_ovf.id
+  }
+  cdrom {
+    client_device = true
+  }
+  vapp {
+    properties = {
+      guestinfo.terraform.id = "foo"
+    }
+  }
+}
+```
+
+See the section on [CD-ROM options](#cd-rom-options) for more information. 
 
 ~> **NOTE:** The only supported usage path for vApp properties is for existing user-configurable keys. These generally come from an existing template created by importing an OVF or OVA file. You cannot set values for vApp properties on virtual machines created from scratch, virtual machines lacking a vApp configuration, or on property keys that do not exist.