REST API - get
  1. Operations
  2. vcenter
  3. vm
  4. hardware
  5. cdrom

vcenter vm hardware cdrom: get

Returns information about a virtual CD-ROM device.

Request:

HTTP request

GET https://{server}/rest/vcenter/vm/{vm}/hardware/cdrom/{cdrom}

Path Parameters

Name Type Description
Required
vm string Virtual machine identifier.
cdrom string Virtual CD-ROM device identifier.

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name Type Description
bold = required
value info Information about the specified virtual CD-ROM device.
value.type string Type of host bus adapter to which the device is attached.

Defines the valid types of host bus adapters that may be used for attaching a Cdrom to a virtual machine. Value is one of:
IDE: Cdrom is attached to an IDE adapter.
SATA: Cdrom is attached to a SATA adapter.
value.label string Device label.
value.ide ide_address_info Address of device attached to a virtual IDE adapter.

Optional. It is only relevant when type has value IDE. This field is optional and it is only relevant when the value of type is IDE.
value.ide.primary boolean Flag specifying whether the device is attached to the primary or secondary IDE adapter of the virtual machine.
value.ide.master boolean Flag specifying whether the device is the master or slave device on the IDE adapter.
value.sata sata_address_info Address of device attached to a virtual SATA adapter.

Optional. It is only relevant when type has value SATA. This field is optional and it is only relevant when the value of type is SATA.
value.sata.bus long Bus number of the adapter to which the device is attached.
value.sata.unit long Unit number of the device.
value.backing backing_info Physical resource backing for the virtual CD-ROM device.
value.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.
value.backing.iso_file string Path of the image file backing the virtual CD-ROM device.

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.
value.backing.host_device string Name of the host device backing the virtual CD-ROM device.

Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if auto_detect is true and the virtual CD-ROM device is not connected or no suitable device is available on the host.
value.backing.auto_detect boolean Flag indicating whether the virtual CD-ROM device is configured to automatically detect a suitable host device.

Optional. It is only relevant when type has value HOST_DEVICE. This field is optional and it is only relevant when the value of type is HOST_DEVICE.
value.backing.device_access_type string Access type for the device backing.

Defines the valid device access types for a physical device packing of a virtual CD-ROM device. Value is one of:
EMULATION: ATAPI or SCSI device emulation.
PASSTHRU: Raw passthru device access.
PASSTHRU_EXCLUSIVE: Raw passthru device access, with exclusive access to the device.Optional. It is only relevant when type has value [HOST_DEVICE, CLIENT_DEVICE]. This field is optional and it is only relevant when the value of type is one of HOST_DEVICE or CLIENT_DEVICE.
value.state string Connection status of the virtual device.

Defines the valid states for a removable device that is configured to be connected. Value is one of:
CONNECTED: The device is connected and working correctly.
RECOVERABLE_ERROR: Device connection failed due to a recoverable error; for example, the virtual device backing is currently in use by another virtual machine.
UNRECOVERABLE_ERROR: Device connection failed due to an unrecoverable error; for example, the virtual device backing does not exist.
NOT_CONNECTED: The device is not connected.
UNKNOWN: The device status is unknown.
value.start_connected boolean Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.
value.allow_guest_control boolean Flag indicating whether the guest can connect and disconnect the device.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the virtual machine or virtual CD-ROM device is not found.
500 resource_inaccessible if the virtual machine's configuration state cannot be accessed.
503 service_unavailable if the system is unable to communicate with a service to complete the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user doesn't have the required privileges.