vmware_cluster_drs – Manage Distributed Resource Scheduler (DRS) on VMware vSphere clusters
New in version 2.9.
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 | Choices/Defaults | Comments |
---|---|---|
cluster_name
string /
required
|
The name of the cluster to be managed.
|
|
datacenter
string /
required
|
The name of the datacenter.
aliases: datacenter_name |
|
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.
|
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 .
|
drs_vmotion_rate
integer
|
|
Threshold for generated ClusterRecommendations.
|
enable_drs
boolean
|
|
Whether to enable DRS.
|
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
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.
aliases: pass, pwd |
|
port
integer
added in 2.5
|
Default:
443
|
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.
|
proxy_host
string
added in 2.9
|
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
added in 2.9
|
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
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.
aliases: admin, user |
|
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
yes , please make sure Python >= 2.7.9 is installed on the given machine.
|
Examples
- name: Enable DRS vmware_cluster_drs: hostname: '{{ vcenter_hostname }}' username: '{{ vcenter_username }}' password: '{{ vcenter_password }}' datacenter_name: datacenter cluster_name: cluster enable_drs: yes delegate_to: localhost - name: Enable DRS and set default VM behavior to partially automated vmware_cluster_drs: hostname: "{{ vcenter_hostname }}" username: "{{ vcenter_username }}" password: "{{ vcenter_password }}" validate_certs: no datacenter_name: DC0 cluster_name: "{{ cluster_name }}" enable_drs: True drs_default_vm_behavior: partiallyAutomated delegate_to: localhost
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Joseph Callen (@jcpowermac)
- Abhijeet Kasurde (@Akasurde)
Hint
If you notice any issues in this documentation, you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/vmware_cluster_drs_module.html