vmware.vmware.cluster_drs_vm_overrides_info module – Get Distributed Resource Scheduler (DRS) VM override settings.

Note

This module is part of the vmware.vmware collection (version 2.12.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 vmware.vmware.

To use it in a playbook, specify: vmware.vmware.cluster_drs_vm_overrides_info.

Synopsis

  • Gets DRS VM override settings on VMware vSphere clusters.

  • Although VM overrides are shown in a unified view in vCenter, this module only gets the DRS override settings.

Parameters

Parameter

Comments

cluster

aliases: cluster_name

string / required

The name of the cluster to get the VM override settings for.

datacenter

aliases: datacenter_name

string / required

The name of the datacenter.

hostname

string

The hostname or IP address of the vSphere vCenter 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 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 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

The 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

The 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 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 require API write access and hence are not supported on a free ESXi license.

  • All variables and VMware object names are case sensitive.

  • Modules may rely on the ‘requests’ python library, which does not use the system certificate store by default. You can specify the certificate store by setting the REQUESTS_CA_BUNDLE environment variable. Note having this variable set may cause a ‘false’ value for the ‘validate_certs’ option to be ignored in some cases. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’

See Also

See also

vmware.vmware.cluster_drs

Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters.

vmware.vmware.cluster_ha_vm_overrides_info

Get vSphere High Availability (HA) VM override settings.

vmware.vmware.cluster_drs_vm_overrides

Manage Distributed Resource Scheduler (DRS) VM override settings.

Examples

- name: Gather VM override settings for a cluster
  vmware.vmware.cluster_drs_vm_overrides_info:
    datacenter: DC01
    cluster: Cluster01

Return Values

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

Key

Description

cluster

dictionary

Display name and MOID of the cluster that was queried.

Returned: success

Sample: {"moid": "cluster-21", "name": "Cluster01"}

vm_overrides

list / elements=string

Information about the VM overrides for the cluster

Each entry has the virtual machine MOID, name, behavior, and enabled state

Returned: On success

Sample: [{"behavior": "fullyAutomated", "enabled": true, "vm_moid": "vm-42", "vm_name": "MyVirtualMachine"}]

Authors

  • Ansible Eco Content Team (@eco-ansible-content)

  • Mike Morency (@mikemorency)