1. Types
  2. vcenter
  3. vm
  4. hardware
  5. cdrom

vcenter vm hardware cdrom: create spec

The create_spec structure provides a specification for the configuration of a newly-created virtual CD-ROM device.

Representation:

{
    "start_connected" : true,
    "backing" : {
        "device_access_type" : "EMULATION",
        "iso_file" : "string",
        "type" : "ISO_FILE",
        "host_device" : "string"
    },
    "allow_guest_control" : true,
    "ide" : {
        "primary" : true,
        "master" : true
    },
    "type" : "IDE",
    "sata" : {
        "bus" : 1,
        "unit" : 1
    }
}

Attributes:

Name Type Description
Required
sata.bus long Bus number of the adapter to which the device should be attached.
backing.type string Backing type for the virtual CD-ROM device.

Defines the valid backing types for a virtual CD-ROM device. Value is one of:
ISO_FILE: Virtual CD-ROM device is backed by an ISO file.
HOST_DEVICE: Virtual CD-ROM device is backed by a device on the host where the virtual machine is running.
CLIENT_DEVICE: Virtual CD-ROM device is backed by a device on the client that is connected to the virtual machine console.
Optional
type string Type of host bus adapter to which the device should be attached.

Optional. If unset, guest-specific default values will be used.

ide ide_address_spec Address for attaching the device to a virtual IDE adapter.

Optional. It is only relevant when type has value IDE. If unset, the server will choose an available address; if none is available, the request will fail.
ide.primary boolean Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine.

Optional. If unset, the server will choose a adapter with an available connection. If no IDE connections are available, the request will be rejected.
ide.master boolean Flag specifying whether the device should be the master or slave device on the IDE adapter.

Optional. If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.
sata sata_address_spec Address for attaching the device to a virtual SATA adapter.

Optional. It is only relevant when type has value SATA. If unset, the server will choose an available address; if none is available, the request will fail.
sata.unit long Unit number of the device.

Optional. If unset, the server will choose an available unit number on the specified adapter. If there are no available connections on the adapter, the request will be rejected.
backing backing_spec Physical resource backing for the virtual CD-ROM device.

Optional. If unset, defaults to automatic detection of a suitable host device.
backing.iso_file string Path of the image file that should be used as the virtual CD-ROM device backing.

Optional. It is only relevant when type has value ISO_FILE. This field is optional and it is only relevant when the value of type is ISO_FILE.
backing.host_device string Name of the device that should be used as the virtual CD-ROM device backing.

Optional. It is only relevant when type has value HOST_DEVICE. If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device.
backing.device_access_type string Access type for the device backing.

Optional. It is only relevant when type has value [HOST_DEVICE, CLIENT_DEVICE]. If unset, defaults to EMULATION.
start_connected boolean Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Optional. Defaults to false if unset.
allow_guest_control boolean Flag indicating whether the guest can connect and disconnect the device.

Optional. Defaults to false if unset.