vmware.vmware_rest.vcenter_vm_hardware_floppy module – Manage virtual floppy drives on a virtual machine.

Note

This module is part of the vmware.vmware_rest collection (version 5.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install vmware.vmware_rest.

To use it in a playbook, specify: vmware.vmware_rest.vcenter_vm_hardware_floppy.

New in vmware.vmware_rest 5.0.0

DEPRECATED

Removed in:

version 6.0.0

Why:

Floppy drives are legacy hardware no longer commonly used

Alternative:

Use modern storage options or vmware.vmware.vm for comprehensive hardware management.

Synopsis

• Create, update, and delete virtual floppy drives attached to a VMware virtual machine.

• A virtual floppy drive can be backed by an image file (e.g. a .flp or .img file on a datastore), a physical floppy device on the ESXi host, or a client device connected through the virtual machine console.

• This module also supports connecting and disconnecting an existing virtual floppy drive at runtime using the connect and disconnect states.

• Only present and absent states are idempotent.

Parameters

Parameter	Comments
allow_guest_control boolean	Whether the guest operating system is allowed to connect and disconnect the virtual floppy drive. Defaults to false if omitted. Choices: false true
backing dictionary	Physical resource backing for the virtual floppy drive. If omitted, defaults to automatic detection of a suitable host device.
host_device string	Name of the host device that should be used as the virtual floppy drive backing. If omitted, the virtual floppy drive will be configured to automatically detect a suitable host device. Only relevant when type is HOST_DEVICE.
image_file string	Path of the image file that should be used as the virtual floppy drive backing. Only relevant when type is IMAGE_FILE.
type string	Backing type for the virtual floppy drive. IMAGE_FILE - Virtual floppy drive is backed by an image file on a datastore. HOST_DEVICE - Virtual floppy drive is backed by a physical floppy device on the ESXi 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. Choices: "IMAGE_FILE" "HOST_DEVICE" "CLIENT_DEVICE"
floppy string	Identifier of the virtual floppy drive to manage. Must be an identifier (MOID) for a Floppy resource, for example 8000. Required when state is absent, connect, or disconnect. When state is present, omit to create a new floppy drive or provide to update an existing one. If you provide an ID and the floppy does not exist, a new one will be created with a random ID.
session_timeout float	Timeout in seconds for the whole operation including connection establishment, request sending, and response. Default: 300.0
start_connected boolean	Whether the virtual floppy drive should be connected whenever the virtual machine is powered on. Defaults to false if omitted. Choices: false true
state string	The desired state of the resource. Use present to create or update the resource. Use absent to delete the resource. Use connect to connect the virtual floppy drive to its backing. Use disconnect to disconnect the virtual floppy drive from its backing. Only present and absent support idempotence. Choices: "present" ← (default) "absent" "connect" "disconnect"
vcenter_hostname string / required	The hostname or IP address of the vSphere vCenter. If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.
vcenter_password string / required	The vSphere vCenter password. If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.
vcenter_port integer	The port number of the vSphere vCenter. If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.
vcenter_rest_log_file string	Optional path to a log file for HTTP REST interaction. If the value is not specified in the task, the value of environment variable VMWARE_REST_LOG_FILE will be used instead.
vcenter_username string / required	The vSphere vCenter username. If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.
vcenter_validate_certs boolean	Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted. If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead. Choices: false true ← (default)
vm string / required	Identifier of the virtual machine that owns the floppy drive. Must be an identifier (MOID) for a Vm resource.

Notes

Note

• Generated from vSphere API spec 9.1.0.

• Compatible with vSphere API 7.0.3.

• Compatible with vSphere API 8.0.2.

Examples

- name: Add a virtual floppy drive backed by an image file
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    backing:
      type: IMAGE_FILE
      image_file: "[datastore1] floppies/boot.flp"
    start_connected: true
    allow_guest_control: true
    state: present
  register: floppy_result

- name: Add a virtual floppy drive backed by a client device
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    backing:
      type: CLIENT_DEVICE
    state: present

- name: Update an existing virtual floppy drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    floppy: '{{ floppy_result.id }}'
    allow_guest_control: false
    state: present

- name: Connect a virtual floppy drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    floppy: '{{ floppy_result.id }}'
    state: connect

- name: Disconnect a virtual floppy drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    floppy: '{{ floppy_result.id }}'
    state: disconnect

- name: Remove a virtual floppy drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: vm-1001
    floppy: '{{ floppy_result.id }}'
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
id string	MOID of the managed virtual floppy drive. Returned: When state is present, or when a resource is deleted, or when state is set to a supported action. Sample: "8000"
value any	The raw API response body from the vCenter operation. Returned: On success Sample: {"allow_guest_control": true, "backing": {"image_file": "[datastore1] floppies/boot.flp", "type": "IMAGE_FILE"}, "label": "Floppy drive 1", "start_connected": true, "state": "CONNECTED"}

Status

• This module will be removed in version 6.0.0. [deprecated]

• For more information see DEPRECATED.

Authors

• Ansible Eco Content Team (@eco-ansible-content)

Collection links

• Issue Tracker
• Repository (Sources)