Clone VM
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Creates a virtual machine from an existing virtual machine.
if you do not have all of the privileges described as follows: - The resource Datastore referenced by the attribute VM.DiskCloneSpec.datastore requires Datastore.AllocateSpace. - The resource Datastore referenced by the attribute VM.ClonePlacementSpec.datastore requires Datastore.AllocateSpace. - The resource Folder referenced by the attribute VM.ClonePlacementSpec.folder requires VirtualMachine.Inventory.CreateFromExisting. - The resource ResourcePool referenced by the attribute VM.ClonePlacementSpec.resource-pool requires Resource.AssignVMToPool. - The resource VirtualMachine referenced by the attribute VM.CloneSpec.source requires VirtualMachine.Provisioning.Clone.
Request
URLURL
https://{api_host}/rest/vcenter/vm?action=clone
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
VMCloneRequestBody of type application/json (required){
"spec": {
"name": "string",
"source": "string"
}
}
Response
Response
Response BodyResponse Body
200 OK returns
VMCloneResponseBody
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.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"disks_to_remove":["string"],"disks_to_update":{"key":{"datastore":"string"}},"guest_customization_spec":{"name":"string"},"name":"string","placement":{"cluster":"string","datastore":"string","folder":"string","host":"string","resource_pool":"string"},"power_on":false,"source":"string"}}' https://{api_host}/rest/vcenter/vm?action=clone
Errors
404
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if any of the resources specified in spec could not be found | com.vmware.vapi.std.errors.resource_inaccessible : if a specified resource (eg. host) is not accessible.
409
com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
507
com.vmware.vapi.std.errors.unable_to_allocate_resource : if any of the resources needed to clone the virtual machine could not be allocated.
400
com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
On This Page
VM Operations
get
post
delete
get
post
post
post
post
post
post
post
