PowerPlans.adoc

DSC Resource 'PowerPlans'

PowerPlans is used to manage Power Plan configuration.

Source	https://github.com/dsccommunity/CommonTasks/tree/main/source/DSCResources/PowerPlans
DSC Resource	DSCR_PowerPlan
Documentation	cPowerPlan, cPowerPlanSetting

Table 1. Attributes of category 'PowerPlans'

Parameter	Attribute	DataType	Description	Allowed Values
Hibernate		String	Enable or disable hibernate mode.	On Off
Plans		Hashtable[]	Power Plans
Settings		Hashtable[]	Power Plan Settings

Table 2. Attributes of category 'PowerPlans/Plans'

Parameter	Attribute	DataType	Description	Allowed Values
GUID	Key	String	The GUID of Power Plan. If you want to create Original Plan, should specify unique GUID. If you want to set system default Plans, you can use aliases: SCHEME_MAX SCHEME_MIN SCHEME_BALANCED
Name	Mandatory	String	The Name of Power Plan.
Description		String	The Description of Power Plan.
Active		Boolean	Specifies set or unset Power Plan as Active.	True False
Ensure		String	Specifies existence state of Power Plan.	Present (default) Absent

Table 3. Attributes of category 'PowerPlans/Settings'

Parameter	Attribute	DataType	Description	Allowed Values
SettingGuid	Key	String	The GUID of Power Setting. You can obtain GUIDs by executing powercfg.exe /Q command You can also use some aliases obtained by executing powercfg.exe /ALIASES command.
PlanGuid	Key	String	The GUID of target Power Plan. You can also use aliases: ACTIVE ALL SCHEME_MAX SCHEME_MIN SCHEME_BALANCED If you specify the alias ALL, all Power Plans on the current system to be targeted.
AcDc	Key	String	Specify whether setting is set for AC (plugged in), DC (battery) or Both.	AC DC Both (default)
Value	Mandatory	UInt32	Specifies Power Setting value

Example

PowerPlans:
  Plans:
    - GUID: SCHEME_MAX
      Name: Power Saver
      Description: Power Saver
    - GUID: SCHEME_BALANCED
      Name: Balanced
      Active: True
  Settings:
    - PlanGuid: ALL
      SettingGuid: STANDBYIDLE
      AcDc: AC
      Value: 0
    - PlanGuid: SCHEME_MIN
      SettingGuid: HIBERNATEIDLE
      AcDc: AC
      Value: 0