Connect Hardware CD ROM
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Connects a virtual CD-ROM device of a powered-on virtual machine to its backing. Connecting the virtual device makes the backing accessible from the perspective of the guest operating system. For a powered-off virtual machine, the Cdrom.update operation may be used to configure the virtual CD-ROM device to start in the connected state when the virtual machine is powered on.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}/connect
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine. |
| required |
|
string | 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}/connect
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | ErrorRest | 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 | ErrorRest | 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 CD-ROM device is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.already_in_desired_state : if the virtual CD-ROM device is already connected. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is not powered on. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| default | ErrorRest | Not available |
On This Page
Hardware CD-ROM Operations
patch
delete
