community.vmware.vmware_cluster_info 模块 – 收集给定 vCenter 中可用集群的信息

注意

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

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

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

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

概要

• 此模块可用于收集有关 VMware 基础架构中集群的信息。

参数

参数	注释
cluster_name 字符串	集群名称。 如果设置，则将返回此集群的信息。 如果未提供 datacenter，则此参数是必需的。
datacenter 字符串	搜索集群的 数据中心。 如果未提供 cluster_name，则此参数是必需的。
hostname 字符串	vSphere vCenter 或 ESXi 服务器的主机名或 IP 地址。 如果任务中未指定该值，则将改用环境变量 VMWARE_HOST 的值。
password 别名：pass，pwd 字符串	vSphere vCenter 或 ESXi 服务器的密码。 如果任务中未指定该值，则将改用环境变量 VMWARE_PASSWORD 的值。
port 整数	vSphere vCenter 或 ESXi 服务器的端口号。 如果任务中未指定该值，则将改用环境变量 VMWARE_PORT 的值。 默认值： 443
properties 列表 / 元素=字符串	指定要检索的属性。 示例 properties: [ “name”, “configuration.dasConfig.enabled”, “summary.totalCpu” ] 仅当 schema=vsphere 时有效。
proxy_host 字符串	将接收所有 HTTPS 请求并转发它们的代理的地址。 格式为主机名或 IP。 如果任务中未指定该值，则将改用环境变量 VMWARE_PROXY_HOST 的值。
proxy_port 整数	将接收所有 HTTPS 请求并转发它们的 HTTP 代理的端口。 如果任务中未指定该值，则将改用环境变量 VMWARE_PROXY_PORT 的值。
schema 字符串	指定所需的输出模式。 summary 输出模式是模块的旧版输出。 vsphere 输出模式是 vSphere API 类定义。 选项 "summary" ← (默认) "vsphere"
show_tag 布尔值	如果设置为 true，则显示与集群相关的标签。 选项 false ← (默认) true
username 别名：admin，user 字符串	vSphere vCenter 或 ESXi 服务器的用户名。 如果任务中未指定该值，则将改用环境变量 VMWARE_USER 的值。
validate_certs 布尔值	当 SSL 证书无效时允许连接。当证书不受信任时，设置为 false。 如果任务中未指定该值，则将改用环境变量 VMWARE_VALIDATE_CERTS 的值。 选项 false true ← (默认)

备注

注意

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

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

示例

- name: Gather cluster info from given datacenter
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter: ha-datacenter
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
  delegate_to: localhost
  register: cluster_info

- name: Gather info from datacenter about specific cluster with tags
  community.vmware.vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
    show_tag: true
  delegate_to: localhost
  register: cluster_info

- name: Gather some info from a cluster using the vSphere API output schema
  vmware_cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: DC0_C0
    schema: vsphere
    properties:
      - name
      - configuration.dasConfig.enabled
      - summary.totalCpu
  delegate_to: localhost
  register: cluster_info

返回值

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

键

描述

clusters 字典

有关可用集群的元数据 返回： 始终 示例： {"DC0_C0": {"datacenter": "DC0", "drs_default_vm_behavior": null, "drs_enable_vm_behavior_overrides": null, "drs_vmotion_rate": null, "enable_ha": null, "enabled_drs": true, "enabled_vsan": false, "ha_admission_control_enabled": null, "ha_failover_level": null, "ha_host_monitoring": null, "ha_restart_priority": null, "ha_vm_failure_interval": null, "ha_vm_max_failure_window": null, "ha_vm_max_failures": null, "ha_vm_min_up_time": null, "ha_vm_monitoring": null, "ha_vm_tools_monitoring": null, "hosts": [{"folder": "/DC0/host/DC0_C0", "name": "esxi01.vsphere.local"}, {"folder": "/DC0/host/DC0_C0", "name": "esxi02.vsphere.local"}, {"folder": "/DC0/host/DC0_C0", "name": "esxi03.vsphere.local"}, {"folder": "/DC0/host/DC0_C0", "name": "esxi04.vsphere.local"}], "moid": "domain-c9", "resource_summary": {"cpuCapacityMHz": 4224, "cpuUsedMHz": 87, "memCapacityMB": 6139, "memUsedMB": 1254, "pMemAvailableMB": 0, "pMemCapacityMB": 0, "storageCapacityMB": 33280, "storageUsedMB": 19953}, "tags": [{"category_id": "urn:vmomi:InventoryServiceCategory:9fbf83de-7903-442e-8004-70fd3940297c:GLOBAL", "category_name": "sample_cluster_cat_0001", "description": "", "id": "urn:vmomi:InventoryServiceTag:93d680db-b3a6-4834-85ad-3e9516e8fee8:GLOBAL", "name": "sample_cluster_tag_0001"}], "vsan_auto_claim_storage": false}}

作者

• Abhijeet Kasurde (@Akasurde)

• Christian Neugum (@digifuchsi)

相关链接

• 问题追踪
• 主页
• 代码库 (源码)