Update Hardware Disk
Updates the configuration of a virtual disk. An update operation can be used to detach the existing VMDK file and attach another VMDK file to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/disk/{disk}
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
string
disk
Required
Virtual disk identifier.
The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Disk.
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
VmHardwareDiskUpdateRequestBody of type application/json (required){
"spec": {
"backing": {
"type": "enum",
"vmdk_file": "string"
}
}
}cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"backing":{"type":"enum","vmdk_file":"string"}}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/disk/{disk}
Errors
401
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
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 the virtual machine or virtual disk is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if one or more of the fields specified in the spec parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual disk. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation.
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.
On This Page
Hardware Disk Operations
post
patch
delete
