community.vmware.vmware_cluster_drs – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters
Note
This plugin is part of the community.vmware collection (version 1.17.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.
Requirements
The below requirements are needed on the host that executes this module.
Tested on ESXi 5.5 and 6.5.
PyVmomi installed.
Parameters
Parameter |
Comments |
---|---|
A dictionary of advanced DRS settings. Default: {} |
|
The name of the cluster to be managed. |
|
The name of the datacenter. |
|
Specifies the cluster-wide default DRS behavior for virtual machines. If set to If set to If set to Choices:
|
|
Whether DRS Behavior overrides for individual virtual machines are enabled. If set to Choices:
|
|
Threshold for generated ClusterRecommendations. Choices:
Default: 3 |
|
Whether to enable DRS. Choices:
|
|
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 Environment variable support added in Ansible 2.6. |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. Default: 443 |
|
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 This feature depends on a version of pyvmomi greater than v6.7.1.2018.12 |
|
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 |
|
The username of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Environment variable support added in Ansible 2.6. If set to Choices:
|
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)