This API has a deprecated equivalent from v7.0U1.
Unmount Image
DescriptionUnmounts a previously mounted CD-ROM using an ISO image as a backing. if you do not have all of the privileges described as follows: - Operation execution requires System.Read. - The resource VirtualMachine referenced by the parameter vm requires VirtualMachine.Config.AddRemoveDevice. - The resource com.vmware.vcenter.vm.hardware.Cdrom referenced by the parameter cdrom requires System.Read.
Request
URLURL
https://{api_host}/api/vcenter/iso/image?action=unmount
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
IsoImageUnmountRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"cdrom": "string",
"vm": "string"
}
string
cdrom
Required
The device identifier of the CD-ROM. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
string
vm
Required
The identifier of the virtual machine from which to unmount the virtual CD-ROM. The parameter must be an identifier for the resource type: VirtualMachine.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : When the operation is not allowed on the virtual machine in its current state.
404
com.vmware.vapi.std.errors.not_found : If the virtual machine identified by vm is not found or the cdrom does not identify a virtual CD-ROM in the virtual machine.
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
$IsoImageUnmountRequestBody = Initialize-IsoImageUnmountRequestBody -Vm "MyVm" -Cdrom "MyCdrom"
Invoke-UnmountIsoImage -IsoImageUnmountRequestBody $IsoImageUnmountRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"cdrom":"string","vm":"string"}' https://{api_host}/api/vcenter/iso/image?action=unmount
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/com/vmware/vcenter/iso/image/id:{vm}?~action=unmount
x-vmw-doc-operation: unmount
Availability
Added in 7.0U2
On This Page
Image Operations
post
post
