This API has a deprecated equivalent from v7.0U1.
Get Hardware CD ROM
Returns information about a virtual CD-ROM device.
Request
URLURL
https://{api_host}/api/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
VmHardwareCdromInfo of type application/json
Information about the specified virtual CD-ROM device.
{
"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"
}
boolean
allow_guest_control
Required
Flag indicating whether the guest can connect and disconnect the device.
backing
Required
Physical resource backing for the virtual CD-ROM device.
string
label
Required
Device label.
boolean
start_connected
Required
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
state
Required
The ConnectionState enumerated type defines the valid states for a removable device that is configured to be connected.
CONNECTED : The device is connected and working correctly.
RECOVERABLE_ERROR : Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
UNRECOVERABLE_ERROR : Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
NOT_CONNECTED : The device is not connected.
UNKNOWN : The device status is unknown.
Possible values are: CONNECTED , RECOVERABLE_ERROR , UNRECOVERABLE_ERROR , NOT_CONNECTED , UNKNOWN
type
Required
The Cdrom.HostBusAdapterType enumerated type defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine.
IDE : Cdrom is attached to an IDE adapter.
SATA : Cdrom is attached to a SATA adapter.
Possible values are: IDE , SATA
ide
Optional
Address of device attached to a virtual IDE adapter. This field is optional and it is only relevant when the value of Cdrom.Info.type is IDE.
sata
Optional
Address of device attached to a virtual SATA adapter. This field is optional and it is only relevant when the value of Cdrom.Info.type is SATA.
Code Samples
PowerCLI Client SDK Example
Invoke-GetVmCdromHardware -Vm "MyVm" -Cdrom "MyCdrom"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/vm/{vm}/hardware/cdrom/{cdrom}
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.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Hardware CD-ROM Operations
patch
delete
