vmware.vmware.cluster_drs module – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters
Note
This module is part of the vmware.vmware collection (version 1.6.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
.
Synopsis
Manages DRS on VMware vSphere clusters.
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 ranging from Choices:
|
|
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 |
|
The password of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter or ESXi server. If the value is not specified in the task, the value of environment variable Default: |
|
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:
|
|
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 |
|
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 |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
All modules require API write access and hence is not supported on a free ESXi license.
All variables and VMware object names are case sensitive.
Examples
- name: Enable DRS
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
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
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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Information about the DRS config update task, if something changed If nothing changed, an empty dictionary is returned Returned: On success Sample: |