Try SpotterGather info about clusters available in given vCenter
Authors: Abhijeet Kasurde (@Akasurde), Christian Neugum (@digifuchsi)
Install with ansible-galaxy collection install community.vmware:==4.2.0
collections:
- name: community.vmware
version: 4.2.0This module can be used to gather information about clusters in VMWare infrastructure.
All values and VMware object names are case sensitive.
- 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
port:
default: 443
description:
- The port number of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PORT)
will be used instead.
type: int
schema:
choices:
- summary
- vsphere
default: summary
description:
- Specify the output schema desired.
- The V(summary) output schema is the legacy output from the module.
- The V(vsphere) output schema is the vSphere API class definition which requires
pyvmomi>6.7.1.
type: str
hostname:
description:
- The hostname or IP address of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_HOST)
will be used instead.
type: str
password:
aliases:
- pass
- pwd
description:
- The password of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PASSWORD)
will be used instead.
type: str
show_tag:
default: false
description:
- Tags related to cluster are shown if set to V(true).
type: bool
username:
aliases:
- admin
- user
description:
- The username of the vSphere vCenter or ESXi server.
- If the value is not specified in the task, the value of environment variable E(VMWARE_USER)
will be used instead.
type: str
datacenter:
description:
- Datacenter to search for cluster/s.
- This parameter is required, if O(cluster_name) is not supplied.
required: false
type: str
properties:
description:
- Specify the properties to retrieve.
- 'Example:'
- ' properties: ['
- ' "name",'
- ' "configuration.dasConfig.enabled",'
- ' "summary.totalCpu"'
- ' ]'
- Only valid when O(schema=vsphere).
elements: str
type: list
proxy_host:
description:
- Address of a proxy that will receive all HTTPS requests and relay them.
- The format is a hostname or a IP.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_HOST)
will be used instead.
required: false
type: str
proxy_port:
description:
- Port of the HTTP proxy that will receive all HTTPS requests and relay them.
- If the value is not specified in the task, the value of environment variable E(VMWARE_PROXY_PORT)
will be used instead.
required: false
type: int
cluster_name:
description:
- Name of the cluster.
- If set, information of this cluster will be returned.
- This parameter is required, if O(datacenter) is not supplied.
required: false
type: str
validate_certs:
default: true
description:
- Allows connection when SSL certificates are not valid. Set to V(false) when certificates
are not trusted.
- If the value is not specified in the task, the value of environment variable E(VMWARE_VALIDATE_CERTS)
will be used instead.
type: bool
clusters:
description:
- metadata about the available clusters
returned: always
sample:
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
type: dict