vcenter vm hardware floppy: create
Adds a virtual floppy drive to the virtual machine.
Request:
HTTP request
POST https://{server}/rest/vcenter/vm/{vm}/hardware/floppy
Path Parameters
Name | Type | Description |
---|---|---|
Required | ||
vm | string | Virtual machine identifier. |
Request Body Structure:
{
"spec" : {
"start_connected" : true,
"backing" : {
"image_file" : "string",
"type" : "IMAGE_FILE",
"host_device" : "string"
},
"allow_guest_control" : true
}
}
"spec" : {
"start_connected" : true,
"backing" : {
"image_file" : "string",
"type" : "IMAGE_FILE",
"host_device" : "string"
},
"allow_guest_control" : true
}
}
Request Body Parameters:
Name | Type | Description |
---|---|---|
bold = required | ||
spec | create_spec | Specification for the new virtual floppy drive. |
spec.backing | backing_spec | Physical resource backing for the virtual floppy drive. Optional. If unset, defaults to automatic detection of a suitable host device. |
spec.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. |
spec.backing.image_file | string | Path of the image file that should be used as the virtual floppy drive backing. 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. |
spec.backing.host_device | string | Name of the device that should be used as the virtual floppy drive backing. Optional. It is only relevant when type has value HOST_DEVICE. If unset, the virtual floppy drive will be configured to automatically detect a suitable host device. |
spec.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. |
spec.allow_guest_control | boolean | Flag indicating whether the guest can connect and disconnect the device. Optional. Defaults to false if unset. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : "obj-103"
}
"value" : "obj-103"
}
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | string | Virtual floppy drive identifier. |
Errors:
HTTP Status Code | Type | Description |
---|---|---|
500 | error | if the system reported that the floppy device was created but was unable to confirm the creation because the identifier of the new device could not be determined. |
404 | not_found | if the virtual machine is not found. |
400 | not_allowed_in_current_state | if the virtual machine is not powered off. |
500 | unable_to_allocate_resource | if the virtual machine already has the maximum number of supported floppy drives. |
500 | resource_busy | if the virtual machine is busy performing another operation. |
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. |