Developer Documentation
Relocate Task VM
Released in v7.0.0Relocates a virtual machine based on the specification. The parts of the virtual machine that can move are: FOLDER, RESOURCE_POOL, HOST, CLUSTER and DATASTORE of home of the virtual machine and disks.
if you do not have all of the privileges described as follows: - The resource VirtualMachine referenced by the parameter vm requires Resource.ColdMigrate. - The resource ResourcePool referenced by the attribute VM.RelocatePlacementSpec.resource-pool requires Resource.AssignVMToPool.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}?action=relocate&vmw-task=true
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: VirtualMachine. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | action=relocate |
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Request Body
Request Body
Contains
RelocatetaskRequestBody
of type application/json
(required)
{
"spec": {
"disks": {
"key": {
"datastore": "string"
}
},
"placement": {
"cluster": "string",
"datastore": "string",
"folder": "string",
"host": "string",
"resource_pool": "string"
}
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VMRelocateSpec |
Relocate specification. |
Response
Response
Response BodyResponse Body
200 OK returns
RelocateTaskResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains:
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string | Not available |
Errors
| Code | Returns | Description |
|---|---|---|
| 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 or the given "vm" could not be found | com.vmware.vapi.std.errors.resource_inaccessible : if a specified resource (eg. host) is not accessible. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | Error | Not available |
On This Page
VM Operations
get
post
delete
get
post
post
post
post
post
post
post
