Get Hardware CD ROM Deprecated
Returns information about a virtual CD-ROM device.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}
Path Parameters
Path Parameters
string
vm
Required
Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
string
cdrom
Required
Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareCdromGetResponseBody of type application/json
Information about the specified virtual CD-ROM device.
{
"value": {
"allow_guest_control": false,
"backing": {
"auto_detect": false,
"device_access_type": "EMULATION",
"host_device": "string",
"iso_file": "string",
"type": "ISO_FILE"
},
"ide": {
"master": false,
"primary": false
},
"label": "string",
"sata": {
"bus": 0,
"unit": 0
},
"start_connected": false,
"state": "CONNECTED",
"type": "IDE"
}
}
Errors
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 the virtual machine or virtual CD-ROM device is not 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 the virtual machine’s configuration state cannot be accessed.
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
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: get
x-vmw-doc-new-path: /api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}
x-vmw-doc-operation: get
On This Page
Hardware CD-ROM Operations
patch
delete
