W3cubDocs

/Ansible

win_power_plan - Changes the power plan of a Windows system

New in version 2.4.

Synopsis

  • This module will change the power plan of a Windows system to the defined string.
  • Windows defaults to balanced which will cause CPU throttling. In some cases it can be preferable to change the mode to high performance to increase CPU performance.

Requirements (on host that executes module)

  • Windows Server 2008R2 (6.1)/Windows 7 or higher

Options

parameter required default choices comments
name
 yes
String value that indicates the desired power plan. The power plan must already be present on the system. Commonly there will be options for balanced and high performance.

Examples

- name: change power plan to high performance
  win_power_plan:
    name: high performance

Return Values

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

name description returned type sample
all_available_plans
The name and enabled state of all power plans
 always dictionary { "High performance": false, "Balanced": true, "Power saver": false }
power_plan_name
Value of the intended power plan
 always string balanced
power_plan_enabled
State of the intended power plan
 success boolean True

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/win_power_plan_module.html