This API has a deprecated equivalent from v7.0U1.
Relocate VM Task
Relocates 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}/api/vcenter/vm/{vm}?action=relocate&vmw-task=true
Path Parameters
Path Parameters
string
vm
Required
Existing Virtual machine to relocate. The parameter must be an identifier for the resource type: VirtualMachine.
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
{
"disks": {
"key": {
"datastore": "string"
}
},
"placement": {
"cluster": "string",
"datastore": "string",
"folder": "string",
"host": "string",
"resource_pool": "string"
}
}
map of
VMDiskRelocateSpec
disks
Optional
Individual disk relocation map. If unset, all disks will migrate to the datastore specified in the VM.RelocatePlacementSpec.datastore field of VM.RelocateSpec.placement. When clients pass a value of this structure as a parameter, the key in the field map must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk. When operations return a value of this structure as a result, the key in the field map will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
placement
Optional
Virtual machine placement information. If this field is unset, the system will use the values from the source virtual machine. If specified, each field will be used for placement. If the fields result in disjoint placement the operation will fail. If the fields along with the other existing placement of the virtual machine result in disjoint placement the operation will fail.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string
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.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if any of the specified parameters are invalid.
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 or the given “vm” 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.
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
PowerCLI Client SDK Example
$VMRelocatePlacementSpec = Initialize-VMRelocatePlacementSpec -Folder "MyFolder" -ResourcePool "MyResourcePool" -VarHost "MyVarHost" -Cluster "MyCluster" -Datastore "MyDatastore"
$VMDiskRelocateSpec = Initialize-VMDiskRelocateSpec -Datastore "MyDatastore"
$VMRelocateSpec = Initialize-VMRelocateSpec -Placement $VMRelocatePlacementSpec -Disks @{ key_example = $VMDiskRelocateSpec }
Invoke-RelocateVmAsync -Vm "MyVm" -VMRelocateSpec $VMRelocateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"disks":{"key":{"datastore":"string"}},"placement":{"cluster":"string","datastore":"string","folder":"string","host":"string","resource_pool":"string"}}' https://{api_host}/api/vcenter/vm/{vm}?action=relocate&vmw-task=true
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}?action=relocate&vmw-task=true
x-vmw-doc-operation: relocate_task
Availability
Added in 7.0U2
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
