Edit

Share via

New-CMPowerManagementCustomPlan

Module:
ConfigurationManager Module

Creates a custom power management plan.

Syntax

Peak (Default) 

New-CMPowerManagementCustomPlan
    [-AllowHybridSleepAC <Boolean>]
    [-AllowHybridSleepDC <Boolean>]
    [-AllowStandbyAC <Boolean>]
    [-AllowStandbyDC <Boolean>]
    [-CriticalBatteryAC <PowerSettingAction>]
    [-CriticalBatteryDC <PowerSettingAction>]
    [-Description <String>]
    [-DisplayOffMinAC <Int32>]
    [-DisplayOffMinDC <Int32>]
    [-HardDiskIdleMinAC <Int32>]
    [-HardDiskIdleMinDC <Int32>]
    [-HibernateMinAC <Int32>]
    [-HibernateMinDC <Int32>]
    [-LidDownAC <PowerSettingAction>]
    [-LidDownDC <PowerSettingAction>]
    [-LowBatteryAC <PowerSettingAction>]
    [-LowBatteryDC <PowerSettingAction>]
    [-Name <String>]
    [-NoAllowStandby]
    [-NoCriticalBattery]
    [-NoDisplayOff]
    [-NoHardDiskIdle]
    [-NoHibernate]
    [-NoHybridSleep]
    [-NoLidDown]
    [-NoLowBattery]
    [-NoPowerButton]
    [-NoRequirePasswordOnWake]
    [-NoSleep]
    [-NoSleepButton]
    [-NoSleepIdle]
    [-NoStartButton]
    [-NoWakeOnTimer]
    [-Peak]
    [-PowerButtonAC <PowerSettingAction>]
    [-PowerButtonDC <PowerSettingAction>]
    [-RequirePasswordOnWakeAC <Boolean>]
    [-RequirePasswordOnWakeDC <Boolean>]
    [-SleepButtonAC <PowerSettingAction>]
    [-SleepButtonDC <PowerSettingAction>]
    [-SleepIdlePctAC <Int32>]
    [-SleepIdlePctDC <Int32>]
    [-SleepMinAC <Int32>]
    [-SleepMinDC <Int32>]
    [-StartButtonAC <PowerSettingAction>]
    [-StartButtonDC <PowerSettingAction>]
    [-WakeOnTimerAC <Boolean>]
    [-WakeOnTimerDC <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

NonPeak 

New-CMPowerManagementCustomPlan
    [-AllowHybridSleepAC <Boolean>]
    [-AllowHybridSleepDC <Boolean>]
    [-AllowStandbyAC <Boolean>]
    [-AllowStandbyDC <Boolean>]
    [-CriticalBatteryAC <PowerSettingAction>]
    [-CriticalBatteryDC <PowerSettingAction>]
    [-Description <String>]
    [-DisplayOffMinAC <Int32>]
    [-DisplayOffMinDC <Int32>]
    [-HardDiskIdleMinAC <Int32>]
    [-HardDiskIdleMinDC <Int32>]
    [-HibernateMinAC <Int32>]
    [-HibernateMinDC <Int32>]
    [-LidDownAC <PowerSettingAction>]
    [-LidDownDC <PowerSettingAction>]
    [-LowBatteryAC <PowerSettingAction>]
    [-LowBatteryDC <PowerSettingAction>]
    [-Name <String>]
    [-NoAllowStandby]
    [-NoCriticalBattery]
    [-NoDisplayOff]
    [-NoHardDiskIdle]
    [-NoHibernate]
    [-NoHybridSleep]
    [-NoLidDown]
    [-NoLowBattery]
    [-NonPeak]
    [-NoPowerButton]
    [-NoRequirePasswordOnWake]
    [-NoSleep]
    [-NoSleepButton]
    [-NoSleepIdle]
    [-NoStartButton]
    [-NoWakeOnTimer]
    [-PowerButtonAC <PowerSettingAction>]
    [-PowerButtonDC <PowerSettingAction>]
    [-RequirePasswordOnWakeAC <Boolean>]
    [-RequirePasswordOnWakeDC <Boolean>]
    [-SleepButtonAC <PowerSettingAction>]
    [-SleepButtonDC <PowerSettingAction>]
    [-SleepIdlePctAC <Int32>]
    [-SleepIdlePctDC <Int32>]
    [-SleepMinAC <Int32>]
    [-SleepMinDC <Int32>]
    [-StartButtonAC <PowerSettingAction>]
    [-StartButtonDC <PowerSettingAction>]
    [-WakeOnTimerAC <Boolean>]
    [-WakeOnTimerDC <Boolean>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [<CommonParameters>]

Description

The New-CMPowerManagementCustomPlan cmdlet creates a custom power management plan.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Create parameters for a custom power management plan and store them in a variable

PS XYZ:\>$PlanParams = @{
    Name = "test"
    Description = "comments"
    DisplayOffMinAC = 20
    DisplayOffMinDC = 20
    SleepMinAC = 65
    SleepMinDC = 20
    RequirePasswordOnWakeAC = $true
    RequirePasswordOnWakeDC = $false
    PowerButtonAC = "None"
    PowerButtonDC = "Sleep"
    StartButtonAC = "Hibernate"
    StartButtonDC = "Sleep"
    SleepButtonAC= "None"
    SleepButtonDC = "Sleep"
    LidDownAC = "None"
    LidDownDC = "Sleep"
    HardDiskIdleMinAC = 25
    HardDiskIdleMinDC = 10
    HibernateMinAC = 10
    HibernateMinDC = 5
    LowBatteryAC = "None"
    LowBatteryDC = "Sleep"
    CriticalBatteryAC = "None"
    CriticalBatteryDC = "ShutDown"
    AllowHybridSleepAC = $false
    AllowHybridSleepDC = $true
    AllowStandbyAC= $false
    AllowStandbyDC = $true
    SleepIdlePctDC = 10
    SleepIdlePctAC = 15
    WakeOnTimerAC = $true
    WakeOnTimerDC = $false
}

This command creates an array of parameters and their settings for a custom power management plan, and then stores the array in the $PlanParams variable. This variable can now be used to create a custom plan.

Example 2: Create a custom peak power management plan to configure a device collection

PS XYZ:\> $PeakPlan = New-CMPowerManagementCustomPlan -Peak @planParams
PS XYZ:\> Set-CMCollectionPowerManagement -CollectionName "deviceCol1" -PeakPlan $PeakPlan

The first command uses the parameters set in Example 1 to create a custom peak power management plan object, which it then stores in the $PeakPlan variable.

The second command uses the custom plan stored in $PeakPlan to configure the power management settings for the device collection named deviceCol01.

Example 3: Create a custom non-peak power management plan to configure a device collection

PS XYZ:\> $NonPeakPlan = New-CMPowerManagementCustomPlan -NonPeak @planParams
PS XYZ:\> Set-CMCollectionPowerManagement -CollectionName "deviceCol2" -NonPeakPlan $NonPeakPlan

The first command uses the parameters set in Example 1 to create a custom non-peak power management plan object, which it then stores in the $NonPeakPlan variable.

The second command uses the custom plan stored in $NonPeakPlan to configure the power management settings for the device collection named deviceCol02.

Parameters

-AllowHybridSleepAC

Indicates whether Windows saves a hibernation file when entering sleep when the device is plugged in. A hibernation file can be used to restore the computer's state in the event of power loss while it has entered sleep.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowHybridSleepDC

Indicates whether Windows saves a hibernation file when entering sleep when the device is running on battery power. A hibernation file can be used to restore the computer's state in the event of power loss while it has entered sleep.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowStandbyAC

Indicates whether to allow the computer to be on standby when the device is plugged in. This still consumes some power, but enables the computer to wake faster.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowStandbyDC

Indicates whether to allow the computer to be on standby when the device running on battery power. This still consumes some power, but enables the computer to wake faster.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CriticalBatteryAC

Specifies the action to take when the computer's battery reaches the specified critical battery notification when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-CriticalBatteryDC

Specifies the action to take when the computer's battery reaches the specified critical battery notification when the device is running on batter power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for the power management plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayOffMinAC

Specifies the length of time, in minutes, that the computer must be inactive before the display is turned off when the device is plugged in.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisplayOffMinDC

Specifies the length of time, in minutes, that the computer must be inactive before the display is turned off when the device running on battery power.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HardDiskIdleMinAC

Specifies the length of time, in minutes, that the computer's hard disk must be inactive before it is turned off when the device is plugged in.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HardDiskIdleMinDC

Specifies the length of time, in minutes, that the computer's hard disk must be inactive before it is turned off when the device is running on battery power.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HibernateMinAC

Specifies the length of time, in minutes, that the computer must be inactive before it enters hibernate when the device is plugged in.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HibernateMinDC

Specifies the length of time, in minutes, that the computer must be inactive before it enters hibernate when the device is running on battery power.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LidDownAC

Specifies the action that occurs when the user closes the lid of a portable computer when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LidDownDC

Specifies the action that occurs when the user closes the lid of a portable computer when the device is running on battery power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LowBatteryAC

Specifies the action that occurs when the computer's battery reaches the specified low battery notification level when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-LowBatteryDC

Specifies the action that occurs when the computer's battery reaches the specified low battery notification level when the device is running on battery power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Specifies a name for the power management plan.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoAllowStandby

Indicates that the "Allow standby state when sleeping action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoCriticalBattery

Indicates that the "Critical battery action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoDisplayOff

Indicates that the "Turn off display after (minutes)" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoHardDiskIdle

Indicates that the "Turn off hard disk after (minutes)" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoHibernate

Indicates that the "Hibernate after (minutes)" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoHybridSleep

Indicates that the "Allow hybrid sleep" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoLidDown

Indicates that the "Lid close action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoLowBattery

Indicates that the "Low battery action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NonPeak

Indicates that this is a non-peak plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

NonPeak
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoPowerButton

Indicates that the "Power button action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoRequirePasswordOnWake

Indicates that the "Require a password on wakeup" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoSleep

Indicates that the "Sleep after (minutes)" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoSleepButton

Indicates that the "Sleep button action" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoSleepIdle

Indicates that the "Required idleness to sleep (%)" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoStartButton

Indicates that the "Start menu power button" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NoWakeOnTimer

Indicates that the "Enable Windows wake up timer for desktop computers" property is not included in this power management plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Peak

Indicates that this is a peak plan.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

Peak
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PowerButtonAC

Specifies the action that is taken when the computer's power button is pressed when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PowerButtonDC

Specifies the action that is taken when the computer's power button is pressed when the device is running on battery power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequirePasswordOnWakeAC

Indicates whether a password is required to unlock the computer when it enters wake from sleep when the device is plugged in.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RequirePasswordOnWakeDC

Indicates whether a password is required to unlock the computer when it enters wake from sleep when the device is running on battery power.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepButtonAC

Specifies the action that occurs when you press the computer's Sleep button when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepButtonDC

Specifies the action that occurs when you press the computer's Sleep button when the device is running on battery power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:None, Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepIdlePctAC

Specifies the percentage of idle time on the computer processor time required for the computer to enter sleep when the device is plugged in.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepIdlePctDC

Specifies the percentage of idle time on the computer processor time required for the computer to enter sleep when the device is running on battery power.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepMinAC

Specifies the length of time, in minutes, that the computer must be in active before it enters sleep when the device is plugged in.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SleepMinDC

Specifies the length of time, in minutes, that the computer must be in active before it enters sleep when the device is running on battery power.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartButtonAC

Specifies the action that occurs when you press the computer's Start menu power button when the device is plugged in. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StartButtonDC

Specifies the action that occurs when you press the computer's Start menu power button when the device is running on battery power. Valid values are:

  • None
  • Sleep
  • Hibernate
  • Shutdown

Parameter properties

Type:PowerSettingAction
Default value:None
Accepted values:Sleep, Hibernate, Shutdown
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WakeOnTimerAC

Indicates whether the build-in Windows timer is enabled when the device is plugged in. Power management can use the Windows timer to wake a desktop computer. When a desktop computer is woken by using the Windows wake up timer, it will remain awake for 10 minutes by default to allow time for the computer to install any updates or to receive policy.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WakeOnTimerDC

Indicates whether the build-in Windows timer is enabled when the device is running on battery power. Power management can use the Windows timer to wake a desktop computer. When a desktop computer is woken by using the Windows wake up timer, it will remain awake for 10 minutes by default to allow time for the computer to install any updates or to receive policy.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

Outputs

Microsoft.ConfigurationManagement.AdminConsole.CollectionProperty.PowerSchema