Set-CMMaintenanceWindow
Set-CMMaintenanceWindow
Modifies a maintenance window.
Syntax
Parameter Set: ByScheduleMandatory
Set-CMMaintenanceWindow [-CollectionID] <String> -Name <String> [-Schedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: ByScheduleWindowMandatory
Set-CMMaintenanceWindow [-CollectionID] <String> -ScheduleWindow <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SoftwareUpdateOnly
Set-CMMaintenanceWindow [-CollectionID] <String> -ApplyToSoftwareUpdateOnly -Name <String> [-Schedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: TaskSequenceOnly
Set-CMMaintenanceWindow [-CollectionID] <String> -ApplyToTaskSequenceOnly -Name <String> [-Schedule <IResultObject> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMMaintenanceWindow cmdlet modifies a maintenance window associated with a collection. Maintenance windows are periods of time reserved for write operations such as applying software updates, installing software, or configuring computer settings.
Parameters
-ApplyToSoftwareUpdateOnly
Indicates that the maintenance window is used to apply software updates only.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ApplyToTaskSequenceOnly
Indicates that the maintenance window is used to apply task sequences only.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-CollectionID<String>
Specifies the ID of the collection that the maintenance window applies to.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the maintenance window.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-Schedule<IResultObject>
Specifies a CMSchedule object. The schedule specifies when the maintenance window occurs. To create a CMSchedule object, use the New-CMSchedule cmdlet.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-ScheduleWindow<IResultObject>
Specifies a maintenance window object. To get a maintenance window object, use the Get-CMMaintenanceWindow cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Confirm
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Modify a maintenance window
This command modifies the maintenance window named DiskCleanup, a window associated with the collection AAA0004D. In this example, the maintenance window is configured to apply only to task sequences.
PS C:\> Set-CMMaintenanceWindow -Name "DiskCleanup"-CollectionID "AAA0004D" -ApplyToTaskSequenceOnly