community.vmware.vmware_guest_info 模块 – 收集单个虚拟机的相关信息

注意

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

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

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

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

概要

• 收集 VMware ESX 集群上单个虚拟机的相关信息。

参数

参数	注释
datacenter 字符串	部署操作的目标数据中心 如果提供了 name 且不唯一，则需要此参数。
folder 字符串	目标文件夹，查找现有虚拟机的绝对或相对路径。 如果提供了 name 且不唯一，则需要此参数。 文件夹应包含数据中心。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
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将使用环境变量 VMWARE_HOST 的值。
moid 字符串	要管理的实例的托管对象 ID（如果已知），这只是单个 vCenter 实例中的唯一标识符。 如果未提供 name 或 uuid，则需要此参数。
name 字符串	要使用的虚拟机的名称 如果未提供 uuid 或 moid，则需要此参数。
name_match 字符串	如果有多个虚拟机匹配名称，则使用找到的第一个或最后一个 选项 "first" ← (默认) "last"
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将使用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定该值，则将使用环境变量 VMWARE_PORT 的值。 默认值： 443
properties 列表 / 元素=字符串	指定要检索的属性。 如果未指定，则检索所有属性（深度检索）。 结果以与 vsphere API 相同的结构返回。 示例 properties: [ “config.hardware.memoryMB”, “config.hardware.numCPU”, “guest.disk”, “overallStatus” ] 仅当 schema=vsphere 时有效。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将使用环境变量 VMWARE_PROXY_PORT 的值。
schema 字符串	指定所需输出模式。 summary 输出模式是模块的旧版输出 vsphere 输出模式是 vSphere API 类定义 选项 "summary" ← (默认) "vsphere"
tag_details 布尔值	如果设置为 true，则返回有关标签的详细信息。 没有此标志，tags=true 返回标签名称列表。 使用此标志，tags=true 返回关于标签信息的字典列表，其中包含类别名称、类别 ID 和标签 ID 等其他详细信息。 添加此参数是为了保持向后兼容性。 选项 false ← (默认) true
tags 布尔值	是否显示标签。 如果设置为 true，则显示标签信息。返回标签名称列表。 如果设置为false，则隐藏标签信息。 需要 vSphere Automation SDK。 选项 false ← (默认) true
use_instance_uuid 布尔值	是否使用 VMware 实例 UUID 而不是 BIOS UUID。 选项 false ← (默认) true
用户名 别名：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: Gather info from standalone ESXi server having datacenter as 'ha-datacenter'
  community.vmware.vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: ha-datacenter
    uuid: 421e4592-c069-924d-ce20-7e7533fab926
  delegate_to: localhost
  register: info

- name: Gather some info from a guest using the vSphere API output schema
  community.vmware.vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
    schema: "vsphere"
    properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"]
  delegate_to: localhost
  register: info

- name: Gather some information about a guest using MoID
  community.vmware.vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    moid: vm-42
    schema: "vsphere"
    properties: ["config.hardware.memoryMB", "guest.disk", "overallStatus"]
  delegate_to: localhost
  register: vm_moid_info

- name: Gather Managed object ID (moid) from a guest using the vSphere API output schema for REST Calls
  community.vmware.vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
    schema: "vsphere"
    properties:
      - _moId
  delegate_to: localhost
  register: moid_info

- name: Gather detailed information about tags and category associated with the given VM
  community.vmware.vmware_guest_info:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter: "{{ datacenter_name }}"
    name: "{{ vm_name }}"
    tags: true
    tag_details: true
  register: detailed_tag_info

返回值

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

键

描述

instance 字典

有关虚拟机的元数据 返回：始终 示例：{"advanced_settings": {}, "annotation": "", "current_snapshot": null, "customvalues": {}, "guest_consolidation_needed": false, "guest_question": null, "guest_tools_status": "guestToolsNotRunning", "guest_tools_version": "10247", "hw_cores_per_socket": 1, "hw_datastores": ["ds_226_3"], "hw_esxi_host": "10.76.33.226", "hw_eth0": {"addresstype": "assigned", "ipaddresses": null, "label": "Network adapter 1", "macaddress": "00:50:56:87:a5:9a", "macaddress_dash": "00-50-56-87-a5-9a", "portgroup_key": null, "portgroup_portkey": null, "summary": "VM Network"}, "hw_files": ["[ds_226_3] ubuntu_t/ubuntu_t.vmx", "[ds_226_3] ubuntu_t/ubuntu_t.nvram", "[ds_226_3] ubuntu_t/ubuntu_t.vmsd", "[ds_226_3] ubuntu_t/vmware.log", "[ds_226_3] u0001/u0001.vmdk"], "hw_folder": "/DC0/vm/Discovered virtual machine", "hw_guest_full_name": null, "hw_guest_ha_state": null, "hw_guest_id": null, "hw_interfaces": ["eth0"], "hw_is_template": false, "hw_memtotal_mb": 1024, "hw_name": "ubuntu_t", "hw_power_status": "poweredOff", "hw_processor_count": 1, "hw_product_uuid": "4207072c-edd8-3bd5-64dc-903fd3a0db04", "hw_version": "vmx-13", "instance_uuid": "5007769d-add3-1e12-f1fe-225ae2a07caf", "ipv4": null, "ipv6": null, "module_hw": true, "moid": "vm-42", "snapshots": [], "tags": ["backup"], "vimref": "vim.VirtualMachine:vm-42", "vnc": {}}

作者

• Loic Blot (@nerzhul)

资源链接

• 问题追踪器
• 主页
• 代码仓库