ansible.builtin.win_power_plan (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

Description

This module will change the power plan of a Windows system to the defined string.

Windows defaults to C(balanced) which will cause CPU throttling. In some cases it can be preferable to change the mode to C(high performance) to increase CPU performance.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description:
    - String value that indicates the desired power plan.
    - The power plan must already be present on the system.
    - Commonly there will be options for C(balanced) and C(high performance).
    required: true
    type: str

Outputs

all_available_plans:
  description: The name and enabled state of all power plans.
  returned: always
  sample: "{\n    \"High performance\":  false,\n    \"Balanced\":  true,\n    \"\
    Power saver\":  false\n}\n"
  type: dict
power_plan_enabled:
  description: State of the intended power plan.
  returned: success
  sample: true
  type: bool
power_plan_name:
  description: Value of the intended power plan.
  returned: always
  sample: balanced
  type: str