Vm_Hardware_Info | vSphere Automation API

Vm_Hardware_Info

The Hardware.Info structure contains information related to the virtual hardware of a virtual machine.

JSON Example

{
    "version": "string",
    "upgrade_policy": "string",
    "upgrade_version": "string",
    "upgrade_status": "string",
    "upgrade_error": {}
}

Vm_Hardware_Version

version

Required

The Hardware.Version enumerated type defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)).
VMX_03 : Hardware version 3, first supported in ESXi 2.5.
VMX_04 : Hardware version 4, first supported in ESXi 3.0.
VMX_06 : Hardware version 6, first supported in WS 6.0.
VMX_07 : Hardware version 7, first supported in ESXi 4.0.
VMX_08 : Hardware version 8, first supported in ESXi 5.0.
VMX_09 : Hardware version 9, first supported in ESXi 5.1.
VMX_10 : Hardware version 10, first supported in ESXi 5.5.
VMX_11 : Hardware version 11, first supported in ESXi 6.0.
VMX_12 : Hardware version 12, first supported in Workstation 12.0.
VMX_13 : Hardware version 13, first supported in ESXi 6.5.
VMX_14 : Hardware version 14, first supported in ESXi 6.7.
VMX_15 : Hardware version 15, first supported in ESXi 6.7 Update 2.
VMX_16 : Hardware version 16, first supported in Workstation 15.0.
VMX_17 : Hardware version 17, first supported in ESXi 7.0.0-0.
VMX_18 : Hardware version 18, first supported in ESXi 7.0 U1.
VMX_19 : Hardware version 19, first supported in ESXi 7.0 U2.
VMX_20 : Hardware version 20, first supported in ESXi 8.0.0.1.

Vm_Hardware_UpgradePolicy

upgrade_policy

Required

The Hardware.UpgradePolicy enumerated type defines the valid virtual hardware upgrade policies for a virtual machine.
NEVER : Do not upgrade the virtual machine when it is powered on.
AFTER_CLEAN_SHUTDOWN : Run scheduled upgrade when the virtual machine is powered on after a clean shutdown of the guest operating system.
ALWAYS : Run scheduled upgrade when the virtual machine is powered on.

Vm_Hardware_Version

upgrade_version

Optional

Vm_Hardware_UpgradeStatus

upgrade_status

Required

The Hardware.UpgradeStatus enumerated type defines the valid virtual hardware upgrade statuses for a virtual machine.
NONE : No scheduled upgrade has been attempted.
PENDING : Upgrade is scheduled but has not yet been run.
SUCCESS : The most recent scheduled upgrade was successful.
FAILED : The most recent scheduled upgrade was not successful.

object

upgrade_error

Optional

Reason for the scheduled upgrade failure. This field is optional and it is only relevant when the value of Hardware.Info.upgrade-status is FAILED.