1. Types
  2. vcenter
  3. vm

vcenter VM: info

Document-based info.

Representation:

{
    "instant_clone_frozen" : true,
    "cdroms" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "auto_detect" : true,
                "device_access_type" : "EMULATION",
                "iso_file" : "string",
                "type" : "ISO_FILE",
                "host_device" : "string"
            },
            "allow_guest_control" : true,
            "state" : "CONNECTED",
            "label" : "string",
            "ide" : {
                "primary" : true,
                "master" : true
            },
            "type" : "IDE",
            "sata" : {
                "bus" : 1,
                "unit" : 1
            }
        }
    },
    "memory" : {
        "hot_add_increment_size_MiB" : 1,
        "size_MiB" : 1,
        "hot_add_enabled" : true,
        "hot_add_limit_MiB" : 1
    },
    "disks" : {
        "obj-103" : {
            "scsi" : {
                "bus" : 1,
                "unit" : 1
            },
            "nvme" : {
                "bus" : 1,
                "unit" : 1
            },
            "backing" : {
                "vmdk_file" : "string",
                "type" : "VMDK_FILE"
            },
            "label" : "string",
            "ide" : {
                "primary" : true,
                "master" : true
            },
            "type" : "IDE",
            "sata" : {
                "bus" : 1,
                "unit" : 1
            },
            "capacity" : 1
        }
    },
    "parallel_ports" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "file" : "string",
                "auto_detect" : true,
                "type" : "FILE",
                "host_device" : "string"
            },
            "allow_guest_control" : true,
            "state" : "CONNECTED",
            "label" : "string"
        }
    },
    "sata_adapters" : {
        "obj-103" : {
            "bus" : 1,
            "pci_slot_number" : 1,
            "label" : "string",
            "type" : "AHCI"
        }
    },
    "cpu" : {
        "hot_remove_enabled" : true,
        "count" : 1,
        "hot_add_enabled" : true,
        "cores_per_socket" : 1
    },
    "scsi_adapters" : {
        "obj-103" : {
            "scsi" : {
                "bus" : 1,
                "unit" : 1
            },
            "pci_slot_number" : 1,
            "label" : "string",
            "type" : "BUSLOGIC",
            "sharing" : "NONE"
        }
    },
    "power_state" : "POWERED_OFF",
    "floppies" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "auto_detect" : true,
                "image_file" : "string",
                "type" : "IMAGE_FILE",
                "host_device" : "string"
            },
            "allow_guest_control" : true,
            "state" : "CONNECTED",
            "label" : "string"
        }
    },
    "identity" : {
        "name" : "string",
        "instance_uuid" : "string",
        "bios_uuid" : "string"
    },
    "nvme_adapters" : {
        "obj-103" : {
            "bus" : 1,
            "pci_slot_number" : 1,
            "label" : "string"
        }
    },
    "name" : "string",
    "nics" : {
        "obj-103" : {
            "start_connected" : true,
            "pci_slot_number" : 1,
            "backing" : {
                "connection_cookie" : 1,
                "distributed_switch_uuid" : "string",
                "distributed_port" : "string",
                "network_name" : "string",
                "opaque_network_type" : "string",
                "type" : "STANDARD_PORTGROUP",
                "host_device" : "string",
                "opaque_network_id" : "string",
                "network" : "obj-103"
            },
            "mac_address" : "string",
            "mac_type" : "MANUAL",
            "allow_guest_control" : true,
            "wake_on_lan_enabled" : true,
            "state" : "CONNECTED",
            "label" : "string",
            "type" : "E1000",
            "upt_compatibility_enabled" : true
        }
    },
    "boot" : {
        "delay" : 1,
        "efi_legacy_boot" : true,
        "retry_delay" : 1,
        "enter_setup_mode" : true,
        "type" : "BIOS",
        "network_protocol" : "IPV4",
        "retry" : true
    },
    "serial_ports" : {
        "obj-103" : {
            "start_connected" : true,
            "backing" : {
                "proxy" : "http://myurl.com",
                "file" : "string",
                "auto_detect" : true,
                "pipe" : "string",
                "type" : "FILE",
                "host_device" : "string",
                "no_rx_loss" : true,
                "network_location" : "http://myurl.com"
            },
            "allow_guest_control" : true,
            "yield_on_poll" : true,
            "state" : "CONNECTED",
            "label" : "string"
        }
    },
    "guest_OS" : "DOS",
    "boot_devices" : [
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        },
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        }
    ],
    "hardware" : {
        "upgrade_policy" : "NEVER",
        "upgrade_status" : "NONE",
        "upgrade_error" : {},
        "upgrade_version" : "VMX_03",
        "version" : "VMX_03"
    }
}
{
    "instant_clone_frozen" : true,
    "cdroms" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "auto_detect" : true,
                    "device_access_type" : "EMULATION",
                    "iso_file" : "string",
                    "type" : "ISO_FILE",
                    "host_device" : "string"
                },
                "allow_guest_control" : true,
                "state" : "CONNECTED",
                "label" : "string",
                "ide" : {
                    "primary" : true,
                    "master" : true
                },
                "type" : "IDE",
                "sata" : {
                    "bus" : 1,
                    "unit" : 1
                }
            },
            "key" : "obj-103"
        }
    ],
    "memory" : {
        "hot_add_increment_size_MiB" : 1,
        "size_MiB" : 1,
        "hot_add_enabled" : true,
        "hot_add_limit_MiB" : 1
    },
    "disks" : [
        {
            "value" : {
                "scsi" : {
                    "bus" : 1,
                    "unit" : 1
                },
                "nvme" : {
                    "bus" : 1,
                    "unit" : 1
                },
                "backing" : {
                    "vmdk_file" : "string",
                    "type" : "VMDK_FILE"
                },
                "label" : "string",
                "ide" : {
                    "primary" : true,
                    "master" : true
                },
                "type" : "IDE",
                "sata" : {
                    "bus" : 1,
                    "unit" : 1
                },
                "capacity" : 1
            },
            "key" : "obj-103"
        }
    ],
    "parallel_ports" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "file" : "string",
                    "auto_detect" : true,
                    "type" : "FILE",
                    "host_device" : "string"
                },
                "allow_guest_control" : true,
                "state" : "CONNECTED",
                "label" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "sata_adapters" : [
        {
            "value" : {
                "bus" : 1,
                "pci_slot_number" : 1,
                "label" : "string",
                "type" : "AHCI"
            },
            "key" : "obj-103"
        }
    ],
    "cpu" : {
        "hot_remove_enabled" : true,
        "count" : 1,
        "hot_add_enabled" : true,
        "cores_per_socket" : 1
    },
    "scsi_adapters" : [
        {
            "value" : {
                "scsi" : {
                    "bus" : 1,
                    "unit" : 1
                },
                "pci_slot_number" : 1,
                "label" : "string",
                "type" : "BUSLOGIC",
                "sharing" : "NONE"
            },
            "key" : "obj-103"
        }
    ],
    "power_state" : "POWERED_OFF",
    "floppies" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "auto_detect" : true,
                    "image_file" : "string",
                    "type" : "IMAGE_FILE",
                    "host_device" : "string"
                },
                "allow_guest_control" : true,
                "state" : "CONNECTED",
                "label" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "identity" : {
        "name" : "string",
        "instance_uuid" : "string",
        "bios_uuid" : "string"
    },
    "nvme_adapters" : [
        {
            "value" : {
                "bus" : 1,
                "pci_slot_number" : 1,
                "label" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "name" : "string",
    "nics" : [
        {
            "value" : {
                "start_connected" : true,
                "pci_slot_number" : 1,
                "backing" : {
                    "connection_cookie" : 1,
                    "distributed_switch_uuid" : "string",
                    "distributed_port" : "string",
                    "network_name" : "string",
                    "opaque_network_type" : "string",
                    "type" : "STANDARD_PORTGROUP",
                    "host_device" : "string",
                    "opaque_network_id" : "string",
                    "network" : "obj-103"
                },
                "mac_address" : "string",
                "mac_type" : "MANUAL",
                "allow_guest_control" : true,
                "wake_on_lan_enabled" : true,
                "state" : "CONNECTED",
                "label" : "string",
                "type" : "E1000",
                "upt_compatibility_enabled" : true
            },
            "key" : "obj-103"
        }
    ],
    "boot" : {
        "delay" : 1,
        "efi_legacy_boot" : true,
        "retry_delay" : 1,
        "enter_setup_mode" : true,
        "type" : "BIOS",
        "network_protocol" : "IPV4",
        "retry" : true
    },
    "serial_ports" : [
        {
            "value" : {
                "start_connected" : true,
                "backing" : {
                    "proxy" : "http://myurl.com",
                    "file" : "string",
                    "auto_detect" : true,
                    "pipe" : "string",
                    "type" : "FILE",
                    "host_device" : "string",
                    "no_rx_loss" : true,
                    "network_location" : "http://myurl.com"
                },
                "allow_guest_control" : true,
                "yield_on_poll" : true,
                "state" : "CONNECTED",
                "label" : "string"
            },
            "key" : "obj-103"
        }
    ],
    "guest_OS" : "DOS",
    "boot_devices" : [
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        },
        {
            "disks" : [
                "obj-103",
                "obj-103"
            ],
            "nic" : "obj-103",
            "type" : "CDROM"
        }
    ],
    "hardware" : {
        "upgrade_policy" : "NEVER",
        "upgrade_status" : "NONE",
        "upgrade_error" : {},
        "upgrade_version" : "VMX_03",
        "version" : "VMX_03"
    }
}

Attributes:

Name Type Description
Required
-.guest_OS string Guest OS.

Defines the valid guest operating system types used for configuring a virtual machine. Value is one of:
DOS: MS-DOS.
WIN_31: Windows 3.1
WIN_95: Windows 95
WIN_98: Windows 98
WIN_ME: Windows Millennium Edition
WIN_NT: Windows NT 4
WIN_2000_PRO: Windows 2000 Professional
WIN_2000_SERV: Windows 2000 Server
WIN_2000_ADV_SERV: Windows 2000 Advanced Server
WIN_XP_HOME: Windows XP Home Edition
WIN_XP_PRO: Windows XP Professional
WIN_XP_PRO_64: Windows XP Professional Edition (64 bit)
WIN_NET_WEB: Windows Server 2003, Web Edition
WIN_NET_STANDARD: Windows Server 2003, Standard Edition
WIN_NET_ENTERPRISE: Windows Server 2003, Enterprise Edition
WIN_NET_DATACENTER: Windows Server 2003, Datacenter Edition
WIN_NET_BUSINESS: Windows Small Business Server 2003
WIN_NET_STANDARD_64: Windows Server 2003, Standard Edition (64 bit)
WIN_NET_ENTERPRISE_64: Windows Server 2003, Enterprise Edition (64 bit)
WIN_LONGHORN: Windows Longhorn (experimental)
WIN_LONGHORN_64: Windows Longhorn (64 bit) (experimental)
WIN_NET_DATACENTER_64: Windows Server 2003, Datacenter Edition (64 bit) (experimental)
WIN_VISTA: Windows Vista
WIN_VISTA_64: Windows Vista (64 bit)
WINDOWS_7: Windows 7
WINDOWS_7_64: Windows 7 (64 bit)
WINDOWS_7_SERVER_64: Windows Server 2008 R2 (64 bit)
WINDOWS_8: Windows 8
WINDOWS_8_64: Windows 8 (64 bit)
WINDOWS_8_SERVER_64: Windows 8 Server (64 bit)
WINDOWS_9: Windows 10
WINDOWS_9_64: Windows 10 (64 bit)
WINDOWS_9_SERVER_64: Windows 10 Server (64 bit)
WINDOWS_HYPERV: Windows Hyper-V
WINDOWS_SERVER_2019: Windows Server 2019. This constant was added in vSphere API 7.0.0.0.
WINDOWS_SERVER_2021: Windows Server 2021. This constant was added in vSphere API 7.0.1.0.
FREEBSD: FreeBSD 10 or earlier
FREEBSD_64: FreeBSD 10 x64 or earlier
FREEBSD_11: FreeBSD 11. This constant was added in vSphere API 6.7.
FREEBSD_12: FreeBSD 12. This constant was added in vSphere API 6.7.
FREEBSD_13: FreeBSD 13 or later. This constant was added in vSphere API 7.0.1.0.
FREEBSD_11_64: FreeBSD 11 x64. This constant was added in vSphere API 6.7.
FREEBSD_12_64: FreeBSD 12 x64. This constant was added in vSphere API 6.7.
FREEBSD_13_64: FreeBSD 13 x64 or later. This constant was added in vSphere API 7.0.1.0.
REDHAT: Red Hat Linux 2.1
RHEL_2: Red Hat Enterprise Linux 2
RHEL_3: Red Hat Enterprise Linux 3
RHEL_3_64: Red Hat Enterprise Linux 3 (64 bit)
RHEL_4: Red Hat Enterprise Linux 4
RHEL_4_64: Red Hat Enterprise Linux 4 (64 bit)
RHEL_5: Red Hat Enterprise Linux 5
RHEL_5_64: Red Hat Enterprise Linux 5 (64 bit) (experimental)
RHEL_6: Red Hat Enterprise Linux 6
RHEL_6_64: Red Hat Enterprise Linux 6 (64 bit)
RHEL_7: Red Hat Enterprise Linux 7
RHEL_7_64: Red Hat Enterprise Linux 7 (64 bit)
RHEL_8_64: Red Hat Enterprise Linux 8 (64 bit). This constant was added in vSphere API 6.7.
RHEL_9_64: Red Hat Enterprise Linux 9 (64 bit). This constant was added in vSphere API 7.0.1.0.
CENTOS: CentOS 4/5
CENTOS_64: CentOS 4/5 (64-bit)
CENTOS_6: CentOS 6
CENTOS_6_64: CentOS 6 (64-bit)
CENTOS_7: CentOS 7
CENTOS_7_64: CentOS 7 (64-bit)
CENTOS_8_64: CentOS 8 (64-bit). This constant was added in vSphere API 6.7.
CENTOS_9_64: CentOS 9 (64-bit). This constant was added in vSphere API 7.0.1.0.
ORACLE_LINUX: Oracle Linux 4/5
ORACLE_LINUX_64: Oracle Linux 4/5 (64-bit)
ORACLE_LINUX_6: Oracle Linux 6
ORACLE_LINUX_6_64: Oracle Linux 6 (64-bit)
ORACLE_LINUX_7: Oracle Linux 7
ORACLE_LINUX_7_64: Oracle Linux 7 (64-bit)
ORACLE_LINUX_8_64: Oracle Linux 8 (64-bit). This constant was added in vSphere API 6.7.
ORACLE_LINUX_9_64: Oracle Linux 9 (64-bit). This constant was added in vSphere API 7.0.1.0.
SUSE: Suse Linux
SUSE_64: Suse Linux (64 bit)
SLES: Suse Linux Enterprise Server 9
SLES_64: Suse Linux Enterprise Server 9 (64 bit)
SLES_10: Suse linux Enterprise Server 10
SLES_10_64: Suse Linux Enterprise Server 10 (64 bit) (experimental)
SLES_11: Suse linux Enterprise Server 11
SLES_11_64: Suse Linux Enterprise Server 11 (64 bit)
SLES_12: Suse linux Enterprise Server 12
SLES_12_64: Suse Linux Enterprise Server 12 (64 bit)
SLES_15_64: Suse Linux Enterprise Server 15 (64 bit). This constant was added in vSphere API 6.7.
SLES_16_64: Suse Linux Enterprise Server 16 (64 bit). This constant was added in vSphere API 7.0.1.0.
NLD_9: Novell Linux Desktop 9
OES: Open Enterprise Server
SJDS: Sun Java Desktop System
MANDRAKE: Mandrake Linux
MANDRIVA: Mandriva Linux
MANDRIVA_64: Mandriva Linux (64 bit)
TURBO_LINUX: Turbolinux
TURBO_LINUX_64: Turbolinux (64 bit)
UBUNTU: Ubuntu Linux
UBUNTU_64: Ubuntu Linux (64 bit)
DEBIAN_4: Debian GNU/Linux 4
DEBIAN_4_64: Debian GNU/Linux 4 (64 bit)
DEBIAN_5: Debian GNU/Linux 5
DEBIAN_5_64: Debian GNU/Linux 5 (64 bit)
DEBIAN_6: Debian GNU/Linux 6
DEBIAN_6_64: Debian GNU/Linux 6 (64 bit)
DEBIAN_7: Debian GNU/Linux 7
DEBIAN_7_64: Debian GNU/Linux 7 (64 bit)
DEBIAN_8: Debian GNU/Linux 8
DEBIAN_8_64: Debian GNU/Linux 8 (64 bit)
DEBIAN_9: Debian GNU/Linux 9
DEBIAN_9_64: Debian GNU/Linux 9 (64 bit)
DEBIAN_10: Debian GNU/Linux 10
DEBIAN_10_64: Debian GNU/Linux 10 (64 bit)
DEBIAN_11: Debian GNU/Linux 11. This constant was added in vSphere API 7.0.0.0.
DEBIAN_11_64: Debian GNU/Linux 11 (64 bit). This constant was added in vSphere API 7.0.0.0.
ASIANUX_3: Asianux Server 3
ASIANUX_3_64: Asianux Server 3 (64 bit)
ASIANUX_4: Asianux Server 4
ASIANUX_4_64: Asianux Server 4 (64 bit)
ASIANUX_5_64: Asianux Server 5 (64 bit)
ASIANUX_7_64: Asianux Server 7 (64 bit)
ASIANUX_8_64: Asianux Server 8 (64 bit). This constant was added in vSphere API 6.7.
ASIANUX_9_64: Asianux Server 9 (64 bit). This constant was added in vSphere API 7.0.1.0.
OPENSUSE: OpenSUSE Linux
OPENSUSE_64: OpenSUSE Linux (64 bit)
FEDORA: Fedora Linux
FEDORA_64: Fedora Linux (64 bit)
COREOS_64: CoreOS Linux (64 bit)
VMWARE_PHOTON_64: VMware Photon (64 bit)
OTHER_24X_LINUX: Linux 2.4x Kernel
OTHER_24X_LINUX_64: Linux 2.4x Kernel (64 bit) (experimental)
OTHER_26X_LINUX: Linux 2.6x Kernel
OTHER_26X_LINUX_64: Linux 2.6x Kernel (64 bit) (experimental)
OTHER_3X_LINUX: Linux 3.x Kernel
OTHER_3X_LINUX_64: Linux 3.x Kernel (64 bit)
OTHER_4X_LINUX: Linux 4.x Kernel. This constant was added in vSphere API 6.7.
OTHER_4X_LINUX_64: Linux 4.x Kernel (64 bit). This constant was added in vSphere API 6.7.
OTHER_5X_LINUX: Linux 5.x Kernel. This constant was added in vSphere API 7.0.1.0.
OTHER_5X_LINUX_64: Linux 5.x Kernel (64 bit). This constant was added in vSphere API 7.0.1.0.
OTHER_LINUX: Linux 2.2x Kernel
GENERIC_LINUX: Other Linux
OTHER_LINUX_64: Linux (64 bit) (experimental)
SOLARIS_6: Solaris 6
SOLARIS_7: Solaris 7
SOLARIS_8: Solaris 8
SOLARIS_9: Solaris 9
SOLARIS_10: Solaris 10 (32 bit) (experimental)
SOLARIS_10_64: Solaris 10 (64 bit) (experimental)
SOLARIS_11_64: Solaris 11 (64 bit)
OS2: OS/2
ECOMSTATION: eComStation 1.x
ECOMSTATION_2: eComStation 2.0
NETWARE_4: Novell NetWare 4
NETWARE_5: Novell NetWare 5.1
NETWARE_6: Novell NetWare 6.x
OPENSERVER_5: SCO OpenServer 5
OPENSERVER_6: SCO OpenServer 6
UNIXWARE_7: SCO UnixWare 7
DARWIN: Mac OS 10.5
DARWIN_64: Mac OS 10.5 (64 bit)
DARWIN_10: Mac OS 10.6
DARWIN_10_64: Mac OS 10.6 (64 bit)
DARWIN_11: Mac OS 10.7
DARWIN_11_64: Mac OS 10.7 (64 bit)
DARWIN_12_64: Mac OS 10.8 (64 bit)
DARWIN_13_64: Mac OS 10.9 (64 bit)
DARWIN_14_64: Mac OS 10.10 (64 bit)
DARWIN_15_64: Mac OS 10.11 (64 bit)
DARWIN_16_64: Mac OS 10.12 (64 bit)
DARWIN_17_64: Mac OS 10.13 (64 bit). This constant was added in vSphere API 6.7.
DARWIN_18_64: Mac OS 10.14 (64 bit). This constant was added in vSphere API 6.7.
DARWIN_19_64: Mac OS 10.15 (64 bit). This constant was added in vSphere API 7.0.0.0.
DARWIN_20_64: Mac OS 10.16 (64 bit). This constant was added in vSphere API 7.0.1.0.
DARWIN_21_64: Mac OS 10.17 (64 bit). This constant was added in vSphere API 7.0.1.0.
VMKERNEL: VMware ESX 4
VMKERNEL_5: VMware ESX 5
VMKERNEL_6: VMware ESX 6
VMKERNEL_65: VMware ESX 6.5
VMKERNEL_7: VMware ESX 7. This constant was added in vSphere API 7.0.0.0.
AMAZONLINUX2_64: Amazon Linux 2 (64 bit). This constant was added in vSphere API 6.7.1.
AMAZONLINUX3_64: Amazon Linux 3 (64 bit). This constant was added in vSphere API 7.0.1.0.
CRXPOD_1: CRX Pod 1. This constant was added in vSphere API 7.0.0.0.
OTHER: Other Operating System
OTHER_64: Other Operating System (64 bit) (experimental)
-.name string Virtual machine name.
-.identity.name string Virtual machine name. This attribute was added in vSphere API 6.7.1.
-.identity.bios_uuid string 128-bit SMBIOS UUID of a virtual machine represented as a hexadecimal string in "12345678-abcd-1234-cdef-123456789abc" format. This attribute was added in vSphere API 6.7.1.
-.identity.instance_uuid string VirtualCenter-specific 128-bit UUID of a virtual machine, represented as a hexademical string. This identifier is used by VirtualCenter to uniquely identify all virtual machine instances, including those that may share the same SMBIOS UUID. This attribute was added in vSphere API 6.7.1.
-.power_state string Power state of the virtual machine.

Defines the valid power states for a virtual machine. Value is one of:
POWERED_OFF: The virtual machine is powered off.
POWERED_ON: The virtual machine is powered on.
SUSPENDED: The virtual machine is suspended.
-.hardware info Virtual hardware version information.
-.hardware.version string Virtual hardware version.

Defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). Value is one of:
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. This constant was added in vSphere API 6.7.
VMX_15: Hardware version 15, first supported in ESXi 6.7 Update 2. This constant was added in vSphere API 6.7.2.
VMX_16: Hardware version 16, first supported in Workstation 15.0. This constant was added in vSphere API 7.0.0.0.
VMX_17: Hardware version 17, first supported in ESXi 7.0.0-0. This constant was added in vSphere API 7.0.0.0.
VMX_18: Hardware version 18, first supported in ESXi 7.0 U1. This constant was added in vSphere API 7.0.1.0.
VMX_FUTURE: Future hardware version, not supported yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.hardware.upgrade_policy string Scheduled upgrade policy.

Defines the valid virtual hardware upgrade policies for a virtual machine. Value is one of:
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.
-.hardware.upgrade_status string Scheduled upgrade status.

Defines the valid virtual hardware upgrade statuses for a virtual machine. Value is one of:
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.
-.boot info Boot configuration.
-.boot.type string Firmware type used by the virtual machine.

Defines the valid firmware types for a virtual machine. Value is one of:
BIOS: Basic Input/Output System (BIOS) firmware.
EFI: Extensible Firmware Interface (EFI) firmware.
-.boot.delay long Delay in milliseconds before beginning the firmware boot process when the virtual machine is powered on. This delay may be used to provide a time window for users to connect to the virtual machine console and enter BIOS setup mode.
-.boot.retry boolean Flag indicating whether the virtual machine will automatically retry the boot process after a failure.
-.boot.retry_delay long Delay in milliseconds before retrying the boot process after a failure; applicable only when vcenter.vm.hardware.boot.info.retry is true.
-.boot.enter_setup_mode boolean Flag indicating whether the firmware boot process will automatically enter setup mode the next time the virtual machine boots. Note that this flag will automatically be reset to false once the virtual machine enters setup mode.
-.boot_devices entry[] Boot device configuration. If the array has no entries, a server-specific default boot sequence is used.
-.boot_devices[].type string Virtual device type.

Defines the valid device types that may be used as bootable devices. Value is one of:
CDROM: Virtual CD-ROM device.
DISK: Virtual disk device.
ETHERNET: Virtual Ethernet adapter.
FLOPPY: Virtual floppy drive.
-.cpu info CPU configuration.
-.cpu.count long Number of CPU cores.
-.cpu.cores_per_socket long Number of CPU cores per socket.
-.cpu.hot_add_enabled boolean Flag indicating whether adding CPUs while the virtual machine is running is enabled.
-.cpu.hot_remove_enabled boolean Flag indicating whether removing CPUs while the virtual machine is running is enabled.
-.memory info Memory configuration.
-.memory.size_MiB long Memory size in mebibytes.
-.memory.hot_add_enabled boolean Flag indicating whether adding memory while the virtual machine is running is enabled.

Some guest operating systems may consume more resources or perform less efficiently when they run on hardware that supports adding memory while the machine is running.
-.disks object List of disks.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.Object with element values of type info.
-.nics object List of Ethernet adapters.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.Object with element values of type info.
-.cdroms object List of CD-ROMs.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.Object with element values of type info.
-.floppies object List of floppy drives.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.Object with element values of type info.
-.parallel_ports object List of parallel ports.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ParallelPort.Object with element values of type info.
-.serial_ports object List of serial ports.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SerialPort.Object with element values of type info.
-.sata_adapters object List of SATA adapters.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.SataAdapter.Object with element values of type info.
-.scsi_adapters object List of SCSI adapters.

When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.ScsiAdapter.Object with element values of type info.
Optional
-.identity info Identity of the virtual machine. This attribute was added in vSphere API 6.7.1.

Optional. This field is optional because it was added in a newer version than its parent node.
-.instant_clone_frozen boolean Indicates whether the virtual machine is frozen for instant clone, or not. This attribute was added in vSphere API 6.7.1.

Optional. This field is optional because it was added in a newer version than its parent node.
-.hardware.upgrade_version string Target hardware version to be used on the next scheduled virtual hardware upgrade.

Defines the valid virtual hardware versions for a virtual machine. See https://kb.vmware.com/s/article/1003746 (Virtual machine hardware versions (1003746)). Value is one of:
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. This constant was added in vSphere API 6.7.
VMX_15: Hardware version 15, first supported in ESXi 6.7 Update 2. This constant was added in vSphere API 6.7.2.
VMX_16: Hardware version 16, first supported in Workstation 15.0. This constant was added in vSphere API 7.0.0.0.
VMX_17: Hardware version 17, first supported in ESXi 7.0.0-0. This constant was added in vSphere API 7.0.0.0.
VMX_18: Hardware version 18, first supported in ESXi 7.0 U1. This constant was added in vSphere API 7.0.1.0.
VMX_FUTURE: Future hardware version, not supported yet. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.Optional. It is only relevant when upgrade_policy has value [AFTER_CLEAN_SHUTDOWN, ALWAYS]. This field is optional and it is only relevant when the value of upgrade_policy is one of AFTER_CLEAN_SHUTDOWN or ALWAYS.
-.hardware.upgrade_error exception Reason for the scheduled upgrade failure.

Optional. It is only relevant when upgrade_status has value FAILED. This field is optional and it is only relevant when the value of upgrade_status is FAILED.
-.boot.efi_legacy_boot boolean Flag indicating whether to use EFI legacy boot mode.

Optional. It is only relevant when type has value EFI. This field is optional and it is only relevant when the value of type is EFI.
-.boot.network_protocol string Protocol to use when attempting to boot the virtual machine over the network.

Defines the valid network boot protocols supported when booting a virtual machine with EFI firmware over the network. Value is one of:
IPV4: PXE or Apple NetBoot over IPv4.
IPV6: PXE over IPv6.Optional. It is only relevant when type has value EFI. This field is optional and it is only relevant when the value of type is EFI.
-.boot_devices[].nic string Virtual Ethernet device. Ethernet device to use as boot device for this entry.

Optional. It is only relevant when type has value ETHERNET. This field is optional and it is only relevant when the value of type is ETHERNET.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Ethernet.
-.boot_devices[].disks string[] Virtual disk device. List of virtual disks in boot order.

Optional. It is only relevant when type has value DISK. This field is optional and it is only relevant when the value of type is DISK.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.vm.hardware.Disk.
-.memory.hot_add_increment_size_MiB long The granularity, in mebibytes, at which memory can be added to a running virtual machine.

When adding memory to a running virtual machine, the amount of memory added must be at least vcenter.vm.hardware.memory.info.hot_add_increment_size_MiB and the total memory size of the virtual machine must be a multiple of {@link>hotAddIncrementSize}.

Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running.
-.memory.hot_add_limit_MiB long The maximum amount of memory, in mebibytes, that can be added to a running virtual machine.

Optional. Only set when vcenter.vm.hardware.memory.info.hot_add_enabled is true and the virtual machine is running.
-.nvme_adapters object List of NVMe adapters. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. This field is optional because it was added in a newer version than its parent node.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter. When operations return a value of this structure as a result, the key in the field key/value pairs will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.NvmeAdapter.Object with element values of type info.