vmware.vmware.cluster_info 模块 – 收集有关一个或多个集群的信息

注意

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

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

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

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

概要

  • 收集有关一个或多个集群的信息。您可以根据集群名称、数据中心名称或两者的组合来搜索集群。

参数

参数

注释

cluster

别名：cluster_name, name

字符串

要收集信息的集群名称。

至少需要 datacenter 或 cluster 之一。

datacenter

别名：datacenter_name

字符串

数据中心的名称。

至少需要 datacenter 或 cluster 之一。

gather_tags

布尔值

如果为真，则收集附加到集群的任何标签。

如果 schema 设置为 vsphere，则此选项无效。在这种情况下，请将 'tag' 添加到 properties 中，或将 properties 保留为空。

选项

  • false ← (默认值)

  • true

hostname

字符串

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

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

password

别名：pass, pwd

字符串

vSphere vCenter 服务器的密码。

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

port

整数

vSphere vCenter 服务器的端口号。

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

默认值： 443

properties

列表 / 元素=字符串

如果模式为 'vsphere'，则仅收集这些特定属性。

proxy_host

字符串

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

格式为主机名或 IP。

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

proxy_port

整数

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

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

schema

字符串

指定所需的输出模式。

summary 输出模式是模块的旧版输出。

vsphere 输出模式是 vSphere API 类定义。

选项

  • "summary" ← (默认值)

  • "vsphere"

username

别名：admin, user

字符串

vSphere vCenter 服务器的用户名。

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

validate_certs

布尔值

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

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

选项

  • false

  • true ← (默认)

备注

注意

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

示例

- name: Gather Cluster Information
  vmware.vmware.cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: my_cluster
  register: _out

- name: Gather Information About All Clusters In a Datacenter
  vmware.vmware.cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
  register: _out

- name: Gather Specific Properties About a Cluster
  vmware.vmware.cluster_info:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    cluster_name: my_cluster
    schema: vsphere
    properties:
        - name
        - configuration.dasConfig.enabled
        - summary.totalCpu
  register: _out

返回值

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

键

描述

集群

字典

描述搜索参数找到的集群的字典。

键是集群名称，值是包含集群信息的字典。

返回：成功时

示例： {"clusters": {"My-Cluster": {"datacenter": "My-Datacenter", "dpm_default_dpm_behavior": "automated", "dpm_enabled": false, "dpm_host_power_action_rate": 3, "drs_default_vm_behavior": "fullyAutomated", "drs_enable_vm_behavior_overrides": true, "drs_enabled": true, "drs_vmotion_rate": 3, "ha_admission_control_enabled": true, "ha_enabled": false, "ha_failover_level": 1, "ha_host_monitoring": "enabled", "ha_restart_priority": "medium", "ha_vm_failure_interval": 30, "ha_vm_max_failure_window": -1, "ha_vm_max_failures": 3, "ha_vm_min_up_time": 120, "ha_vm_monitoring": "vmMonitoringDisabled", "ha_vm_tools_monitoring": "vmMonitoringDisabled", "hosts": [{"folder": "/My-Datacenter/host/My-Cluster", "name": "Esxi-1"}, {"folder": "/My-Datacenter/host/My-Cluster", "name": "Esxi-2"}], "moid": "domain-c11", "resource_summary": {"cpuCapacityMHz": 514080, "cpuUsedMHz": 21241, "memCapacityMB": 1832586, "memUsedMB": 348366, "pMemAvailableMB": 0, "pMemCapacityMB": 0, "storageCapacityMB": 12238642, "storageUsedMB": 4562117}, "tags": [], "vsan_auto_claim_storage": false, "vsan_enabled": false}}}

作者

  • Ansible云团队 (@ansible-collections)