VMware

Cdrom Namespace

The Cdrom namespace provides commands for configuring the virtual CD-ROM devices of a virtual machine.

List of commands:



List Command

dcli com vmware vcenter vm hardware cdrom list

Description

Returns commonly used information about the virtual CD-ROM devices belonging to the virtual machine.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.

Example

dcli com vmware vcenter vm hardware cdrom list --vm testId


Get Command

dcli com vmware vcenter vm hardware cdrom get

Description

Returns information about a virtual CD-ROM device.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom string Yes Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Example

dcli com vmware vcenter vm hardware cdrom get --vm testId --cdrom testId


Create Command

dcli com vmware vcenter vm hardware cdrom create

Description

Adds a virtual CD-ROM device to the virtual machine.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
type string No Type of host bus adapter to which the device should be attached. If unset, guest-specific default values will be used Valid values are: {IDE, SATA}
ide‑primary bool No Flag specifying whether the device should be attached to the primary or secondary IDE adapter of the virtual machine. 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 bool No Flag specifying whether the device should be the master or slave device on the IDE adapter. If unset, the server will choose an available connection type. If no IDE connections are available, the request will be rejected.
sata‑bus int No Bus number of the adapter to which the device should be attached.
sata‑unit int No Unit number of the device. 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‑type string No Backing type for the virtual CD-ROM device. Valid values are: {ISO_FILE, HOST_DEVICE, CLIENT_DEVICE}
backing‑iso‑file string No Path of the image file that should be used as the virtual CD-ROM device backing. This option is optional and it is only relevant when the value of type is ISO_FILE.
backing‑host‑device string No Name of the device that should be used as the virtual CD-ROM device backing. If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device.
backing‑device‑access‑type string No Access type for the device backing. If unset, defaults to EMULATION. Valid values are: {EMULATION, PASSTHRU, PASSTHRU_EXCLUSIVE}
start‑connected bool No Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. Defaults to false if unset.
allow‑guest‑control bool No Flag indicating whether the guest can connect and disconnect the device. Defaults to false if unset.

Example

dcli com vmware vcenter vm hardware cdrom create --vm testId


Update Command

dcli com vmware vcenter vm hardware cdrom update

Description

Updates the configuration of a virtual CD-ROM device.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom string Yes Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.
backing‑type string No Backing type for the virtual CD-ROM device. Valid values are: {ISO_FILE, HOST_DEVICE, CLIENT_DEVICE}
backing‑iso‑file string No Path of the image file that should be used as the virtual CD-ROM device backing. This option is optional and it is only relevant when the value of type is ISO_FILE.
backing‑host‑device string No Name of the device that should be used as the virtual CD-ROM device backing. If unset, the virtual CD-ROM device will be configured to automatically detect a suitable host device.
backing‑device‑access‑type string No Access type for the device backing. If unset, defaults to EMULATION. Valid values are: {EMULATION, PASSTHRU, PASSTHRU_EXCLUSIVE}
start‑connected bool No Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on. If unset, the value is unchanged.
allow‑guest‑control bool No Flag indicating whether the guest can connect and disconnect the device. If unset, the value is unchanged.

Example

dcli com vmware vcenter vm hardware cdrom update --vm testId --cdrom testId


Delete Command

dcli com vmware vcenter vm hardware cdrom delete

Description

Removes a virtual CD-ROM device from the virtual machine.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom string Yes Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Example

dcli com vmware vcenter vm hardware cdrom delete --vm testId --cdrom testId


Connect Command

dcli com vmware vcenter vm hardware cdrom connect

Description

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 command may be used to configure the virtual CD-ROM device to start in the connected state when the virtual machine is powered on.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom string Yes Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Example

dcli com vmware vcenter vm hardware cdrom connect --vm testId --cdrom testId


Disconnect Command

dcli com vmware vcenter vm hardware cdrom disconnect

Description

Disconnects a virtual CD-ROM device of a powered-on virtual machine from its backing. The virtual device is still present and its backing configuration is unchanged, but from the perspective of the guest operating system, the CD-ROM device is not connected to its backing resource. For a powered-off virtual machine, the Cdrom.update command may be used to configure the virtual CD-ROM device to start in the disconnected state when the virtual machine is powered on.

Options

Option Name Type Required Description
vm string Yes Virtual machine identifier. The parameter must be an identifier for the resource type: VirtualMachine.
cdrom string Yes Virtual CD-ROM device identifier. The parameter must be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Cdrom.

Example

dcli com vmware vcenter vm hardware cdrom disconnect --vm testId --cdrom testId