vmware.vmware.cluster_dpm module – Manage Distributed Power Management (DPM) 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_dpm.

Synopsis

  • Manages DPM on VMware vSphere clusters.

Parameters

Parameter

Comments

automation_level

string

Determines whether the host power state and migration recommendations generated by vSphere DPM are run automatically or manually.

If set to manual, then vCenter generates host power operation and related virtual machine migration recommendations are made, but they are not automatically run.

If set to automatic, then vCenter host power operations are automatically run if related virtual machine migrations can all be run automatically.

Choices:

  • "automatic" ← (default)

  • "manual"

cluster

aliases: cluster_name

string / required

The name of the cluster to be managed.

datacenter

aliases: datacenter_name

string / required

The name of the datacenter.

enable

boolean

Whether to enable DPM.

Choices:

  • false

  • true ← (default)

hostname

string

The hostname or IP address of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

password

aliases: pass, pwd

string

The password of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD will be used instead.

port

integer

The port number of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_PORT will be used instead.

Default: 443

proxy_host

string

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 VMWARE_PROXY_HOST will be used instead.

proxy_port

integer

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 VMWARE_PROXY_PORT will be used instead.

recommendation_priority_threshold

integer

Threshold for generated host power recommendations ranging from 1 (most conservative) to 5 (most aggressive).

The power state (host power on or off) recommendations generated by the vSphere DPM feature are assigned priorities that range from priority 1 recommendations to priority 5 recommendations.

A priority 1 recommendation is mandatory, while a priority 5 recommendation brings only slight improvement

Choices:

  • 1

  • 2

  • 3 ← (default)

  • 4

  • 5

username

aliases: admin, user

string

The username of the vSphere vCenter server.

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

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.

Choices:

  • false

  • true ← (default)

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: Enable DPM
  vmware.vmware.cluster_dpm:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: cluster
    enable: true
  delegate_to: localhost

- name: Enable DPM and generate but don't apply all recommendations
  vmware.vmware.cluster_dpm:
    hostname: '{{ vcenter_hostname }}'
    username: '{{ vcenter_username }}'
    password: '{{ vcenter_password }}'
    datacenter_name: datacenter
    cluster_name: cluster
    enable: true
    automation_level: manual
    recommendation_priority_threshold: 5
  delegate_to: localhost

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

result

dictionary

Information about the DPM config update task, if something changed

If nothing changed, an empty dictionary is returned

Returned: On success

Sample: {"result": {"completion_time": "2024-07-29T15:27:37.041577+00:00", "entity_name": "test-5fb1_cluster_dpm_test", "error": null, "result": null, "state": "success"}}

Authors

  • Ansible Cloud Team (@ansible-collections)