New in version 2.4.
balanced
which will cause CPU throttling. In some cases it can be preferable to change the mode to high performance
to increase CPU performance.The below requirements are needed on the host that executes this module.
Parameter | Choices/Defaults | Comments |
---|---|---|
name
required |
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 . |
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
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.