community.vmware.vmware_guest_controller 模块 – 管理给定 vCenter 基础架构中与虚拟机相关的磁盘或 USB 控制器

注意

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

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

要安装它，请使用： ansible-galaxy collection install community.vmware。

要在 playbook 中使用它，请指定： community.vmware.vmware_guest_controller。

概要

• 此模块可用于添加、删除属于给定虚拟机的磁盘控制器或 USB 控制器。

参数

参数	注释
controllers 列表 / 元素=字典	要添加或删除的磁盘或 USB 控制器的列表。 每个虚拟机允许最多 4 个相同类型的磁盘控制器。 每个虚拟机允许最多 2 个 USB 控制器，1 个 USB 2.0 和 1 个 USB 3.0 或 3.1。 对于特定客户操作系统，支持的控制器类型，请参考 VMware 兼容性指南。
bus_sharing 字符串	SCSI 控制器的总线共享类型。 选项 "noSharing" ← (默认) "physicalSharing" "virtualSharing"
controller_number 整数	磁盘控制器的总线号。当 controllers[].state=absent 时，此参数是必需的。 当 controllers[].type=usb2 或 controllers[].type=usb3 时，此参数不是必需的。 选项 0 1 2 3
state 字符串 / 必需	添加新的控制器或删除指定的现有控制器。 如果设置为 absent，则当没有磁盘或设备连接到它时，指定的控制器将从虚拟机中删除。 如果指定的控制器已删除或不存在，则不会执行任何操作，只会显示警告消息。 如果设置为 present，则将添加具有指定类型的新的控制器。 如果具有指定控制器类型的控制器数量达到其最大值，则不会执行任何操作，只会显示警告消息。 选项 "present" "absent"
type 字符串 / 必需	磁盘或 USB 控制器的类型。 从 vSphere 6.5 和硬件版本为 13 的虚拟机开始，支持 nvme 控制器。 选项 "buslogic" "lsilogic" "lsilogicsas" "paravirtual" "sata" "nvme" "usb2" "usb3"
datacenter 字符串	虚拟机所属的数据中心名称。 默认值： "ha-datacenter"
folder 字符串	目标文件夹，查找现有客户机的绝对或相对路径。 这是一个必需参数，仅当找到多个具有相同名称的虚拟机时。 文件夹应包含数据中心。ESX 的数据中心是 ha-datacenter 示例 folder: /ha-datacenter/vm folder: ha-datacenter/vm folder: /datacenter1/vm folder: datacenter1/vm folder: /datacenter1/vm/folder1 folder: datacenter1/vm/folder1 folder: /folder1/datacenter1/vm folder: folder1/datacenter1/vm folder: /folder1/datacenter1/vm/folder2
gather_disk_controller_facts 布尔值	是否仅收集现有磁盘和 USB 控制器的事实。 当此参数设置为 true 时，controllers 参数将被忽略。 选项 false ← (默认) true
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量 VMWARE_HOST 的值。
moid 字符串	已知实例的管理对象 ID，这是一个仅在单个 vCenter 实例中唯一的标识符。 如果未提供name或uuid，则需要此参数。
name 字符串	虚拟机的名称。 如果未提供参数uuid或moid，则此参数为必填参数。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定此值，则将使用环境变量VMWARE_PASSWORD的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定此值，则将使用环境变量VMWARE_PORT的值。 默认值：443
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP 地址。 如果任务中未指定此值，则将使用环境变量VMWARE_PROXY_HOST的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定此值，则将使用环境变量VMWARE_PROXY_PORT的值。
sleep_time 整数	VM 重新配置任务完成后休眠的秒数，在 VM 重新配置后无法获取更新的 VM 控制器信息时使用。 此参数不是必需的。最大值为 600。 默认值：10
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项 false ← (默认) true
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定此值，则将使用环境变量VMWARE_USER的值。
uuid 字符串	已知实例的 UUID，用于收集信息，这是 VMware 的唯一标识符。 如果未提供参数name或moid，则此参数为必填参数。
validate_certs 布尔值	允许在 SSL 证书无效时连接。当证书不受信任时，将其设置为false。 如果任务中未指定此值，则将使用环境变量VMWARE_VALIDATE_CERTS的值。 选项 false true ← (默认值)

备注

注意

• 所有模块都需要 API 写入访问权限，因此在免费 ESXi 许可证上不受支持。

• 所有变量和 VMware 对象名称都区分大小写。

示例

- name: Add disk and USB 3.0 controllers for virtual machine located by name
  community.vmware.vmware_guest_controller:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: test_VM
    controllers:
      - state: present
        type: sata
      - state: present
        type: nvme
      - state: present
        type: usb3
  delegate_to: localhost
  register: disk_controller_facts

- name: Remove disk controllers and USB 2.0 from virtual machine located by moid
  community.vmware.vmware_guest_controller:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-33
    controllers:
      - state: absent
        controller_number: 1
        type: sata
      - state: absent
        controller_number: 0
        type: nvme
      - state: absent
        type: usb2
  delegate_to: localhost
  register: disk_controller_facts

返回值

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

键

描述

disk_controller_status 字典

关于虚拟机现有磁盘控制器或添加或删除操作后的元数据 返回：始终 示例：{"nvme": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 31000, "controller_disks_devicekey": [], "controller_label": "NVME controller 0", "controller_summary": "NVME controller 0", "controller_unitnumber": 30}}, "sata": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 15000, "controller_disks_devicekey": [16000, 16001], "controller_label": "SATA controller 0", "controller_summary": "AHCI", "controller_unitnumber": 24}}, "scsi": {"0": {"controller_bus_sharing": "noSharing", "controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 1000, "controller_disks_devicekey": [2000], "controller_label": "SCSI controller 0", "controller_summary": "LSI Logic SAS", "controller_unitnumber": 3}, "1": {"controller_bus_sharing": "physicalSharing", "controller_busnumber": 1, "controller_controllerkey": 100, "controller_devicekey": 1001, "controller_disks_devicekey": [], "controller_label": "SCSI controller 1", "controller_summary": "VMware paravirtual SCSI", "controller_unitnumber": 4}}, "usb2": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 7000, "controller_disks_devicekey": [], "controller_label": "USB Controller", "controller_summary": "Auto connect Disabled", "controller_unitnumber": 22}}}

作者

• 王戴安 (@Tomorrow9)

收藏链接

• 问题跟踪器
• 主页
• 代码库（源代码）