Class List Method List File List

# Class: Com::Vmware::Vcenter::Vm::Hardware::Floppy

Inherits:
  VAPI::Bindings::VapiService
  - Object
  - VAPI::Bindings::VapiService
  - Com::Vmware::Vcenter::Vm::Hardware::Floppy
  show all
Defined in:
  /build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb

## Overview

The ``Com::Vmware::Vcenter::Vm::Hardware::Floppy`` class provides methods for configuring the virtual floppy drives of a virtual machine.

## Defined Under Namespace

Classes: BackingInfo, BackingSpec, BackingType, CreateSpec, Info, Summary, UpdateSpec

## Constant Summary

RESOURCE_TYPE =

      'com.vmware.vcenter.vm.hardware.Floppy'

## Instance Method Summary (collapse)

- - (Void) connect(vm, floppy)

  Connects a virtual floppy drive of a powered-on virtual machine to its backing.

- - (String) create(vm, spec)

  Adds a virtual floppy drive to the virtual machine.

- - (Void) delete(vm, floppy)

  Removes a virtual floppy drive from the virtual machine.

- - (Void) disconnect(vm, floppy)

  Disconnects a virtual floppy drive of a powered-on virtual machine from its backing.

- - (Com::Vmware::Vcenter::Vm::Hardware::Floppy::Info) get(vm, floppy)

  Returns information about a virtual floppy drive.

- - (Floppy) initialize(config) constructor

  Constructs a new instance.

- - (Array<Com::Vmware::Vcenter::Vm::Hardware::Floppy::Summary>) list(vm)

  Returns commonly used information about the virtual floppy drives belonging to the virtual machine.

- - (Void) update(vm, floppy, spec)

  Updates the configuration of a virtual floppy drive.

## Constructor Details

### - (`Floppy`) initialize(config)

Constructs a new instance.

Parameters:

- config (`VAPI::Bindings::StubConfig`) —

  A hash with the api provider details.

    3491
    3492
    3493
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3491

    def initialize(config)
        super(config, @@service_info)
    end

## Instance Method Details

### - (`Void`) connect(vm, floppy)

Connects a virtual floppy drive 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   :func:`Com::Vmware::Vcenter::Vm::Hardware::Floppy.update`    method  may be used to configure the virtual floppy drive to start in the connected state when the virtual machine is powered on.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- floppy (`String`) —

  Virtual floppy drive identifier.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine or virtual floppy drive is not found.

- (`Com::Vmware::Vapi::Std::Errors::AlreadyInDesiredState`) —

  if the virtual floppy drive is already connected.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if the virtual machine is not powered on.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3679
    3680
    3681
    3682
    3683
    3684
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3679

    def connect(vm, floppy)
        invoke_with_info(@@connect_info, {
            'vm' => vm,
            'floppy' => floppy,
        })
    end

### - (`String`) create(vm, spec)

Adds a virtual floppy drive to the virtual machine.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- spec (`Com::Vmware::Vcenter::Vm::Hardware::Floppy::CreateSpec`) —

  Specification for the new virtual floppy drive.

Returns:

- (`String`) —

  Virtual floppy drive identifier.

Raises:

- (`Com::Vmware::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.

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if the virtual machine is not powered off.

- (`Com::Vmware::Vapi::Std::Errors::UnableToAllocateResource`) —

  if the virtual machine already has the maximum number of supported floppy drives.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3579
    3580
    3581
    3582
    3583
    3584
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3579

    def create(vm, spec)
        invoke_with_info(@@create_info, {
            'vm' => vm,
            'spec' => spec,
        })
    end

### - (`Void`) delete(vm, floppy)

Removes a virtual floppy drive from the virtual machine.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- floppy (`String`) —

  Virtual floppy drive identifier.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine or virtual floppy drive is not found.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if the virtual machine is not powered off.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3644
    3645
    3646
    3647
    3648
    3649
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3644

    def delete(vm, floppy)
        invoke_with_info(@@delete_info, {
            'vm' => vm,
            'floppy' => floppy,
        })
    end

### - (`Void`) disconnect(vm, floppy)

Disconnects a virtual floppy drive 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 floppy drive is not connected to its backing resource.

     For a powered-off virtual machine, the   :func:`Com::Vmware::Vcenter::Vm::Hardware::Floppy.update`    method  may be used to configure the virtual floppy floppy to start in the disconnected state when the virtual machine is powered on.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- floppy (`String`) —

  Virtual floppy drive identifier.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine or virtual floppy drive is not found.

- (`Com::Vmware::Vapi::Std::Errors::AlreadyInDesiredState`) —

  if the virtual floppy drive is already disconnected.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if the virtual machine is not powered on.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3714
    3715
    3716
    3717
    3718
    3719
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3714

    def disconnect(vm, floppy)
        invoke_with_info(@@disconnect_info, {
            'vm' => vm,
            'floppy' => floppy,
        })
    end

### - (`Com::Vmware::Vcenter::Vm::Hardware::Floppy::Info`) get(vm, floppy)

Returns information about a virtual floppy drive.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- floppy (`String`) —

  Virtual floppy drive identifier.

Returns:

- (`Com::Vmware::Vcenter::Vm::Hardware::Floppy::Info`) —

  Information about the specified virtual floppy drive.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine or virtual floppy drive is not found.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3543
    3544
    3545
    3546
    3547
    3548
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3543

    def get(vm, floppy)
        invoke_with_info(@@get_info, {
            'vm' => vm,
            'floppy' => floppy,
        })
    end

### - (`Array<Com::Vmware::Vcenter::Vm::Hardware::Floppy::Summary>`) list(vm)

Returns commonly used information about the virtual floppy drives belonging to the virtual machine.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

Returns:

- (`Array<Com::Vmware::Vcenter::Vm::Hardware::Floppy::Summary>`) —

  List of commonly used information about virtual floppy drives.

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine is not found.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3516
    3517
    3518
    3519
    3520
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3516

    def list(vm)
        invoke_with_info(@@list_info, {
            'vm' => vm,
        })
    end

### - (`Void`) update(vm, floppy, spec)

Updates the configuration of a virtual floppy drive.

Parameters:

- vm (`String`) —

  Virtual machine identifier.

- floppy (`String`) —

  Virtual floppy drive identifier.

- spec (`Com::Vmware::Vcenter::Vm::Hardware::Floppy::UpdateSpec`) —

  Specification for updating the virtual floppy drive.

Returns:

- (`Void`)

Raises:

- (`Com::Vmware::Vapi::Std::Errors::Error`) —

  if the system reports an error while responding to the request.

- (`Com::Vmware::Vapi::Std::Errors::NotFound`) —

  if the virtual machine or virtual floppy drive is not found.

- (`Com::Vmware::Vapi::Std::Errors::NotAllowedInCurrentState`) —

  if one or more of the fields specified in the ``spec`` parameter cannot be modified due to the current power state of the virtual machine or the connection state of the virtual floppy drive.

- (`Com::Vmware::Vapi::Std::Errors::ResourceBusy`) —

  if the virtual machine is busy performing another operation.

- (`Com::Vmware::Vapi::Std::Errors::ResourceInaccessible`) —

  if the virtual machine’s configuration state cannot be accessed.

- (`Com::Vmware::Vapi::Std::Errors::ServiceUnavailable`) —

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

- (`Com::Vmware::Vapi::Std::Errors::Unauthenticated`) —

  if the user can not be authenticated.

- (`Com::Vmware::Vapi::Std::Errors::Unauthorized`) —

  if the user doesn’t have the required privileges.

    3612
    3613
    3614
    3615
    3616
    3617
    3618
    # File '/build/mts/release/bora-4571906/build/sdk/aggregated-bindings/ruby/com/vmware/vcenter/vm/hardware.rb', line 3612

    def update(vm, floppy, spec)
        invoke_with_info(@@update_info, {
            'vm' => vm,
            'floppy' => floppy,
            'spec' => spec,
        })
    end