vcenter vm hardware floppy: get
Returns information about a virtual floppy drive.
Request:
HTTP request
GET https://{server}/rest/vcenter/vm/{vm}/hardware/floppy/{floppy}
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
vm | string | Virtual machine identifier. |
floppy | string | Virtual floppy drive identifier. |
Response:
HTTP Status Code: 200
Representations:
{
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"host_device": "string",
"image_file": "string",
"type": "IMAGE_FILE"
},
"label": "string",
"start_connected": true,
"state": "CONNECTED"
}
}
"value": {
"allow_guest_control": true,
"backing": {
"auto_detect": true,
"host_device": "string",
"image_file": "string",
"type": "IMAGE_FILE"
},
"label": "string",
"start_connected": true,
"state": "CONNECTED"
}
}
<?xml version="1.0" ?>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/vm/hardware/floppy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<backing>
<auto_detect>true</auto_detect>
<image_file>string</image_file>
<type>IMAGE_FILE</type>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
</ns0:Get-Result>
<ns0:Get-Result xmlns:ns0="http://vmware.com/vcenter/vm/hardware/floppy" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<value>
<state>CONNECTED</state>
<label>string</label>
<allow_guest_control>true</allow_guest_control>
<backing>
<auto_detect>true</auto_detect>
<image_file>string</image_file>
<type>IMAGE_FILE</type>
<host_device>string</host_device>
</backing>
<start_connected>true</start_connected>
</value>
</ns0:Get-Result>
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | info | Information about the specified virtual floppy drive. |
value.label | string | Device label. |
value.backing | backing_info | Physical resource backing for the virtual floppy drive. |
value.backing.type | string | Backing type for the virtual floppy drive. Defines the valid backing types for a virtual floppy drive. Value is one of: IMAGE_FILE: Virtual floppy drive is backed by an image file. HOST_DEVICE: Virtual floppy drive is backed by a device on the host where the virtual machine is running. CLIENT_DEVICE: Virtual floppy drive is backed by a device on the client that is connected to the virtual machine console. |
value.backing.image_file | string | Path of the image file backing the virtual floppy drive. Optional. It is only relevant when type has value IMAGE_FILE. This field is optional and it is only relevant when the value of type is IMAGE_FILE. |
value.backing.host_device | string | Name of the host device backing the virtual floppy drive. Optional. It is only relevant when type has value HOST_DEVICE. This field will be unset if auto_detect is true and the virtual floppy drive is not connected or no suitable device is available on the host. |
value.backing.auto_detect | boolean | Flag indicating whether the virtual floppy drive 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.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 floppy drive is not found. |
400 | 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. |