community.vmware.vmware_cluster_drs module – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters

Note

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

Synopsis

  • Manages DRS on VMware vSphere clusters.

  • All values and VMware object names are case sensitive.

Parameters

Parameter

Comments

advanced_settings

dictionary

A dictionary of advanced DRS settings.

Default: {}

cluster_name

string / required

The name of the cluster to be managed.

datacenter

aliases: datacenter_name

string / required

The name of the datacenter.

drs_default_vm_behavior

string

Specifies the cluster-wide default DRS behavior for virtual machines.

If set to partiallyAutomated, vCenter generates recommendations for virtual machine migration and for the placement with a host, then automatically implements placement recommendations at power on.

If set to manual, then vCenter generates recommendations for virtual machine migration and for the placement with a host, but does not implement the recommendations automatically.

If set to fullyAutomated, then vCenter automates both the migration of virtual machines and their placement with a host at power on.

Choices:

  • "fullyAutomated" ← (default)

  • "manual"

  • "partiallyAutomated"

drs_enable_vm_behavior_overrides

boolean

Whether DRS Behavior overrides for individual virtual machines are enabled.

If set to true, overrides drs_default_vm_behavior.

Choices:

  • false

  • true ← (default)

drs_vmotion_rate

integer

Threshold for generated ClusterRecommendations ranging from 1 (lowest) to 5 (highest).

Choices:

  • 1

  • 2

  • 3 ← (default)

  • 4

  • 5

enable

boolean

Whether to enable DRS.

Choices:

  • false

  • true ← (default)

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.

Environment variable support added in Ansible 2.6.

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.

Environment variable support added in Ansible 2.6.

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.

Environment variable support added in Ansible 2.6.

Default: 443

predictive_drs

boolean

added in community.vmware 3.3.0

In addition to real-time metrics, DRS will respond to forecasted metrics provided by vRealize Operations Manager.

You must also configure Predictive DRS in a version of vRealize Operations that supports this feature.

Choices:

  • false ← (default)

  • true

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.

This feature depends on a version of pyvmomi greater than v6.7.1.2018.12

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.

Environment variable support added in Ansible 2.6.

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.

Environment variable support added in Ansible 2.6.

If set to true, please make sure Python >= 2.7.9 is installed on the given machine.

Choices:

  • false

  • true ← (default)

Notes

Note

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

Examples

- name: Enable DRS
  community.vmware.vmware_cluster_drs:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: cluster
    enable: true
  delegate_to: localhost
- name: Enable DRS and distribute a more even number of virtual machines across hosts for availability
  community.vmware.vmware_cluster_drs:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: cluster
    enable: true
    advanced_settings:
      'TryBalanceVmsPerHost': '1'
  delegate_to: localhost
- name: Enable DRS and set default VM behavior to partially automated
  community.vmware.vmware_cluster_drs:
    hostname: "{{ vcenter_hostname }}"
    username: "{{ vcenter_username }}"
    password: "{{ vcenter_password }}"
    datacenter_name: DC0
    cluster_name: "{{ cluster_name }}"
    enable: true
    drs_default_vm_behavior: partiallyAutomated
  delegate_to: localhost

Authors

  • Joseph Callen (@jcpowermac)

  • Abhijeet Kasurde (@Akasurde)