vmware.vmware.cluster_drs_recommendations module – Apply Distributed Resource Scheduler (DRS) recommendations on VMware vSphere clusters
Note
This module is part of the vmware.vmware collection (version 1.11.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_recommendations.
Synopsis
Applies DRS recommendations on VMware vSphere clusters.
DRS recommendations are made based on a variety of factors such as resource usage, host health, and some advanced settings like TryBalanceVmsPerHost. The cluster may not recommend moving a VM if the cost of moving the VM is greater than the benefit that would come after the move.
Recommendations may only be made if the VM can be vMotioned onto another host. Even if a host is clearly overloaded, if the VMs cannot move to another host then no recommendations will appear.
If you try manually vMotioning a VM through the GUI, vCenter will validate the vMotion options at each step. This can be useful when determining why a VM is not able to move to another host and why no recommendations are being made.
Parameters
Parameter |
Comments |
|---|---|
The name of the cluster to be managed. |
|
The name of the datacenter. |
|
The hostname or IP address of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The password of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable |
|
The port number of the vSphere vCenter server. If the value is not specified in the task, the value of environment variable Default: |
|
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 |
|
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 |
|
The username of the vSphere vCenter 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 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. Example: ‘export REQUESTS_CA_BUNDLE=/path/to/your/ca_bundle.pem’
Examples
- name: Apply DRS Recommendations for Cluster
vmware.vmware.cluster_drs_recommendations:
hostname: '{{ vcenter_hostname }}'
username: '{{ vcenter_username }}'
password: '{{ vcenter_password }}'
datacenter_name: datacenter
cluster_name: cluster
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
List of dictionaries describing the applied recommendations Each entry has a description, which is a string saying where servers were moved Each entry has a task_result, which is a dictionary describing the vCenter task Returned: always Sample: |