Set-CMCollectionPowerManagement

Module:

ConfigurationManager Module

Configures power management settings for a device collection.

Syntax

ByValueApply (Default)

Set-CMCollectionPowerManagement
    -InputObject <IResultObject>
    [-Apply]
    [-NonPeakPlan <PowerSchema>]
    [-PassThru]
    [-PeakEndTime <DateTime>]
    [-PeakPlan <PowerSchema>]
    [-PeakStartTime <DateTime>]
    [-WakeupTime <DateTime>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameApply

Set-CMCollectionPowerManagement
    -CollectionName <String>
    [-Apply]
    [-NonPeakPlan <PowerSchema>]
    [-PassThru]
    [-PeakEndTime <DateTime>]
    [-PeakPlan <PowerSchema>]
    [-PeakStartTime <DateTime>]
    [-WakeupTime <DateTime>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdApply

Set-CMCollectionPowerManagement
    -CollectionId <String>
    [-Apply]
    [-NonPeakPlan <PowerSchema>]
    [-PassThru]
    [-PeakEndTime <DateTime>]
    [-PeakPlan <PowerSchema>]
    [-PeakStartTime <DateTime>]
    [-WakeupTime <DateTime>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdNone

Set-CMCollectionPowerManagement
    -CollectionId <String>
    [-None]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdNever

Set-CMCollectionPowerManagement
    -CollectionId <String>
    [-NeverApply]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameNone

Set-CMCollectionPowerManagement
    -CollectionName <String>
    [-None]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameNever

Set-CMCollectionPowerManagement
    -CollectionName <String>
    [-NeverApply]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueNone

Set-CMCollectionPowerManagement
    -InputObject <IResultObject>
    [-None]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByValueNever

Set-CMCollectionPowerManagement
    -InputObject <IResultObject>
    [-NeverApply]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

The Set-CMCollectionPowerManagement cmdlet configures power management settings for a device collection.

Note

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

Examples

Example 1: Configure power management settings by using the pipeline

PS XYZ:\> Get-CMCollection -Name "DeviceCol1" | Set-CMCollectionPowerManagement -NeverApply -PassThru

This command gets the device collection object named DeviceCol1 and uses the pipeline operator to pass the object to Set-CMCollectionPowerManagement. Set-CMCollectionPowerManagagement configures deviceCol1 to never apply power management settings to the computers in that collection.

Example 2: Configure power management settings by name

PS XYZ:\> Set-CMCollectionPowerManagement -CollectionName "DeviceCol2" -Apply -PeakStartTime 8:00am -PeakEndTime 6:00pm -PeakPlan (Get-CMPowerManagementSchema -Peak -Name "Balanced (ConfigMgr)") -NonPeakPlan (Get-CMPowerManagementSchema -NonPeak -Name "Power Saver (ConfigMgr)") -WakeupTime 4:00am

This command specifies power management settings for the device collection DeviceCol2. During the peak hours of 8:00 AM to 6:00 PM, the peak power management plan named Balanced (ConfigMgr) is in effect. During non-peak hours, the non-peak power management plan named Power Saver (ConfigMgr) is in effect. The Windows timer is set to wake desktop computers install scheduled updates or software installations at 4:00 AM.

Parameters

-Apply

Indicates that power management settings can be set for a specified device collection.

Parameter properties

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

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-CollectionId

Specifies the collection ID of the device collection.

Parameter properties

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

Parameter sets

ByIdApply

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

ByIdNone

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

ByIdNever

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

-CollectionName

Specifies the name of the device collection.

Parameter properties

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

Parameter sets

ByNameApply

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

ByNameNone

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

ByNameNever

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	cf

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

-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

-InputObject

Specifies a device collection object. To obtain a device collection object, use the Get-CMCollection or the Get-CMDeviceCollection cmdlets.

Parameter properties

Type:	IResultObject
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	Collection, CollectionSettings

Parameter sets

ByValueApply

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

ByValueNone

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

ByValueNever

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

-NeverApply

Indicates that power management settings will never be applied to computers in the specified collection.

Parameter properties

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

Parameter sets

ByIdNever

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

ByNameNever

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

ByValueNever

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

-None

Indicates that no power management settings are set for the specified collection.

Parameter properties

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

Parameter sets

ByIdNone

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

ByNameNone

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

ByValueNone

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

-NonPeakPlan

Specifies a power management plan object for non-peak or non-business hours. To obtain a power plan object , use the Get-CMPowerManagementSchema cmdlet. To create a customized power plan, use New-CMPowerManagementCustomPlan cmdlet.

Parameter properties

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

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-PassThru

Add this parameter to return an object that represents the item with which you're working. By default, this cmdlet may not generate any output.

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

-PeakEndTime

Specifies the end time for peak hours.

Parameter properties

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

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-PeakPlan

Specifies a power management plan object for peak or business hours. To obtain a power plan object, use Get-CMPowerManagementSchema cmdlet. To create a customized power plan, use New-CMPowerManagementCustomPlan cmdlet.

Parameter properties

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

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-PeakStartTime

Specifies the start time for peak hours.

Parameter properties

Type:	DateTime
Default value:	None
Supports wildcards:	False
DontShow:	False
Aliases:	PeakStartHour

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-WakeupTime

Specifies a time when the Windows timer wakes a desktop computer from sleep or hibernate to install scheduled updates or software installations.

Parameter properties

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

Parameter sets

ByValueApply

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

ByNameApply

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

ByIdApply

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:	SwitchParameter
Default value:	False
Supports wildcards:	False
DontShow:	False
Aliases:	wi

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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• Get-CMCollection
• Get-CMDeviceCollection
• Get-CMPowerManagementSchema
• New-CMPowerManagementCustomPlan