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

Note

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

Comments

guid

string

added in community.windows 1.9.0

String value that indicates the desired power plan by guid.

The power plan must already be present on the system.

For out of box guids see https://docs.microsoft.com/en-us/windows/win32/power/power-policy-settings.

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

Description

all_available_plans

dictionary

The name and enabled state of all power plans.

Returned: always

Sample: {"Balanced": true, "High performance": false, "Power saver": false}

power_plan_enabled

boolean

State of the intended power plan.

Returned: success

Sample: true

power_plan_name

string

Value of the intended power plan.

Returned: always

Sample: "balanced"

Authors

  • Noah Sparks (@nwsparks)