Create Hardware CD ROM
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Adds a virtual CD-ROM device to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom
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. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains VmHardwareCdromCreateRequestBody
of type application/json
(required)
{
"spec": {
"allow_guest_control": false,
"backing": {
"device_access_type": "enum",
"host_device": "string",
"iso_file": "string",
"type": "enum"
},
"ide": {
"master": false,
"primary": false
},
"sata": {
"bus": 0,
"unit": 0
},
"start_connected": false,
"type": "enum"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | VmHardwareCdromCreateSpec |
Specification for the new virtual CD-ROM device. |
Response
Response
Response BodyResponse Body
200 OK returns
VmHardwareCdromCreateResponseBody
of type application/json
Virtual CD-ROM device identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
{
"value": "string"
}| Property Name | Type | Description |
|---|---|---|
| value | string |
Virtual CD-ROM device identifier. The result will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom. |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"allow_guest_control":false,"backing":{"device_access_type":"enum","host_device":"string","iso_file":"string","type":"enum"},"ide":{"master":false,"primary":false},"sata":{"bus":0,"unit":0},"start_connected":false,"type":"enum"}}' https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom
Errors
| Code | Returns | Description |
|---|---|---|
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist. |
| default | ErrorRest | Not available |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : if the system reported that the CD-ROM device was created but was unable to confirm the creation because the identifier of the new device could not be determined. if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if the virtual machine is not found. | com.vmware.vapi.std.errors.resource_inaccessible : if the virtual machine's configuration state cannot be accessed. |
| 405 | ErrorRest | com.vmware.vapi.std.errors.unsupported : if the guest operating system of the virtual machine is not supported and spec includes unset fields that default to guest-specific values. |
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the virtual machine is suspended or if the virtual machine is powered on and virtual CD-ROM type is IDE. | com.vmware.vapi.std.errors.resource_in_use : if the specified storage address is in use. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. |
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the specified storage address is out of bounds. |
| 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. |
| 503 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
On This Page
Hardware CD-ROM Operations
patch
delete
