Vcenter Vm Hardware Floppy create

Adds a virtual floppy drive to the virtual machine.

Request

URI

POST

https://{api_host}/api/vcenter/vm/{vm}/hardware/floppy

COPY

Path Parameters

string

Required

Virtual machine identifier.

The parameter must be an identifier for the resource type: VirtualMachine.

Request Body

Specification for the new virtual floppy drive.

Vcenter Vm Hardware Floppy CreateSpec of type(s) application/json

Required

{
    "backing": {
        "type": "string",
        "image_file": "string",
        "host_device": "string"
    },
    "start_connected": false,
    "allow_guest_control": false
}

backing

Optional

Physical resource backing for the virtual floppy drive.

If missing or null, defaults to automatic detection of a suitable host device.

boolean

start_connected

Optional

Flag indicating whether the virtual device should be connected whenever the virtual machine is powered on.

Defaults to false if missing or null.

boolean

allow_guest_control

Optional

Flag indicating whether the guest can connect and disconnect the device.

Defaults to false if missing or null.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

201

Virtual floppy drive identifier.

The response will be an identifier for the resource type: com.vmware.vcenter.vm.hardware.Floppy.

Returns string of type(s) application/json

Operation doesn't return any data structure

400

if the virtual machine is not powered off.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0

"Vapi Std Errors NotAllowedInCurrentState Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

404

if the virtual machine is not found.

Returns Vapi Std Errors NotFound of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors NotFound0

"Vapi Std Errors NotFound Object"

500

Vapi Std Errors 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.
if the system reports an error while responding to the request.

Vapi Std Errors UnableToAllocateResource if the virtual machine already has the maximum number of supported floppy drives.

Vapi Std Errors ResourceBusy if the virtual machine is busy performing another operation.

Vapi Std Errors ResourceInaccessible if the virtual machine's configuration state cannot be accessed.

Returns Vapi Std Errors Error of type(s) application/json

"Vapi Std Errors Error Object"

array of object

messages

Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object

data

Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string

error_type

Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/vm/{vm}/hardware/floppy

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Errors

Vcenter Operations

GET

Vcenter Vm Hardware Floppy list