community.vmware.vmware_drs_group_info module – Gathers info about DRS VM/Host groups on the given cluster

Note

This module is part of the community.vmware collection (version 5.2.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.vmware.

To use it in a playbook, specify: community.vmware.vmware_drs_group_info.

Synopsis

  • This module can be used to gather information about DRS VM/HOST groups from the given cluster.

Parameters

Parameter

Comments

cluster_name

string

Cluster to search for VM/Host groups.

If set, information of DRS groups belonging this cluster will be returned.

Needed if datacenter is not set.

cluster_name and datacenter are mutually exclusive parameters.

datacenter

aliases: datacenter_name

string

Datacenter to search for DRS VM/Host groups.

Needed if cluster_name is not set.

cluster_name and datacenter are mutually exclusive parameters.

hostname

string

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 VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

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 VMWARE_PROXY_PORT will be used instead.

username

aliases: admin, user

string

The username of the vSphere vCenter or ESXi server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • All modules requires API write access and hence is not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

Examples

---
- name: "Gather DRS info about given Cluster"
  register: cluster_drs_group_info
  community.vmware.vmware_drs_group_info:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    cluster_name: "{{ cluster_name }}"
  delegate_to: localhost

- name: "Gather DRS group info about all clusters in given datacenter"
  register: cluster_drs_group_info
  community.vmware.vmware_drs_group_info:
    hostname: "{{ vcenter_hostname }}"
    password: "{{ vcenter_password }}"
    username: "{{ vcenter_username }}"
    datacenter: "{{ datacenter }}"
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

drs_group_info

dictionary

Metadata about DRS group from given cluster / datacenter

Returned: always

Sample: {"drs_group_info": {"DC0_C0": [{"group_name": "GROUP_HOST_S01", "hosts": ["vm-01.zone", "vm-02.zone"], "type": "host"}, {"group_name": "GROUP_HOST_S02", "hosts": ["vm-03.zone", "vm-04.zone"], "type": "host"}, {"group_name": "GROUP_VM_S01", "type": "vm", "vms": ["test-node01"]}, {"group_name": "GROUP_VM_S02", "type": "vm", "vms": ["test-node02"]}], "DC0_C1": []}}

Authors

  • Karsten Kaj Jakobsen (@karstenjakobsen)