Start-CMSoftwareUpdateDeployment

Initiates a software update deployment in Configuration Manager.

Syntax

Start-CMSoftwareUpdateDeployment
     -InputObject <IResultObject>
     -CollectionName <String>
     [-DeploymentName <String>]
     [-Description <String>]
     [-DeploymentType <DeploymentType>]
     [-SendWakeupPacket <Boolean>]
     [-VerbosityLevel <VerbosityLevelType>]
     [-TimeBasedOn <TimeType>]
     [-DeploymentAvailableDay <DateTime>]
     [-DeploymentAvailableTime <DateTime>]
     [-EnforcementDeadlineDay <DateTime>]
     [-EnforcementDeadline <DateTime>]
     [-UserNotification <UserNotificationType>]
     [-SoftwareInstallation <Boolean>]
     [-AllowRestart <Boolean>]
     [-RestartServer <Boolean>]
     [-RestartWorkstation <Boolean>]
     [-PersistOnWriteFilterDevice <Boolean>]
     [-GenerateSuccessAlert <Boolean>]
     [-PercentSuccess <Int32>]
     [-TimeValue <Int32>]
     [-TimeUnit <TimeUnitType>]
     [-DisableOperationsManagerAlert <Boolean>]
     [-GenerateOperationsManagerAlert <Boolean>]
     [-ProtectedType <ProtectedType>]
     [-UnprotectedType <UnprotectedType>]
     [-UseBranchCache <Boolean>]
     [-DownloadFromMicrosoftUpdate <Boolean>]
     [-AllowUseMeteredNetwork <Boolean>]
     [-AcceptEula]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMSoftwareUpdateDeployment
     -SoftwareUpdateGroupId <String>
     -CollectionName <String>
     [-DeploymentName <String>]
     [-Description <String>]
     [-DeploymentType <DeploymentType>]
     [-SendWakeupPacket <Boolean>]
     [-VerbosityLevel <VerbosityLevelType>]
     [-TimeBasedOn <TimeType>]
     [-DeploymentAvailableDay <DateTime>]
     [-DeploymentAvailableTime <DateTime>]
     [-EnforcementDeadlineDay <DateTime>]
     [-EnforcementDeadline <DateTime>]
     [-UserNotification <UserNotificationType>]
     [-SoftwareInstallation <Boolean>]
     [-AllowRestart <Boolean>]
     [-RestartServer <Boolean>]
     [-RestartWorkstation <Boolean>]
     [-PersistOnWriteFilterDevice <Boolean>]
     [-GenerateSuccessAlert <Boolean>]
     [-PercentSuccess <Int32>]
     [-TimeValue <Int32>]
     [-TimeUnit <TimeUnitType>]
     [-DisableOperationsManagerAlert <Boolean>]
     [-GenerateOperationsManagerAlert <Boolean>]
     [-ProtectedType <ProtectedType>]
     [-UnprotectedType <UnprotectedType>]
     [-UseBranchCache <Boolean>]
     [-DownloadFromMicrosoftUpdate <Boolean>]
     [-AllowUseMeteredNetwork <Boolean>]
     [-AcceptEula]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMSoftwareUpdateDeployment
     -SoftwareUpdateGroupName <String>
     -CollectionName <String>
     [-DeploymentName <String>]
     [-Description <String>]
     [-DeploymentType <DeploymentType>]
     [-SendWakeupPacket <Boolean>]
     [-VerbosityLevel <VerbosityLevelType>]
     [-TimeBasedOn <TimeType>]
     [-DeploymentAvailableDay <DateTime>]
     [-DeploymentAvailableTime <DateTime>]
     [-EnforcementDeadlineDay <DateTime>]
     [-EnforcementDeadline <DateTime>]
     [-UserNotification <UserNotificationType>]
     [-SoftwareInstallation <Boolean>]
     [-AllowRestart <Boolean>]
     [-RestartServer <Boolean>]
     [-RestartWorkstation <Boolean>]
     [-PersistOnWriteFilterDevice <Boolean>]
     [-GenerateSuccessAlert <Boolean>]
     [-PercentSuccess <Int32>]
     [-TimeValue <Int32>]
     [-TimeUnit <TimeUnitType>]
     [-DisableOperationsManagerAlert <Boolean>]
     [-GenerateOperationsManagerAlert <Boolean>]
     [-ProtectedType <ProtectedType>]
     [-UnprotectedType <UnprotectedType>]
     [-UseBranchCache <Boolean>]
     [-DownloadFromMicrosoftUpdate <Boolean>]
     [-AllowUseMeteredNetwork <Boolean>]
     [-AcceptEula]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMSoftwareUpdateDeployment
     -SoftwareUpdateId <String>
     -CollectionName <String>
     [-DeploymentName <String>]
     [-Description <String>]
     [-DeploymentType <DeploymentType>]
     [-SendWakeupPacket <Boolean>]
     [-VerbosityLevel <VerbosityLevelType>]
     [-TimeBasedOn <TimeType>]
     [-DeploymentAvailableDay <DateTime>]
     [-DeploymentAvailableTime <DateTime>]
     [-EnforcementDeadlineDay <DateTime>]
     [-EnforcementDeadline <DateTime>]
     [-UserNotification <UserNotificationType>]
     [-SoftwareInstallation <Boolean>]
     [-AllowRestart <Boolean>]
     [-RestartServer <Boolean>]
     [-RestartWorkstation <Boolean>]
     [-PersistOnWriteFilterDevice <Boolean>]
     [-GenerateSuccessAlert <Boolean>]
     [-PercentSuccess <Int32>]
     [-TimeValue <Int32>]
     [-TimeUnit <TimeUnitType>]
     [-DisableOperationsManagerAlert <Boolean>]
     [-GenerateOperationsManagerAlert <Boolean>]
     [-ProtectedType <ProtectedType>]
     [-UnprotectedType <UnprotectedType>]
     [-UseBranchCache <Boolean>]
     [-DownloadFromMicrosoftUpdate <Boolean>]
     [-AllowUseMeteredNetwork <Boolean>]
     [-AcceptEula]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-CMSoftwareUpdateDeployment
     -SoftwareUpdateName <String>
     -CollectionName <String>
     [-DeploymentName <String>]
     [-Description <String>]
     [-DeploymentType <DeploymentType>]
     [-SendWakeupPacket <Boolean>]
     [-VerbosityLevel <VerbosityLevelType>]
     [-TimeBasedOn <TimeType>]
     [-DeploymentAvailableDay <DateTime>]
     [-DeploymentAvailableTime <DateTime>]
     [-EnforcementDeadlineDay <DateTime>]
     [-EnforcementDeadline <DateTime>]
     [-UserNotification <UserNotificationType>]
     [-SoftwareInstallation <Boolean>]
     [-AllowRestart <Boolean>]
     [-RestartServer <Boolean>]
     [-RestartWorkstation <Boolean>]
     [-PersistOnWriteFilterDevice <Boolean>]
     [-GenerateSuccessAlert <Boolean>]
     [-PercentSuccess <Int32>]
     [-TimeValue <Int32>]
     [-TimeUnit <TimeUnitType>]
     [-DisableOperationsManagerAlert <Boolean>]
     [-GenerateOperationsManagerAlert <Boolean>]
     [-ProtectedType <ProtectedType>]
     [-UnprotectedType <UnprotectedType>]
     [-UseBranchCache <Boolean>]
     [-DownloadFromMicrosoftUpdate <Boolean>]
     [-AllowUseMeteredNetwork <Boolean>]
     [-AcceptEula]
     [-DisableWildcardHandling]
     [-ForceWildcardHandling]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

Description

The Start-CMSoftwareUpdateDeployment cmdlet initiates a software update deployment.

Examples

Example 1: Start a required deployment by software update name

PS C:\> Start-CMSoftwareUpdateDeployment -SoftwareUpdateName "CT" -CollectionName "All Systems" -DeploymentName "Contoso-test" -Description "Contoso-test-deployment" -DeploymentType Required -SendWakeUpPacket $True -VerbosityLevel AllMessages -TimeBasedOn UTC -DeploymentAvailableDay 2012/10/24 -DeploymentAvailableTime 23:56 -DeploymentExpireDay 2013/10/21 -DeploymentExpireTime 11:20 -UserNotification HideAll -SoftwareInstallation $True -AllowRestart $True -RestartServer $True -RestartWorkstation $True -PersistOnWriteFilterDevice $False -GenerateSuccessAlert $True -PercentSuccess 90 -TimeValue 10 -TimeUnit Days -DisableOperationsManagerAlert $True -GenerateOperationsManagerAlert $True -ProtectedType RemoteDistributionPoint -UnprotectedType NoInstall -UseBranchCache $False -DownloadFromMicrosoftUpdate $True -AllowUseMeteredNetwork $True

This command starts a required software update deployment by using a software update name.

Example 2: Start an available deployment by software update name

PS C:\> Start-CMSoftwareUpdateDeployment -SoftwareUpdateName "CT" -CollectionName "All Systems" -DeploymentName "Contoso-test2" -Description "Contoso-test2-deployment" -DeploymentType Available -VerbosityLevel AllMessages -TimeBasedOn UTC -DeploymentAvailableDay 2012/10/24 -DeploymentAvailableTime 23:56 -UserNotification DisplayAll -PersistOnWriteFilterDevice $False -DisableOperationsManagerAlert $True -GenerateOperationsManagerAlert $True -ProtectedType RemoteDistributionPoint -UnprotectedType NoInstall -UseBranchCache $False -DownloadFromMicrosoftUpdate $True -AllowUseMeteredNetwork $True

This command starts an available software update deployment by using a software update name.

Example 3: Start a required deployment by software update group name

PS C:\> Start-CMSoftwareUpdateDeployment -SoftwareUpdateGroupName "CTG" -CollectionName "All Systems" -DeploymentName "Contoso-test3" -Description "Contoso-test3-deployment" -DeploymentType Required -SendWakeUpPacket $True -VerbosityLevel AllMessages -TimeBasedOn UTC -DeploymentAvailableDay 2012/10/24 -DeploymentAvailableTime 23:56 -DeploymentExpireDay 2013/10/21 -DeploymentExpireTime 11:20 -UserNotification HideAll -SoftwareInstallation $True -AllowRestart $True -RestartServer $True -RestartWorkstation $True -PersistOnWriteFilterDevice $False -GenerateSuccessAlert $True -PercentSuccess 90 -TimeValue 10 -TimeUnit Days -DisableOperationsManagerAlert $True -GenerateOperationsManagerAlert $True -ProtectedType RemoteDistributionPoint -UnprotectedType NoInstall -UseBranchCache $False -DownloadFromMicrosoftUpdate $True -AllowUseMeteredNetwork $True

This command starts a software update deployment by using a collection name and an input object.

Example 4: Start a deployment by software update group name

PS C:\> Start-CMSoftwareUpdateDeployment -SoftwareUpdateGroupName "CTG" -CollectionName "All Systems" -DeploymentName "Contoso-test4" -Description "Contoso-test4-deployment" -DeploymentType Available -VerbosityLevel AllMessages -TimeBasedOn UTC -DeploymentAvailableDay 2012/10/24 -DeploymentAvailableTime 23:56 -UserNotification DisplayAll -PersistOnWriteFilterDevice $False -DisableOperationsManagerAlert $True -GenerateOperationsManagerAlert $True -ProtectedType RemoteDistributionPoint -UnprotectedType NoInstall -UseBranchCache $False -DownloadFromMicrosoftUpdate $True -AllowUseMeteredNetwork $True

This command starts a software update deployment by using a software update group name.

Required Parameters

-CollectionName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InputObject
Type:IResultObject
Aliases:SoftwareUpdate, SoftwareUpdateGroup
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-SoftwareUpdateGroupId

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

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

Specifies a name for a software update group.

Type:String
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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AcceptEula
Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowRestart

Indicates whether to allow a restart following installation.

Type:Boolean
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
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
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 deployment is available. By default, the update is available immediately.

Type:DateTime
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 deployment is available. By default, the update is available immediately.

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

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

Type:String
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Description

Specifies a description for a software update deployment.

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

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

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

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnforcementDeadline
Type:DateTime
Aliases:DeploymentExpireTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-EnforcementDeadlineDay
Type:DateTime
Aliases:DeploymentExpireDay
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PercentSuccess

Specifies a percent success.

Type:Int32
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ProtectedType

Specifies a protected type.

Type:ProtectedType
Parameter Sets:NoInstall, RemoteDistributionPoint
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. Setting this value to $True prevents the server from restarting. Setting this value to $False allows the server to restart.

Type:Boolean
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. Setting this value to $True prevents the computer from restarting. Setting this value to $False allows the computer to restart.

Type:Boolean
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
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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeUnit

Specifies the time unit in Configuration Manager. Valid values are:

  • Days
  • Hours
  • Months
  • Weeks
Type:TimeUnitType
Parameter Sets:Hours, Days, Weeks, Months
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TimeValue

Specifies a time value in the units specified in the TimeUnit parameter.

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

Specifies an unprotected type.

Type:UnprotectedType
Parameter Sets:NoInstall, UnprotectedDistributionPoint
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
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
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-VerbosityLevel

Specifies verbosity level. Valid values are:

  • AllMessages
  • OnlyErrorMessages
  • OnlySuccessAndErrorMessages
Type:VerbosityLevelType
Parameter Sets:AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages
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
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False