This API has a deprecated equivalent from v7.0U1.
Create Hardware CD ROM
Adds a virtual CD-ROM device to the virtual machine.
Request
URLURL
https://{api_host}/api/vcenter/vm/{vm}/hardware/cdrom
Path Parameters
Path 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
VmHardwareCdromCreateSpec of mimetype application/json
Required
Specification for the new virtual CD-ROM device.
{
"allow_guest_control": false,
"backing": {
"device_access_type": "EMULATION",
"host_device": "string",
"iso_file": "string",
"type": "ISO_FILE"
},
"ide": {
"master": false,
"primary": false
},
"sata": {
"bus": 0,
"unit": 0
},
"start_connected": false,
"type": "IDE"
}
boolean
allow_guest_control
Optional
Flag indicating whether the guest can connect and disconnect the device. Defaults to false if unset.
backing
Optional
Physical resource backing for the virtual CD-ROM device. If unset, defaults to automatic detection of a suitable host device.
ide
Optional
Address for attaching the device to a virtual IDE adapter. If unset, the server will choose an available address; if none is available, the request will fail.
sata
Optional
Address for attaching the device to a virtual SATA adapter. If unset, the server will choose an available address; if none is available, the request will fail.
boolean
start_connected
Optional
Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if unset.
type
Optional
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
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
201 Created returns
string
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.
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.
Code Samples
PowerCLI Client SDK Example
$VmHardwareIdeAddressSpec = Initialize-VmHardwareIdeAddressSpec -Primary $false -Master $false
$VmHardwareSataAddressSpec = Initialize-VmHardwareSataAddressSpec -Bus 0 -Unit 0
$VmHardwareCdromBackingSpec = Initialize-VmHardwareCdromBackingSpec -Type "ISO_FILE" -IsoFile "MyIsoFile" -HostDevice "MyHostDevice" -DeviceAccessType "EMULATION"
$VmHardwareCdromCreateSpec = Initialize-VmHardwareCdromCreateSpec -Type "IDE" -Ide $VmHardwareIdeAddressSpec -Sata $VmHardwareSataAddressSpec -Backing $VmHardwareCdromBackingSpec -StartConnected $false -AllowGuestControl $false
Invoke-CreateVmHardwareCdrom -Vm "MyVm" -VmHardwareCdromCreateSpec $VmHardwareCdromCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"allow_guest_control":false,"backing":{"device_access_type":"EMULATION","host_device":"string","iso_file":"string","type":"ISO_FILE"},"ide":{"master":false,"primary":false},"sata":{"bus":0,"unit":0},"start_connected":false,"type":"IDE"}' https://{api_host}/api/vcenter/vm/{vm}/hardware/cdrom
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/vm/{vm}/hardware/cdrom
x-vmw-doc-operation: create
Availability
Added in 7.0U2
On This Page
Hardware CD-ROM Operations
patch
delete
