community.windows.win_power_plan – Changes the power plan of a Windows system

Note

This plugin is part of the community.windows collection (version 1.9.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 community.windows.

To use it in a playbook, specify: community.windows.win_power_plan.

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.

  • One of name or guid must be provided.

Parameters

Parameter Choices/Defaults Comments
guid
string
added in 1.9.0 of community.windows
String value that indicates the desired power plan by guid.
The power plan must already be present on the system.
name
string
String value that indicates the desired power plan by name.
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
  community.windows.win_power_plan:
    name: high performance

- name: Change power plan to high performance
  community.windows.win_power_plan:
    guid: 8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c

Return Values

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

Key Returned Description
all_available_plans
dictionary
always
The name and enabled state of all power plans.

Sample:
{ "High performance": false, "Balanced": true, "Power saver": false }
power_plan_enabled
boolean
success
State of the intended power plan.

Sample:
True
power_plan_name
string
always
Value of the intended power plan.

Sample:
balanced


Authors

  • Noah Sparks (@nwsparks)