Clear-CMOperatingSystemImageUpdateSchedule
Clear-CMOperatingSystemImageUpdateSchedule
Removes a schedule for updating an operating system image.
Syntax
Parameter Set: SearchByNameMandatory
Clear-CMOperatingSystemImageUpdateSchedule -OperatingSystemImageName <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByIdMandatory
Clear-CMOperatingSystemImageUpdateSchedule -OperatingSystemImageId <String[]> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Clear-CMOperatingSystemImageUpdateSchedule -OperatingSystemImage <IResultObject> [-Force] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Clear-CMOperatingSystemImageUpdateSchedule cmdlet removes a schedule for updating an operating system image from a Microsoft System Center 2012 Configuration Manager site.
Operating system images are .WIM format files, which represent a compressed collection of reference files and folders that System Center 2012 Configuration Manager requires to successfully install and configure an operating system on a computer. You can use System Center 2012 Configuration Manager to define a schedule for updating these images by using Component Based Servicing (CBS), then delete unwanted schedules by using this cmdlet.
Parameters
-Force
Forces the command to run without asking for user confirmation.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImage<IResultObject>
Specifies the update schedule to remove by using an update schedule object. To obtain an object for an update schedule, use the Get-CMOperatingSystemImageUpdateSchedule cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageId<String[]>
Specifies the update schedules to remove by using an array of IDs for update schedule objects.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-OperatingSystemImageName<String[]>
Specifies the update schedules to remove by using an array of names for update schedule objects.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
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: Remove a schedule for updating an operating system image by using a name
This command removes a schedule named Win8UpdateSchedule that updates an operating system image.
PS C:\> Clear-CMOperatingSystemUpdateSchedule -OperatingSystemImageName "Win8UpdateSchedule"
Example 2: Remove a schedule for updating an operating system image by using an object
This example removes an image update schedule by using an update schedule object.
The first command gets the image update schedule by using the ID 1207 and puts this schedule in the variable named $UpdateSchedObject.
The second command removes the image update schedule by using the object in the $UpdateSchedObject variable.
PS C:\> $Win8UpdateSchedule = Get-CMOperatingSystemUpdateSchedule -Id 1207
PS C:\> Clear-CMOperatingSystemUpdateSchedule -OperatingSystemImageName "Win8UpdateSchedule"