Set-CMCollectionPowerManagement
Configures power management settings for a device collection.
Syntax
Set-CMCollectionPowerManagement
[-Apply]
-InputObject <IResultObject>
[-NonPeakPlan <PowerSchema>]
[-PassThru]
[-PeakEndTime <DateTime>]
[-PeakPlan <PowerSchema>]
[-PeakStartTime <DateTime>]
[-WakeupTime <DateTime>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
[-Apply]
-CollectionName <String>
[-NonPeakPlan <PowerSchema>]
[-PassThru]
[-PeakEndTime <DateTime>]
[-PeakPlan <PowerSchema>]
[-PeakStartTime <DateTime>]
[-WakeupTime <DateTime>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
[-Apply]
-CollectionId <String>
[-NonPeakPlan <PowerSchema>]
[-PassThru]
[-PeakEndTime <DateTime>]
[-PeakPlan <PowerSchema>]
[-PeakStartTime <DateTime>]
[-WakeupTime <DateTime>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
-CollectionId <String>
[-None]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
-CollectionId <String>
[-NeverApply]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
-CollectionName <String>
[-None]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
-CollectionName <String>
[-NeverApply]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMCollectionPowerManagement
-InputObject <IResultObject>
[-None]
[-PassThru]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 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 -PassThruThis 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:00amThis 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionId
Specifies the collection ID of the device collection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionName
Specifies the name of the device collection.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies a device collection object. To obtain a device collection object, use the Get-CMCollection or the Get-CMDeviceCollection cmdlets.
| Type: | IResultObject |
| Aliases: | Collection, CollectionSettings |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-NeverApply
Indicates that power management settings will never be applied to computers in the specified collection.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-None
Indicates that no power management settings are set for the specified collection.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | PowerSchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PeakEndTime
Specifies the end time for peak hours.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | PowerSchema |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PeakStartTime
Specifies the start time for peak hours.
| Type: | DateTime |
| Aliases: | PeakStartHour |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WakeupTime
Specifies a time when the Windows timer wakes a desktop computer from sleep or hibernate to install scheduled updates or software installations.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for