vmware.vmware_rest.vcenter_vm_hardware_floppy 模块 – 向虚拟机添加虚拟软盘驱动器。

注意

此模块是 vmware.vmware_rest 集合 (版本 4.3.0) 的一部分。

如果您使用的是 ansible 包,则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install vmware.vmware_rest。您需要其他需求才能使用此模块,有关详细信息,请参阅 需求

要在playbook中使用它,请指定:vmware.vmware_rest.vcenter_vm_hardware_floppy

vmware.vmware_rest 0.1.0中的新增功能

概要

  • 向虚拟机添加虚拟软盘驱动器。

需求

在执行此模块的主机上需要以下需求。

  • vSphere 7.0.3 或更高版本

  • python >= 3.6

  • aiohttp

参数

参数

注释

allow_guest_control

布尔值

指示客户机是否可以连接和断开设备的标志。

如果未设置,则值保持不变。

选项

  • false

  • true

backing

字典

虚拟软盘驱动器的物理资源支持。

如果未设置,则默认为自动检测合适的宿主设备。与state=[‘present’]一起使用时是必需的。

有效属性为

  • type (str): 此选项定义虚拟软盘驱动器的有效支持类型。([‘present’])

此键与[‘present’]一起使用时是必需的。

  • 接受的值

  • CLIENT_DEVICE

  • HOST_DEVICE

  • IMAGE_FILE

  • image_file (str): 应用作虚拟软盘驱动器支持的映像文件的路径。

此字段是可选的,只有当type的值为IMAGE_FILE时才相关。([‘present’])

  • host_device (str): 应用作虚拟软盘驱动器支持的设备的名称。

如果未设置,则虚拟软盘驱动器将配置为自动检测合适的宿主设备。([‘present’])

floppy

字符串

虚拟软盘驱动器标识符。

此参数必须是由 vmware.vmware_rest.vcenter_vm_hardware_floppy返回的资源的ID。与state=[‘absent’, ‘connect’, ‘disconnect’, ‘present’]一起使用时是必需的。

label

字符串

项目的名称

session_timeout

浮点数

在vmware.vmware_rest 2.1.0中添加

客户端会话的超时设置。

整个操作(包括连接建立、请求发送和响应)的最大秒数。

默认值为300秒。

start_connected

布尔值

指示虚拟设备在虚拟机每次启动时是否应连接的标志。

如果未设置,则值保持不变。

选项

  • false

  • true

state

字符串

选项

  • "absent"

  • "connect"

  • "disconnect"

  • "present" ← (默认)

vcenter_hostname

字符串 / 必需

vSphere vCenter的主机名或IP地址

如果任务中未指定此值,则将使用环境变量VMWARE_HOST的值。

vcenter_password

字符串 / 必需

vSphere vCenter密码

如果任务中未指定此值,则将使用环境变量VMWARE_PASSWORD的值。

vcenter_rest_log_file

字符串

您可以使用此可选参数来设置日志文件的位置。

此文件将用于记录HTTP REST交互。

该文件将存储在运行模块的主机上。

如果任务中未指定此值,则将使用

环境变量VMWARE_REST_LOG_FILE的值。

vcenter_username

字符串 / 必需

vSphere vCenter用户名

如果任务中未指定此值,则将使用环境变量VMWARE_USER的值。

vcenter_validate_certs

布尔值

当SSL证书无效时允许连接。当证书不受信任时,设置为false

如果任务中未指定此值,则将使用环境变量VMWARE_VALIDATE_CERTS的值。

选项

  • false

  • true ← (默认)

vm

字符串 / 必需

虚拟机标识符。

此参数必须是由 vmware.vmware_rest.vcenter_vm_info返回的资源的ID。此参数是必需的。

注释

注意

  • 在vSphere 7.0.3上测试

示例

- name: Look up the VM called test_vm1 in the inventory
  register: search_result
  vmware.vmware_rest.vcenter_vm_info:
    filter_names:
    - test_vm1

- name: Collect information about a specific VM
  vmware.vmware_rest.vcenter_vm_info:
    vm: '{{ search_result.value[0].vm }}'
  register: test_vm1_info

- name: Add a floppy disk drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: '{{ test_vm1_info.id }}'
    allow_guest_control: true
  register: my_floppy_drive

- name: Remove a floppy drive
  vmware.vmware_rest.vcenter_vm_hardware_floppy:
    vm: '{{ test_vm1_info.id }}'
    floppy: '{{ my_floppy_drive.id }}'
    state: absent
  register: _result

返回值

常见的返回值已在 此处 记录,以下是此模块独有的字段:

描述

id

字符串

资源的moid

返回值: 成功时

示例: "8000"

字典

添加软盘驱动器

返回值: 成功时

示例: {"allow_guest_control": 1, "backing": {"auto_detect": 1, "host_device": "", "type": "HOST_DEVICE"}, "label": "Floppy drive 1", "start_connected": 0, "state": "NOT_CONNECTED"}

作者

  • Ansible 云团队 (@ansible-collections)