r/vm: Support hardware versions

vsphere/internal/helper/virtualmachine/virtual_machine_helper.go

@@ -9,6 +9,7 @@ import (
 	"github.com/vmware/govmomi/vapi/vcenter"
 	"log"
 	"net"
+	"strconv"
 	"strings"
 	"time"
 
@@ -712,6 +713,22 @@ func Reconfigure(vm *object.VirtualMachine, spec types.VirtualMachineConfigSpec)
 	return task.Wait(tctx)
 }
 
+// UpgradeHardwareVersion attempts to upgrade the hardware version on the
+// specified virtual machine. The virtual machine must be powered off.
+func UpgradeHardwareVersion(vm *object.VirtualMachine, version int) error {
+	log.Printf("[DEBUG] Upgrading virtual machine %q", vm.InventoryPath)
+	ctx, cancel := context.WithTimeout(context.Background(), provider.DefaultAPITimeout)
+	defer cancel()
+	vm.UpgradeVM(ctx, GetHardwareVersionID(version))
+	task, err := vm.UpgradeVM(ctx, GetHardwareVersionID(version))
+	if err != nil {
+		return err
+	}
+	tctx, tcancel := context.WithTimeout(context.Background(), provider.DefaultAPITimeout)
+	defer tcancel()
+	return task.Wait(tctx)
+}
+
 // Relocate wraps the Relocate task and the subsequent waiting for the task to
 // complete.
 func Relocate(vm *object.VirtualMachine, spec types.VirtualMachineRelocateSpec, timeout int) error {
@@ -865,3 +882,59 @@ func (r MOIDForUUIDResults) UUIDs() []string {
 	}
 	return uuids
 }
+
+// GetHardwareVersionID gets the hardware version string from integer
+func GetHardwareVersionID(vint int) string {
+	// hardware_version isn't set, so return an empty string.
+	if vint == 0 {
+		return ""
+	}
+	return fmt.Sprintf("vmx-%d", vint)
+}
+
+// GetHardwareVersionNumber gets the hardware version number from string.
+func GetHardwareVersionNumber(vstring string) int {
+	vstring = strings.TrimPrefix(vstring, "vmx-")
+	v, err := strconv.Atoi(vstring)
+	if err != nil {
+		log.Printf("[DEBUG] Unable to parse hardware version: %s", vstring)
+	}
+	return v
+}
+
+// SetHardwareVersion sets the virtual machine's hardware version.
+func SetHardwareVersion(vm *object.VirtualMachine, target int) error {
+	// First get current and target versions and validate
+	tv := GetHardwareVersionID(target)
+	vprops, err := Properties(vm)
+	if err != nil {
+		return err
+	}
+	cv := vprops.Config.Version
+	// Skip the rest if there is no version change.
+	if cv == tv {
+		return nil
+	}
+	if err := ValidateHardwareVersion(GetHardwareVersionNumber(cv), target); err != nil {
+		return err
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), provider.DefaultAPITimeout)
+	defer cancel()
+
+	task, err := vm.UpgradeVM(ctx, tv)
+	_, err = task.WaitForResult(ctx, nil)
+	return err
+}
+
+// ValidateHardwareVersion checks that the target hardware version is equal to
+// or greater than the current hardware version.
+func ValidateHardwareVersion(current, target int) error {
+	switch {
+	case target == 0:
+		return nil
+	case target < current:
+		return fmt.Errorf("Cannot downgrade virtual machine hardware version. current: %s, target: %s", current, target)
+	}
+	return nil
+}

vsphere/resource_vsphere_virtual_machine.go

@@ -609,6 +609,11 @@ func resourceVSphereVirtualMachineUpdate(d *schema.ResourceData, meta interface{
 		return err
 	}
 	// Only carry out the reconfigure if we actually have a change to process.
+	cv := virtualmachine.GetHardwareVersionNumber(vprops.Config.Version)
+	tv := d.Get("hardware_version").(int)
+	if tv > cv {
+		d.Set("reboot_required", true)
+	}
 	if changed || len(spec.DeviceChange) > 0 {
 		//Check to see if we need to shutdown the VM for this process.
 		if d.Get("reboot_required").(bool) && vprops.Runtime.PowerState != types.VirtualMachinePowerStatePoweredOff {
@@ -668,6 +673,12 @@ func resourceVSphereVirtualMachineUpdate(d *schema.ResourceData, meta interface{
 			err = virtualmachine.Reconfigure(vm, spec)
 		}
 
+		// Upgrade the VM's hardware version if needed.
+		err = virtualmachine.SetHardwareVersion(vm, d.Get("hardware_version").(int))
+		if err != nil {
+			return err
+		}
+
 		// Regardless of the result we no longer need to watch for pending questions.
 		gChan <- true
 
@@ -711,6 +722,7 @@ func resourceVSphereVirtualMachineUpdate(d *schema.ResourceData, meta interface{
 			}
 		}
 	}
+
 	// Now safe to turn off partial mode.
 	d.Partial(false)
 	d.Set("reboot_required", false)
@@ -886,6 +898,11 @@ func resourceVSphereVirtualMachineCustomizeDiff(d *schema.ResourceDiff, meta int
 			}
 		}
 	}
+
+	// Validate hardware version changes.
+	cv, tv := d.GetChange("hardware_version")
+	virtualmachine.ValidateHardwareVersion(cv.(int), tv.(int))
+
 	// Validate that the config has the necessary components for vApp support.
 	// Note that for clones the data is prepopulated in
 	// ValidateVirtualMachineClone.
@@ -1376,6 +1393,12 @@ func resourceVSphereVirtualMachineCreateClone(d *schema.ResourceData, meta inter
 		)
 	}
 
+	// Upgrade the VM's hardware version if needed.
+	err = virtualmachine.SetHardwareVersion(vm, d.Get("hardware_version").(int))
+	if err != nil {
+		return nil, err
+	}
+
 	var cw *virtualMachineCustomizationWaiter
 	// Send customization spec if any has been defined.
 	if len(d.Get("clone.0.customize").([]interface{})) > 0 {