Set-CMSoftwareUpdateDeployment

Modifies a software update deployment in Configuration Manager.

Syntax

Set-CMSoftwareUpdateDeployment
   [-AlertDay <DateTime>]
   [-AlertTime <DateTime>]
   [-AllowRestart <Boolean>]
   [-AllowUseMeteredNetwork <Boolean>]
   [-CollectionName <String>]
   [-Confirm]
   [-DeploymentAvailableDay <DateTime>]
   [-DeploymentAvailableTime <DateTime>]
   [-DeploymentExpireDay <DateTime>]
   [-DeploymentExpireTime <DateTime>]
   -DeploymentName <String>
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-Enable <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   [-NewDeploymentName <String>]
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   -SoftwareUpdate <IResultObject>
   [-TimeBasedOn <TimeType>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]
Set-CMSoftwareUpdateDeployment [-AlertDay ] [-AlertTime ] [-AllowRestart ]
 [-AllowUseMeteredNetwork ] [-CollectionName ] [-Confirm] [-DeploymentAvailableDay ]
 [-DeploymentAvailableTime ] [-DeploymentExpireDay ] [-DeploymentExpireTime ]
 -DeploymentName  [-DeploymentType ] [-Description ]
 [-DisableOperationsManagerAlert ] [-DisableWildcardHandling] [-DownloadFromMicrosoftUpdate ]
 [-Enable ] [-ForceWildcardHandling] [-GenerateOperationsManagerAlert ]
 [-GenerateSuccessAlert ] [-NewDeploymentName ] [-PercentSuccess ]
 [-PersistOnWriteFilterDevice ] [-ProtectedType ] [-RestartServer ]
 [-RestartWorkstation ] [-SendWakeupPacket ] [-SoftwareInstallation ]
 -SoftwareUpdateGroup  [-TimeBasedOn ] [-UnprotectedType ]
 [-UseBranchCache ] [-UserNotification ] [-VerbosityLevel ]
 [-WhatIf] []
Set-CMSoftwareUpdateDeployment [-AlertDay ] [-AlertTime ] [-AllowRestart ]
 [-AllowUseMeteredNetwork ] [-CollectionName ] [-Confirm] [-DeploymentAvailableDay ]
 [-DeploymentAvailableTime ] [-DeploymentExpireDay ] [-DeploymentExpireTime ]
 -DeploymentName  [-DeploymentType ] [-Description ]
 [-DisableOperationsManagerAlert ] [-DisableWildcardHandling] [-DownloadFromMicrosoftUpdate ]
 [-Enable ] [-ForceWildcardHandling] [-GenerateOperationsManagerAlert ]
 [-GenerateSuccessAlert ] [-NewDeploymentName ] [-PercentSuccess ]
 [-PersistOnWriteFilterDevice ] [-ProtectedType ] [-RestartServer ]
 [-RestartWorkstation ] [-SendWakeupPacket ] [-SoftwareInstallation ]
 -SoftwareUpdateGroupId  [-TimeBasedOn ] [-UnprotectedType ]
 [-UseBranchCache ] [-UserNotification ] [-VerbosityLevel ]
 [-WhatIf] []
Set-CMSoftwareUpdateDeployment [-AlertDay ] [-AlertTime ] [-AllowRestart ]
 [-AllowUseMeteredNetwork ] [-CollectionName ] [-Confirm] [-DeploymentAvailableDay ]
 [-DeploymentAvailableTime ] [-DeploymentExpireDay ] [-DeploymentExpireTime ]
 -DeploymentName  [-DeploymentType ] [-Description ]
 [-DisableOperationsManagerAlert ] [-DisableWildcardHandling] [-DownloadFromMicrosoftUpdate ]
 [-Enable ] [-ForceWildcardHandling] [-GenerateOperationsManagerAlert ]
 [-GenerateSuccessAlert ] [-NewDeploymentName ] [-PercentSuccess ]
 [-PersistOnWriteFilterDevice ] [-ProtectedType ] [-RestartServer ]
 [-RestartWorkstation ] [-SendWakeupPacket ] [-SoftwareInstallation ]
 -SoftwareUpdateGroupName  [-TimeBasedOn ] [-UnprotectedType ]
 [-UseBranchCache ] [-UserNotification ] [-VerbosityLevel ]
 [-WhatIf] []
Set-CMSoftwareUpdateDeployment [-AlertDay ] [-AlertTime ] [-AllowRestart ]
 [-AllowUseMeteredNetwork ] [-CollectionName ] [-Confirm] [-DeploymentAvailableDay ]
 [-DeploymentAvailableTime ] [-DeploymentExpireDay ] [-DeploymentExpireTime ]
 -DeploymentName  [-DeploymentType ] [-Description ]
 [-DisableOperationsManagerAlert ] [-DisableWildcardHandling] [-DownloadFromMicrosoftUpdate ]
 [-Enable ] [-ForceWildcardHandling] [-GenerateOperationsManagerAlert ]
 [-GenerateSuccessAlert ] [-NewDeploymentName ] [-PercentSuccess ]
 [-PersistOnWriteFilterDevice ] [-ProtectedType ] [-RestartServer ]
 [-RestartWorkstation ] [-SendWakeupPacket ] [-SoftwareInstallation ]
 -SoftwareUpdateId  [-TimeBasedOn ] [-UnprotectedType ]
 [-UseBranchCache ] [-UserNotification ] [-VerbosityLevel ]
 [-WhatIf] []
Set-CMSoftwareUpdateDeployment [-AlertDay ] [-AlertTime ] [-AllowRestart ]
 [-AllowUseMeteredNetwork ] [-CollectionName ] [-Confirm] [-DeploymentAvailableDay ]
 [-DeploymentAvailableTime ] [-DeploymentExpireDay ] [-DeploymentExpireTime ]
 -DeploymentName  [-DeploymentType ] [-Description ]
 [-DisableOperationsManagerAlert ] [-DisableWildcardHandling] [-DownloadFromMicrosoftUpdate ]
 [-Enable ] [-ForceWildcardHandling] [-GenerateOperationsManagerAlert ]
 [-GenerateSuccessAlert ] [-NewDeploymentName ] [-PercentSuccess ]
 [-PersistOnWriteFilterDevice ] [-ProtectedType ] [-RestartServer ]
 [-RestartWorkstation ] [-SendWakeupPacket ] [-SoftwareInstallation ]
 -SoftwareUpdateName  [-TimeBasedOn ] [-UnprotectedType ]
 [-UseBranchCache ] [-UserNotification ] [-VerbosityLevel ]
 [-WhatIf] []

Description

The Set-CMSoftwareUpdateDeployment cmdlet modifies a deployment of software updates in Microsoft System Center Configuration Manager.

Examples

Example 1: Set a deployment with expiration time

PS C:\> Set-CMSoftwareUpdateDeployment -SoftwareUpdateName "CT" -DeploymentName "Contoso-test1" -NewDeploymentName "Contoso-test5" -Description "Contoso-test5-deployment" -CollectionName "All Mobile Devices" -SendWakeUpPacket $False -VerbosityLevel OnlySuccessAndErrorMessages -TimeBasedOn LocalTime -DeploymentAvailableDay 2013/11/24 -DeploymentAvailableTime 13:26 -DeploymentExpireDay 2014/7/22 -DeploymentExpireTime 4:30 -UserNotification DisplayAll -SoftwareInstallation $False -AllowRestart $False -RestartServer $False -RestartWorkstation $False -PersistOnWriteFilterDevice $True -GenerateSuccessAlert $False -PercentSuccess 99  -DisableOperationsManagerAlert $False -GenerateOperationsManagerAlert $False -ProtectedType NoInstall -UnprotectedType UnprotectedDistributionPoint -UseBranchCache $True -DownloadFromMicrosoftUpdate $False -AllowUseMeteredNetwork $False

This command sets a software update deployment by using a software update name and expiration time.

Example 2: Start a deployment without expiration time

PS C:\> Set-CMSoftwareUpdateDeployment -SoftwareUpdateName "CT" -DeploymentName "Contoso-test2" -NewDeploymentName "Contoso-test6" -Description "Contoso-test6-deployment" -CollectionName "All Mobile Devices" -VerbosityLevel OnlyErrorMessages -TimeBasedOn LocalTime -DeploymentAvailableDay 2013/12/24 -DeploymentAvailableTime 3:56 -UserNotification DisplaySoftwareCenterOnly -PersistOnWriteFilterDevice $True -DisableOperationsManagerAlert $False -GenerateOperationsManagerAlert $False -ProtectedType NoInstall -UnprotectedType UnprotectedDistributionPoint -UseBranchCache $True -DownloadFromMicrosoftUpdate $False -AllowUseMeteredNetwork $False

This command sets a software update deployment by using a software update name but no specified expiration time.

Example 3: Start a deployment by software update group name and expiration time

PS C:\> Set-CMSoftwareUpdateDeployment -SoftwareUpdateGroupName "CTG" -DeploymentName "Contoso-test3" -NewDeploymentName "Contoso-test7" -Description "Contoso-test7-deployment" -CollectionName "All Mobile Devices" -SendWakeUpPacket $False -VerbosityLevel OnlySuccessAndErrorMessages -TimeBasedOn LocalTime -DeploymentAvailableDay 2013/11/24 -DeploymentAvailableTime 13:26 -DeploymentExpireDay 2014/7/22 -DeploymentExpireTime 4:30 -UserNotification DisplayAll -SoftwareInstallation $False -AllowRestart $False -RestartServer $False -RestartWorkstation $False -PersistOnWriteFilterDevice $True -GenerateSuccessAlert $False -PercentSuccess 99  -DisableOperationsManagerAlert $False -GenerateOperationsManagerAlert $False -ProtectedType NoInstall -UnprotectedType UnprotectedDistributionPoint -UseBranchCache $True -DownloadFromMicrosoftUpdate $False -AllowUseMeteredNetwork $False

This command sets a software update deployment by using a software update group name and an expiration time.

Example 4: Start a deployment by software update group name

PS C:\> Set-CMSoftwareUpdateDeployment -SoftwareUpdateGroupName "CTG" -DeploymentName "Contoso-test4" -NewDeploymentName "Contoso-test8" -Description "Contoso-test8-deployment" -CollectionName "All Mobile Devices" -VerbosityLevel OnlyErrorMessages -TimeBasedOn LocalTime -DeploymentAvailableDay 2013/12/24 -DeploymentAvailableTime 3:56 -UserNotification DisplaySoftwareCenterOnly -PersistOnWriteFilterDevice $True -DisableOperationsManagerAlert $False -GenerateOperationsManagerAlert $False -ProtectedType NoInstall -UnprotectedType UnprotectedDistributionPoint -UseBranchCache $True -DownloadFromMicrosoftUpdate $False -AllowUseMeteredNetwork $False

This command starts a software update deployment by using a software update group name but no specified expiration time.

Required Parameters

-DeploymentName

Specifies a name for a software update deployment in Configuration Manager.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareUpdate

Specifies a software update deployment object. To obtain a software update deployment object, use the Get-CMSoftwareUpdate cmdlet.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-SoftwareUpdateGroup

Specifies a software update group object. To obtain a software update group object, use the Get-CMSoftwareUpdateGroup cmdlet.

Type:IResultObject
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareUpdateGroupId

Specifies an ID for a software update group. A software update group contains individual software updates.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareUpdateGroupName

Specifies a name for a software update group.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareUpdateId

Specifies an ID for a software update in Configuration Manager.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareUpdateName

Specifies a name for a software update in Configuration Manager.

Type:String
Required:True
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AlertDay

Specifies a day, in MM/DD/YYYY format, to notify clients of new software updates.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AlertTime

Specifies a time, in HH:MM format, to notify clients of new software updates.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowRestart

Indicates whether to allow a restart following installation.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowUseMeteredNetwork

Indicates whether to allow clients to use a metered network to download updates.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CollectionName

Specifies a name of a collection in Configuration Manager. A collection is a group of client computers.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentAvailableDay

Specifies a day, in MM/DD/YYYY format, when a software update becomes available to clients. By default, the update is available immediately.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentAvailableTime

Specifies a time, in HH:MM format, when a software update becomes available to clients. By default, the update is available immediately.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentExpireDay

Specifies a day, in MM/DD/YYYY format, when a software update expires. To expire a software update on a certain day, set this parameter.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentExpireTime

Specifies a time, in HH:MM format, when a software update expires. To expire a software update at a certain time, set this parameter.

Type:DateTime
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentType

Specifies a deployment type in Configuration Manager.

Type:DeploymentType
Parameter Sets:Required, Available
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for a software update deployment.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableOperationsManagerAlert

Indicates whether to disable System Center 2016 - Operations Manager alerts during software updates.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

Indicates that wildcard handling is disabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DownloadFromMicrosoftUpdate

Indicates whether clients download updates directly from Microsoft Update.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Enable

Indicates whether the cmdlet enables software updates in Configuration Manager.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

Indicates that wildcard handling is enabled.

Type:SwitchParameter
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GenerateOperationsManagerAlert

Indicates whether to generate Operations Manager alerts when a software installation fails.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-GenerateSuccessAlert

Indicates whether to generate alerts when a software installation succeeds.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-NewDeploymentName

Specifies a name for a new deployment in Configuration Manager.

Type:String
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PercentSuccess

Specifies a percentage of the update.

Type:Int32
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PersistOnWriteFilterDevice

Indicates whether to install a software update on the temporary overlay and commit changes later, or commit the changes at an installation deadline or a maintenance window.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProtectedType

Specifies a protected type.

Type:ProtectedType
Parameter Sets:NoInstall, RemoteDistributionPoint
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RestartServer

Indicates whether to allow a server to restart following a software update.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RestartWorkstation

Indicates whether to allow a workstation to restart following a software update.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SendWakeupPacket

Indicates whether to send a wake up packet to computers before the deployment begins. If this value is $True, Configuration Manager wakes a computer from sleep. If this value is $False, it does not wake computers from sleep. For computers to wake, you must first configure Wake On LAN.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareInstallation

Indicates whether to allow the software update to install, even if the installation occurs outside of a maintenance window.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeBasedOn

Specifies that client computers use either local or UTC time to determine the availability of a program. UTC time makes the software update available at the same time for all computers.

Type:TimeType
Parameter Sets:LocalTime, Utc
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UnprotectedType

Specifies an unprotected type.

Type:UnprotectedType
Parameter Sets:NoInstall, UnprotectedDistributionPoint
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UseBranchCache

Indicates whether to use Branch Cache as a distribution point for updates.

Type:Boolean
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-UserNotification

Specifies a user notification type.

Type:UserNotificationType
Parameter Sets:DisplayAll, DisplaySoftwareCenterOnly, HideAll
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VerbosityLevel

Specifies a verbosity level type, such as error messages. The acceptable values for this parameter are:- AllMessages

  • OnlyErrorMessages
  • OnlySuccessandErrorMessages
Type:VerbosityLevelType
Parameter Sets:AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages
Required:False
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Required:False
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False