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 控制器。

参数

参数	注释
控制器 列表 / 元素=字典	要添加或删除的磁盘或 USB 控制器列表。 每个虚拟机允许总共 4 个相同类型的磁盘控制器。 每个虚拟机允许总共 2 个 USB 控制器，1 个 USB 2.0 和 1 个 USB 3.0 或 3.1。 对于特定的客户机操作系统，支持的控制器类型请参考 VMware 兼容性指南。
总线共享 字符串	SCSI 控制器的总线共享类型。 选择 "noSharing" ← (默认) "physicalSharing" "virtualSharing"
controller_number 整数	磁盘控制器总线编号。当 controllers[].state=absent 时，此参数为必填项。 当 controllers[].type=usb2 或 controllers[].type=usb3 时，此参数不是必需的。 选择 0 1 2 3
状态 字符串 / 必需	添加新的控制器或删除指定的现有控制器。 如果设置为 absent，当没有磁盘或设备连接到指定的控制器时，将从虚拟机中删除该控制器。 如果指定的控制器被删除或不存在，则不会采取任何操作，只会发出警告消息。 如果设置为 present，将添加具有指定类型的新控制器。 如果具有指定控制器类型的控制器的数量达到最大值，则不会采取任何操作，只会发出警告消息。 选择 "present" "absent"
类型 字符串 / 必需	磁盘或 USB 控制器的类型。 从 vSphere 6.5 和硬件版本为 13 的虚拟机开始，支持 nvme 控制器。 选择 "buslogic" "lsilogic" "lsilogicsas" "paravirtual" "sata" "nvme" "usb2" "usb3"
数据中心 字符串	虚拟机所属的数据中心名称。 默认值： "ha-datacenter"
文件夹 字符串	目标文件夹，用于查找现有客户机的绝对或相对路径。 仅当找到多个同名虚拟机时，此参数才为必填项。 该文件夹应包括数据中心。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
主机名 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将改用环境变量 VMWARE_HOST 的值。
moid 字符串	要管理的实例的托管对象 ID（如果已知），这在单个 vCenter 实例中是唯一的标识符。 如果未提供 name 或 uuid，则此为必需。
名称 字符串	虚拟机的名称。 如果未提供参数 uuid 或 moid，则此为必填参数。
密码 别名：pass, pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将改用环境变量 VMWARE_PASSWORD 的值。
端口 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定该值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
proxy_host 字符串	接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP 地址。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。
sleep_time 整数	在虚拟机重新配置任务完成后，等待的秒数，用于在虚拟机重新配置后未获取更新的虚拟机控制器信息时使用。 此参数不是必需的。最大值为 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 控制器 0", "controller_summary": "NVME 控制器 0", "controller_unitnumber": 30}}, "sata": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 15000, "controller_disks_devicekey": [16000, 16001], "controller_label": "SATA 控制器 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 控制器 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 控制器 1", "controller_summary": "VMware 准虚拟化 SCSI", "controller_unitnumber": 4}}, "usb2": {"0": {"controller_busnumber": 0, "controller_controllerkey": 100, "controller_devicekey": 7000, "controller_disks_devicekey": [], "controller_label": "USB 控制器", "controller_summary": "自动连接已禁用", "controller_unitnumber": 22}}}

作者

• Diane Wang (@Tomorrow9)

集合链接

• 问题跟踪器
• 主页
• 存储库（来源）