VMCreateSpec

Document-based creation spec.


Properties

boot Optional

Boot configuration. If unset, guest-specific default values will be used.


boot_devices Optional

Boot device configuration. If unset, a server-specific boot sequence will be used.


cdroms Optional

List of CD-ROMs. If unset, no CD-ROM devices will be created.


cpu Optional

CPU configuration. If unset, guest-specific default values will be used.


disks Optional

List of disks. If unset, a single blank virtual disk of a guest-specific size will be created on the same storage as the virtual machine configuration, and will use a guest-specific host bus adapter type. If the guest-specific size is 0, no virtual disk will be created.


floppies Optional

List of floppy drives. If unset, no floppy drives will be created.


guest_OS Required

The GuestOS enumerated type defines the valid guest operating system types used for configuring a virtual machine.
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
WINDOWS_SERVER_2021 : Windows Server 2021
FREEBSD : FreeBSD 10 or earlier
FREEBSD_64 : FreeBSD 10 x64 or earlier
FREEBSD_11 : FreeBSD 11
FREEBSD_12 : FreeBSD 12
FREEBSD_13 : FreeBSD 13 or later
FREEBSD_11_64 : FreeBSD 11 x64
FREEBSD_12_64 : FreeBSD 12 x64
FREEBSD_13_64 : FreeBSD 13 x64 or later
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)
RHEL_9_64 : Red Hat Enterprise Linux 9 (64 bit)
CENTOS : CentOS 45
CENTOS_64 : CentOS 45 (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)
CENTOS_9_64 : CentOS 9 (64-bit)
ORACLE_LINUX : Oracle Linux 45
ORACLE_LINUX_64 : Oracle Linux 45 (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)
ORACLE_LINUX_9_64 : Oracle Linux 9 (64-bit)
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)
SLES_16_64 : Suse Linux Enterprise Server 16 (64 bit)
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
DEBIAN_11_64 : Debian GNU/Linux 11 (64 bit)
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)
ASIANUX_9_64 : Asianux Server 9 (64 bit)
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
OTHER_4X_LINUX_64 : Linux 4.x Kernel (64 bit)
OTHER_5X_LINUX : Linux 5.x Kernel
OTHER_5X_LINUX_64 : Linux 5.x Kernel (64 bit)
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)
DARWIN_18_64 : Mac OS 10.14 (64 bit)
DARWIN_19_64 : Mac OS 10.15 (64 bit)
DARWIN_20_64 : Mac OS 10.16 (64 bit)
DARWIN_21_64 : Mac OS 10.17 (64 bit)
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
AMAZONLINUX2_64 : Amazon Linux 2 (64 bit)
AMAZONLINUX3_64 : Amazon Linux 3 (64 bit)
CRXPOD_1 : CRX Pod 1
OTHER : Other Operating System
OTHER_64 : Other Operating System (64 bit) (experimental)

Possible values are: DOSWIN_31WIN_95WIN_98WIN_MEWIN_NTWIN_2000_PROWIN_2000_SERVWIN_2000_ADV_SERVWIN_XP_HOMEWIN_XP_PROWIN_XP_PRO_64WIN_NET_WEBWIN_NET_STANDARDWIN_NET_ENTERPRISEWIN_NET_DATACENTERWIN_NET_BUSINESSWIN_NET_STANDARD_64WIN_NET_ENTERPRISE_64WIN_LONGHORNWIN_LONGHORN_64WIN_NET_DATACENTER_64WIN_VISTAWIN_VISTA_64WINDOWS_7WINDOWS_7_64WINDOWS_7_SERVER_64WINDOWS_8WINDOWS_8_64WINDOWS_8_SERVER_64WINDOWS_9WINDOWS_9_64WINDOWS_9_SERVER_64WINDOWS_HYPERVWINDOWS_SERVER_2019WINDOWS_SERVER_2021FREEBSDFREEBSD_64FREEBSD_11FREEBSD_12FREEBSD_13FREEBSD_11_64FREEBSD_12_64FREEBSD_13_64REDHATRHEL_2RHEL_3RHEL_3_64RHEL_4RHEL_4_64RHEL_5RHEL_5_64RHEL_6RHEL_6_64RHEL_7RHEL_7_64RHEL_8_64RHEL_9_64CENTOSCENTOS_64CENTOS_6CENTOS_6_64CENTOS_7CENTOS_7_64CENTOS_8_64CENTOS_9_64ORACLE_LINUXORACLE_LINUX_64ORACLE_LINUX_6ORACLE_LINUX_6_64ORACLE_LINUX_7ORACLE_LINUX_7_64ORACLE_LINUX_8_64ORACLE_LINUX_9_64SUSESUSE_64SLESSLES_64SLES_10SLES_10_64SLES_11SLES_11_64SLES_12SLES_12_64SLES_15_64SLES_16_64NLD_9OESSJDSMANDRAKEMANDRIVAMANDRIVA_64TURBO_LINUXTURBO_LINUX_64UBUNTUUBUNTU_64DEBIAN_4DEBIAN_4_64DEBIAN_5DEBIAN_5_64DEBIAN_6DEBIAN_6_64DEBIAN_7DEBIAN_7_64DEBIAN_8DEBIAN_8_64DEBIAN_9DEBIAN_9_64DEBIAN_10DEBIAN_10_64DEBIAN_11DEBIAN_11_64ASIANUX_3ASIANUX_3_64ASIANUX_4ASIANUX_4_64ASIANUX_5_64ASIANUX_7_64ASIANUX_8_64ASIANUX_9_64OPENSUSEOPENSUSE_64FEDORAFEDORA_64COREOS_64VMWARE_PHOTON_64OTHER_24X_LINUXOTHER_24X_LINUX_64OTHER_26X_LINUXOTHER_26X_LINUX_64OTHER_3X_LINUXOTHER_3X_LINUX_64OTHER_4X_LINUXOTHER_4X_LINUX_64OTHER_5X_LINUXOTHER_5X_LINUX_64OTHER_LINUXGENERIC_LINUXOTHER_LINUX_64SOLARIS_6SOLARIS_7SOLARIS_8SOLARIS_9SOLARIS_10SOLARIS_10_64SOLARIS_11_64OS2ECOMSTATIONECOMSTATION_2NETWARE_4NETWARE_5NETWARE_6OPENSERVER_5OPENSERVER_6UNIXWARE_7DARWINDARWIN_64DARWIN_10DARWIN_10_64DARWIN_11DARWIN_11_64DARWIN_12_64DARWIN_13_64DARWIN_14_64DARWIN_15_64DARWIN_16_64DARWIN_17_64DARWIN_18_64DARWIN_19_64DARWIN_20_64DARWIN_21_64VMKERNELVMKERNEL_5VMKERNEL_6VMKERNEL_65VMKERNEL_7AMAZONLINUX2_64AMAZONLINUX3_64CRXPOD_1OTHEROTHER_64


hardware_version Optional

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.

Possible values are: VMX_03VMX_04VMX_06VMX_07VMX_08VMX_09VMX_10VMX_11VMX_12VMX_13VMX_14VMX_15VMX_16VMX_17VMX_18


memory Optional

Memory configuration. If unset, guest-specific default values will be used.


string
name Optional

Virtual machine name. If unset, a default name will be generated by the server.


nics Optional

List of Ethernet adapters. If unset, no Ethernet adapters will be created.


parallel_ports Optional

List of parallel ports. If unset, no parallel ports will be created.


placement Required

Virtual machine placement information. This field is currently required. In the future, if this field is unset, the system will attempt to choose suitable resources on which to place the virtual machine.


sata_adapters Optional

List of SATA adapters. If unset, any adapters necessary to connect the virtual machine’s storage devices will be created; this includes any devices that explicitly specify a SATA host bus adapter, as well as any devices that do not specify a host bus adapter if the guest’s preferred adapter type is SATA.


scsi_adapters Optional

List of SCSI adapters. If unset, any adapters necessary to connect the virtual machine’s storage devices will be created; this includes any devices that explicitly specify a SCSI host bus adapter, as well as any devices that do not specify a host bus adapter if the guest’s preferred adapter type is SCSI. The type of the SCSI adapter will be a guest-specific default type.


serial_ports Optional

List of serial ports. If unset, no serial ports will be created.


storage_policy Optional

The VM.StoragePolicySpec structure contains information about the storage policy that is to be associated with the virtual machine home (which contains the configuration and log files). If unset the datastore default storage policy (if applicable) is applied. Currently a default storage policy is only supported by object datastores : VVol and vSAN. For non-object datastores, if unset then no storage policy would be associated with the virtual machine home.

JSON Example

{
	"guest_OS": "DOS",
	"placement": {
		"datastore": "string",
		"folder": "string"
	}
}
Property Of

VMCreateRequestBody

Feedback

Was this page helpful?