This API has a deprecated equivalent from v7.0U1.
Create VM
Creates a virtual machine. if you do not have all of the privileges described as follows: - The resource Folder referenced by the attribute VM.InventoryPlacementSpec.folder requires VirtualMachine.Inventory.Create. - The resource ResourcePool referenced by the attribute VM.ComputePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource Datastore referenced by the attribute VM.StoragePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Network referenced by the attribute Ethernet.BackingSpec.network requires Network.Assign.
Request
URLURL
https://{api_host}/api/vcenter/vm
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Request Body
Request Body
VMCreateSpec of mimetype application/json
Required
Virtual machine specification. Document-based creation spec.
(The request body parameter is missing description)
{
"guest_OS": "enum",
"placement": {
"datastore": "string",
"folder": "string"
}
}
guest_OS
Required
Guest OS.
Possible values are: DOS , WIN_31 , WIN_95 , WIN_98 , WIN_ME , more...
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.
array of
VmHardwareDiskCreateSpec
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.
array of
VmHardwareFloppyCreateSpec
floppies
Optional
List of floppy drives. If unset, no floppy drives will be created.
array of
VmHardwareCdromCreateSpec
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_03 , VMX_04 , VMX_06 , VMX_07 , VMX_08 , more...
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.
array of
VmHardwareEthernetCreateSpec
nics
Optional
List of Ethernet adapters. If unset, no Ethernet adapters will be created.
array of
VmHardwareParallelCreateSpec
parallel_ports
Optional
List of parallel ports. If unset, no parallel ports will be created.
array of
VmHardwareBootDeviceEntryCreateSpec
boot_devices
Optional
Boot device configuration. If unset, a server-specific boot sequence will be used.
array of
VmHardwareAdapterSataCreateSpec
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.
array of
VmHardwareAdapterScsiCreateSpec
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.
array of
VmHardwareSerialCreateSpec
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.
Response
Response
Response BodyResponse Body
201 Created returns
string of type application/json
ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"boot":{"delay":0,"efi_legacy_boot":false,"enter_setup_mode":false,"network_protocol":"enum","retry":false,"retry_delay":0,"type":"enum"},"boot_devices":[{"type":"enum"}],"cdroms":[{"allow_guest_control":false,"backing":{"device_access_type":"enum","host_device":"string","iso_file":"string","type":"enum"},"ide":{"master":false,"primary":false},"sata":{"bus":0,"unit":0},"start_connected":false,"type":"enum"}],"cpu":{"cores_per_socket":0,"count":0,"hot_add_enabled":false,"hot_remove_enabled":false},"disks":[{"backing":{"type":"enum","vmdk_file":"string"},"ide":{"master":false,"primary":false},"new_vmdk":{"capacity":0,"name":"string","storage_policy":{"policy":"string"}},"sata":{"bus":0,"unit":0},"scsi":{"bus":0,"unit":0},"type":"enum"}],"floppies":[{"allow_guest_control":false,"backing":{"host_device":"string","image_file":"string","type":"enum"},"start_connected":false}],"guest_OS":"enum","hardware_version":"enum","memory":{"hot_add_enabled":false,"size_MiB":0},"name":"string","nics":[{"allow_guest_control":false,"backing":{"distributed_port":"string","network":"string","type":"enum"},"mac_address":"string","mac_type":"enum","pci_slot_number":0,"start_connected":false,"type":"enum","upt_compatibility_enabled":false,"wake_on_lan_enabled":false}],"parallel_ports":[{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","type":"enum"},"start_connected":false}],"placement":{"cluster":"string","datastore":"string","folder":"string","host":"string","resource_pool":"string"},"sata_adapters":[{"bus":0,"pci_slot_number":0,"type":"enum"}],"scsi_adapters":[{"bus":0,"pci_slot_number":0,"sharing":"enum","type":"enum"}],"serial_ports":[{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","network_location":"string","no_rx_loss":false,"pipe":"string","proxy":"string","type":"enum"},"start_connected":false,"yield_on_poll":false}],"storage_policy":{"policy":"string"}}' https://{api_host}/api/vcenter/vm
Errors
400
com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists. | com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid. | com.vmware.vapi.std.errors.resource_in_use : if any of the specified storage addresses (eg. IDE, SATA, SCSI, NVMe) result in a storage address conflict. | com.vmware.vapi.std.errors.unsupported : if VM.CreateSpec.guest-os is not supported for the requested virtual hardware version and spec includes unset fields that default to guest-specific values.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
404
com.vmware.vapi.std.errors.not_found : if any of the resources specified in spec could not be found
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_inaccessible : if a specified resource (eg. host) is not accessible. | com.vmware.vapi.std.errors.unable_to_allocate_resource : if any of the resources needed to create the virtual machine could not be allocated.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Availability
Added in 7.0U2
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
