community.vmware.vmware_guest_disk_info 模块 – 收集给定虚拟机磁盘信息

注意

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

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

要安装它,请使用:ansible-galaxy collection install community.vmware

要在 playbook 中使用它,请指定:community.vmware.vmware_guest_disk_info

概要

  • 此模块可用于收集属于给定虚拟机的磁盘信息。

参数

参数

注释

数据中心

字符串 / 必需

虚拟机所属的数据中心名称。

文件夹

字符串

目标文件夹,用于查找现有虚拟机的绝对或相对路径。

这是必需的参数,仅当找到多个同名虚拟机时才需要。

文件夹应包含数据中心。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

主机名

字符串

vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。

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

moid

字符串

要管理的实例的托管对象 ID(如果已知),这是仅在单个 vCenter 实例中唯一的标识符。

如果未提供 nameuuid,则此项为必需。

名称

字符串

虚拟机的名称。

如果未提供参数 uuidmoid,则此项为必需。

密码

别名: pass, pwd

字符串

vSphere vCenter 或 ESXi 服务器的密码。

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

端口

整数

vSphere vCenter 或 ESXi 服务器的端口号。

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

默认值: 443

代理主机

字符串

将接收所有 HTTPS 请求并中继它们的代理的地址。

格式为主机名或 IP。

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

代理端口

整数

将接收所有 HTTPS 请求并中继它们的 HTTP 代理的端口。

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

使用实例 UUID

布尔值

是否使用 VMware 实例 UUID 而不是 BIOS UUID。

选择

  • false ←(默认)

  • true

用户名

别名: admin, user

字符串

vSphere vCenter 或 ESXi 服务器的用户名。

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

uuid

字符串

要收集信息的实例的 UUID(如果已知),这是 VMware 的唯一标识符。

如果未提供参数 namemoid,则此项为必需。

验证证书

布尔值

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

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

选择

  • false

  • true ←(默认)

注意

注意

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

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

示例

- name: Gather disk info from virtual machine using UUID
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: disk_info

- name: Gather disk info from virtual machine using name
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    name: VM_225
  delegate_to: localhost
  register: disk_info

- name: Gather disk info from virtual machine using moid
  community.vmware.vmware_guest_disk_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    moid: vm-42
  delegate_to: localhost
  register: disk_info

返回值

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

描述

guest_disk_info

字典

关于虚拟机磁盘的元数据

返回: 始终

示例: {"0": {"backing_datastore": "datastore2", "backing_disk_mode": "persistent", "backing_diskmode": "persistent", "backing_eagerlyscrub": false, "backing_filename": "[datastore2] VM_225/VM_225.vmdk", "backing_thinprovisioned": false, "backing_type": "FlatVer2", "backing_uuid": "200C3A00-f82a-97af-02ff-62a595f0020a", "backing_writethrough": false, "capacity_in_bytes": 10485760, "capacity_in_kb": 10240, "controller_bus_number": 0, "controller_key": 1000, "controller_type": "paravirtual", "key": 2000, "label": "Hard disk 1", "summary": "10,240 KB", "unit_number": 0}, "1": {"backing_datastore": "datastore3", "backing_devicename": "vml.012345678901234567890123456789012345678901234567890123", "backing_disk_mode": "independent_persistent", "backing_diskmode": "independent_persistent", "backing_filename": "[datastore3] VM_226/VM_226.vmdk", "backing_lunuuid": "012345678901234567890123456789012345678901234567890123", "backing_type": "RawDiskMappingVer1", "backing_uuid": null, "capacity_in_bytes": 15728640, "capacity_in_kb": 15360, "controller_bus_number": 0, "controller_key": 1000, "controller_type": "paravirtual", "key": 2001, "label": "Hard disk 3", "summary": "15,360 KB", "unit_number": 1}}

作者

  • Abhijeet Kasurde (@Akasurde)