vcenter VM: relocate-task
Request:
HTTP request
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
vm | string | Existing Virtual machine to relocate. |
Request Body Structure:
"spec" : {
"disks" : [
{
"value" : {
"datastore" : "obj-103"
},
"key" : "obj-103"
}
],
"placement" : {
"cluster" : "obj-103",
"folder" : "obj-103",
"datastore" : "obj-103",
"host" : "obj-103",
"resource_pool" : "obj-103"
}
}
}
Request Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
spec | relocate_spec | Relocate specification. |
spec.placement | relocate_placement_spec | Virtual machine placement information. This attribute was added in vSphere API 7.0.0. Optional. 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. |
spec.placement.folder | string | Virtual machine folder into which the virtual machine should be placed. This attribute was added in vSphere API 7.0.0. Optional. If this field is unset, the virtual machine will stay in the current folder.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
spec.placement.resource_pool | string | Resource pool into which the virtual machine should be placed. This attribute was added in vSphere API 7.0.0. Optional. If this field is unset, the virtual machine will stay in the current resource pool.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
spec.placement.host | string | Host onto which the virtual machine should be placed. If If Optional. If this field is unset, if |
spec.placement.cluster | string | Cluster into which the virtual machine should be placed. If If Optional. If |
spec.placement.datastore | string | Datastore on which the virtual machine's configuration state should be stored. This datastore will also be used for any virtual disks that are associated with the virtual machine, unless individually overridden. This attribute was added in vSphere API 7.0.0. Optional. If this field is unset, the virtual machine will remain on the current datastore.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
spec.disks | list | Individual disk relocation map. This attribute was added in vSphere API 7.0.0. Optional. If unset, all disks will migrate to the datastore specified in the vcenter.VM.relocate_placement_spec.datastore field of vcenter.VM.relocate_spec.placement.When clients pass a value of this structure as a parameter, the key in the field key/value pairs must be an identifier for the resource type: |
spec.disks[].key | string | |
spec.disks[].value | disk_relocate_spec | |
spec.disks[].value.datastore | string | Destination datastore to relocate disk. This attribute was added in vSphere API 7.0.0. Optional. This field is currently required. In the future, if this field is unset, disk will use the datastore specified in vcenter.VM.relocate_placement_spec.datastore field of vcenter.VM.relocate_spec.placement.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: |
Response:
HTTP Status Code: 200
Representation:
"value" : "obj-103"
}
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | string |
Errors:
HTTP Status Code | Type | Description |
---|---|---|
500 | error | if the system reports an error while responding to the request. |
400 | invalid_argument | if any of the specified parameters are invalid. |
404 | not_found | if any of the resources specified in spec or the given "vm" could not be found |
500 | resource_inaccessible | if a specified resource (eg. host) is not accessible. |
503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
401 | unauthenticated | if the user can not be authenticated. |
403 | unauthorized | if the user doesn't have the required privileges. |