Create VM Deprecated
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}/rest/vcenter/vm
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
VMCreateRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"guest_OS": "DOS",
"placement": {
"datastore": "string",
"folder": "string"
}
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VMCreateResponseBody of type application/json
ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
{
"value": "string"
}
string
value
Optional
ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
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.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"boot":{"delay":0,"efi_legacy_boot":false,"enter_setup_mode":false,"network_protocol":"IPV4","retry":false,"retry_delay":0,"type":"BIOS"},"boot_devices":[{"type":"CDROM"}],"cdroms":[{"allow_guest_control":false,"backing":{"device_access_type":"EMULATION","host_device":"string","iso_file":"string","type":"ISO_FILE"},"ide":{"master":false,"primary":false},"sata":{"bus":0,"unit":0},"start_connected":false,"type":"IDE"}],"cpu":{"cores_per_socket":0,"count":0,"hot_add_enabled":false,"hot_remove_enabled":false},"disks":[{"backing":{"type":"VMDK_FILE","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":"IDE"}],"floppies":[{"allow_guest_control":false,"backing":{"host_device":"string","image_file":"string","type":"IMAGE_FILE"},"start_connected":false}],"guest_OS":"DOS","hardware_version":"VMX_03","memory":{"hot_add_enabled":false,"size_MiB":0},"name":"string","nics":[{"allow_guest_control":false,"backing":{"distributed_port":"string","network":"string","type":"STANDARD_PORTGROUP"},"mac_address":"string","mac_type":"MANUAL","pci_slot_number":0,"start_connected":false,"type":"E1000","upt_compatibility_enabled":false,"wake_on_lan_enabled":false}],"parallel_ports":[{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","type":"FILE"},"start_connected":false}],"placement":{"cluster":"string","datastore":"string","folder":"string","host":"string","resource_pool":"string"},"sata_adapters":[{"bus":0,"pci_slot_number":0,"type":"AHCI"}],"scsi_adapters":[{"bus":0,"pci_slot_number":0,"sharing":"NONE","type":"BUSLOGIC"}],"serial_ports":[{"allow_guest_control":false,"backing":{"file":"string","host_device":"string","network_location":"string","no_rx_loss":false,"pipe":"string","proxy":"string","type":"FILE"},"start_connected":false,"yield_on_poll":false}],"storage_policy":{"policy":"string"}}}' https://{api_host}/rest/vcenter/vm
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/vm
x-vmw-doc-operation: create
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
