Create Hardware CD ROM
Adds a virtual CD-ROM device to the virtual machine.
Request
URLURL
https://{api_host}/rest/vcenter/vm/{vm}/hardware/cdrom
Parameters
Parameters
string
vm
Required
Virtual machine identifier.
The parameter must be an identifier for the resource type: VirtualMachine.
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
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"
}
}
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"
}
string
value
Optional
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
400
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.invalid_argument : if the specified storage address is out of bounds. | 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.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
500
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.unable_to_allocate_resource : if the specified storage address is unavailable; for example, if the SCSI adapter requested does not exist. | com.vmware.vapi.std.errors.resource_busy : if the virtual machine is busy performing another operation. | 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.
On This Page
Hardware CD-ROM Operations
patch
delete
