Developer Documentation
Clone VM
Released in v7.0.0Creates 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
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=clone |
Request Body
Request Body
Contains
CloneRequestBody
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
CloneResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: 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 |
ID of newly-created virtual machine. The result will be an identifier for the resource type: VirtualMachine. |
Errors
| Code | Returns | Description |
|---|---|---|
| 507 | Error | 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 | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid. |
| 401 | Error | 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 | Error | 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 | Error | com.vmware.vapi.std.errors.already_exists : if a virtual machine with the specified name already exists. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
On This Page
VM Operations
get
post
delete
get
post
post
post
post
post
post
post
