Clone Task VM
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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&vmw-task=true
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VMClonetaskRequestBody
of type application/json
(required)
{
"spec": {
"name": "string",
"source": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VMCloneSpec |
Virtual machine clone specification. |
Response
Response
Response BodyResponse Body
200 OK returns
VMCloneTaskResponseBody
of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Identifier for the task created by this API invocation. |
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&vmw-task=true
Errors
| Code | Returns | Description |
|---|---|---|
| 409 | ErrorRest | com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if any of the resources needed to clone the virtual machine could not be allocated. |
| default | ErrorRest | Not available |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid. |
| 401 | ErrorRest | 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. |
| 404 | ErrorRest | 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. |
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
