vmware.vmware_rest.vcenter_vm_hardware_parallel 模块 – 向虚拟机添加虚拟并行端口。

注意

此模块是 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_parallel

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'] 时,此键为必需项。

  • 接受的值

  • FILE

  • HOST_DEVICE

  • file (str): 应该用作虚拟并行端口后备的文件的路径。

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

  • host_device (str): 应该用作虚拟并行端口后备的设备的名称。

如果未设置,则虚拟并行端口将被配置为自动检测合适的宿主机设备。(['present'])

label

字符串

项目的名称

port

字符串

虚拟并行端口标识符。

该参数必须是 vmware.vmware_rest.vcenter_vm_hardware_parallel 返回的资源的 ID。state=['absent', 'connect', 'disconnect', 'present'] 时为必需项

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: Turn on guest control on the parallel port
  vmware.vmware_rest.vcenter_vm_hardware_parallel:
    vm: '{{ test_vm1_info.id }}'
    allow_guest_control: true
  register: _result

返回值

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

描述

id

字符串

资源的 moid

返回: 成功时

示例: "10000"

字典

在并行端口上启用客户机控制

返回: 成功时

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

作者

  • Ansible 云团队 (@ansible-collections)