VMCreateSpec

Document-based creation spec.


Properties

guest_OS Required

Guest OS.

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


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.


boot Optional

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


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.


cdroms Optional

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


hardware_version Optional

Virtual hardware version. If unset, defaults to the most recent version supported by the server.

Possible values are: VMX_03VMX_04VMX_06VMX_07VMX_08VMX_09VMX_10VMX_11VMX_12VMX_13VMX_14VMX_15VMX_16VMX_17VMX_18VMX_19


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.


boot_devices Optional

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


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": "enum",
    "placement": {
        "datastore": "string",
        "folder": "string"
    }
}
Parameter To

Create VM
Feedback

Was this page helpful?