Apply code formatting recommendations.

hashicorp · Apr 2, 2024 · bc9617e · bc9617e
1 parent 510bffa
commit bc9617e
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 16 deletions.
diff --git a/.web-docs/components/builder/vsphere-iso/README.md b/.web-docs/components/builder/vsphere-iso/README.md
@@ -832,6 +832,8 @@ boot time.
 
 - `destroy` (bool) - Specifies whether to destroy the virtual machine after the build is complete.
 
+- `vapp` (vAppConfig) - Set the vApp properties for a virtual machine.
+
 <!-- End of code generated from the comments of the CreateConfig struct in builder/vsphere/iso/step_create.go; -->
 
 

diff --git a/builder/vsphere/driver/vm.go b/builder/vsphere/driver/vm.go
@@ -121,18 +121,19 @@ type NIC struct {
 }
 
 type CreateConfig struct {
-	Annotation    string
-	Name          string
-	Folder        string
-	Cluster       string
-	Host          string
-	ResourcePool  string
-	Datastore     string
-	GuestOS       string // example: otherGuest
-	NICs          []NIC
-	USBController []string
-	Version       uint // example: 10
-	StorageConfig StorageConfig
+	Annotation     string
+	Name           string
+	Folder         string
+	Cluster        string
+	Host           string
+	ResourcePool   string
+	Datastore      string
+	GuestOS        string // example: otherGuest
+	NICs           []NIC
+	USBController  []string
+	Version        uint // example: 10
+	StorageConfig  StorageConfig
+	VAppProperties map[string]string
 }
 
 func (d *VCenterDriver) NewVM(ref *types.ManagedObjectReference) VirtualMachine {

diff --git a/builder/vsphere/iso/step_create.go b/builder/vsphere/iso/step_create.go
@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: MPL-2.0
 
 //go:generate packer-sdc struct-markdown
-//go:generate packer-sdc mapstructure-to-hcl2 -type NIC,CreateConfig
+//go:generate packer-sdc mapstructure-to-hcl2 -type NIC,CreateConfig,vAppConfig
 
 package iso
 
@@ -110,7 +110,8 @@ type CreateConfig struct {
 	Notes string `mapstructure:"notes"`
 	// Specifies whether to destroy the virtual machine after the build is complete.
 	Destroy bool `mapstructure:"destroy"`
-	VAppConfig    vAppConfig           `mapstructure:"vapp"`
+	// Set the vApp properties for a virtual machine.
+	VAppConfig vAppConfig `mapstructure:"vapp"`
 }
 
 func (c *CreateConfig) Prepare() []error {
@@ -197,7 +198,7 @@ func (s *StepCreateVM) Run(_ context.Context, state multistep.StateBag) multiste
 	}
 
 	vm, err := d.CreateVM(&driver.CreateConfig{
-		VAppProperties:  s.Config.VAppConfig.Properties,
+		VAppProperties: s.Config.VAppConfig.Properties,
 		StorageConfig: driver.StorageConfig{
 			DiskControllerType: s.Config.StorageConfig.DiskControllerType,
 			Storage:            disks,

diff --git a/builder/vsphere/iso/step_create_test.go b/builder/vsphere/iso/step_create_test.go
@@ -401,7 +401,7 @@ func driverCreateConfig(config *CreateConfig, location *common.LocationConfig) *
 	}
 
 	return &driver.CreateConfig{
-		VAppProperties:  config.VAppConfig.Properties,
+		VAppProperties: config.VAppConfig.Properties,
 		StorageConfig: driver.StorageConfig{
 			DiskControllerType: config.StorageConfig.DiskControllerType,
 			Storage:            disks,

diff --git a/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx b/docs-partials/builder/vsphere/iso/CreateConfig-not-required.mdx
@@ -31,4 +31,6 @@
 
 - `destroy` (bool) - Specifies whether to destroy the virtual machine after the build is complete.
 
+- `vapp` (vAppConfig) - Set the vApp properties for a virtual machine.
+
 <!-- End of code generated from the comments of the CreateConfig struct in builder/vsphere/iso/step_create.go; -->
diff --git a/docs-partials/builder/vsphere/iso/vAppConfig-not-required.mdx b/docs-partials/builder/vsphere/iso/vAppConfig-not-required.mdx
@@ -0,0 +1,11 @@
+<!-- Code generated from the comments of the vAppConfig struct in builder/vsphere/iso/step_create.go; DO NOT EDIT MANUALLY -->
+
+- `properties` (map[string]string) - Set values for the available vApp Properties to supply configuration parameters to a virtual machine cloned from
+  a template that came from an imported OVF or OVA file.
+
+  -> **Note:** The only supported usage path for vApp properties is for existing user-configurable keys.
+  These generally come from an existing template that was created from an imported 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.
+
+<!-- End of code generated from the comments of the vAppConfig struct in builder/vsphere/iso/step_create.go; -->