description | external help file | Module Name | ms.date | schema | title |
---|---|---|---|---|---|
Initiates a software update deployment in Configuration Manager. |
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
05/07/2019 |
2.0.0 |
Start-CMSoftwareUpdateDeployment |
(Deprecated) Initiates a software update deployment in Configuration Manager.
Start-CMSoftwareUpdateDeployment [-AcceptEula] [-AllowRestart <Boolean>] [-AllowUseMeteredNetwork <Boolean>]
-CollectionName <String> [-DeploymentAvailableDay <DateTime>] [-DeploymentAvailableTime <DateTime>]
[-DeploymentName <String>] [-DeploymentType <DeploymentType>] [-Description <String>]
[-DisableOperationsManagerAlert <Boolean>] [-DownloadFromMicrosoftUpdate <Boolean>]
[-EnforcementDeadline <DateTime>] [-EnforcementDeadlineDay <DateTime>]
[-GenerateOperationsManagerAlert <Boolean>] [-GenerateSuccessAlert <Boolean>] -InputObject <IResultObject>
[-PercentSuccess <Int32>] [-PersistOnWriteFilterDevice <Boolean>] [-ProtectedType <ProtectedType>]
[-RestartServer <Boolean>] [-RestartWorkstation <Boolean>] [-SendWakeupPacket <Boolean>]
[-SoftwareInstallation <Boolean>] [-TimeBasedOn <TimeType>] [-TimeUnit <TimeUnitType>] [-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>] [-UseBranchCache <Boolean>] [-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Start-CMSoftwareUpdateDeployment [-AcceptEula] [-AllowRestart <Boolean>] [-AllowUseMeteredNetwork <Boolean>]
-CollectionName <String> [-DeploymentAvailableDay <DateTime>] [-DeploymentAvailableTime <DateTime>]
[-DeploymentName <String>] [-DeploymentType <DeploymentType>] [-Description <String>]
[-DisableOperationsManagerAlert <Boolean>] [-DownloadFromMicrosoftUpdate <Boolean>]
[-EnforcementDeadline <DateTime>] [-EnforcementDeadlineDay <DateTime>]
[-GenerateOperationsManagerAlert <Boolean>] [-GenerateSuccessAlert <Boolean>] [-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>] [-ProtectedType <ProtectedType>] [-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>] [-SendWakeupPacket <Boolean>] [-SoftwareInstallation <Boolean>]
-SoftwareUpdateName <String> [-TimeBasedOn <TimeType>] [-TimeUnit <TimeUnitType>] [-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>] [-UseBranchCache <Boolean>] [-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Start-CMSoftwareUpdateDeployment [-AcceptEula] [-AllowRestart <Boolean>] [-AllowUseMeteredNetwork <Boolean>]
-CollectionName <String> [-DeploymentAvailableDay <DateTime>] [-DeploymentAvailableTime <DateTime>]
[-DeploymentName <String>] [-DeploymentType <DeploymentType>] [-Description <String>]
[-DisableOperationsManagerAlert <Boolean>] [-DownloadFromMicrosoftUpdate <Boolean>]
[-EnforcementDeadline <DateTime>] [-EnforcementDeadlineDay <DateTime>]
[-GenerateOperationsManagerAlert <Boolean>] [-GenerateSuccessAlert <Boolean>] [-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>] [-ProtectedType <ProtectedType>] [-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>] [-SendWakeupPacket <Boolean>] [-SoftwareInstallation <Boolean>]
-SoftwareUpdateId <String> [-TimeBasedOn <TimeType>] [-TimeUnit <TimeUnitType>] [-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>] [-UseBranchCache <Boolean>] [-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Start-CMSoftwareUpdateDeployment [-AcceptEula] [-AllowRestart <Boolean>] [-AllowUseMeteredNetwork <Boolean>]
-CollectionName <String> [-DeploymentAvailableDay <DateTime>] [-DeploymentAvailableTime <DateTime>]
[-DeploymentName <String>] [-DeploymentType <DeploymentType>] [-Description <String>]
[-DisableOperationsManagerAlert <Boolean>] [-DownloadFromMicrosoftUpdate <Boolean>]
[-EnforcementDeadline <DateTime>] [-EnforcementDeadlineDay <DateTime>]
[-GenerateOperationsManagerAlert <Boolean>] [-GenerateSuccessAlert <Boolean>] [-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>] [-ProtectedType <ProtectedType>] [-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>] [-SendWakeupPacket <Boolean>] [-SoftwareInstallation <Boolean>]
-SoftwareUpdateGroupName <String> [-TimeBasedOn <TimeType>] [-TimeUnit <TimeUnitType>] [-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>] [-UseBranchCache <Boolean>] [-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Start-CMSoftwareUpdateDeployment [-AcceptEula] [-AllowRestart <Boolean>] [-AllowUseMeteredNetwork <Boolean>]
-CollectionName <String> [-DeploymentAvailableDay <DateTime>] [-DeploymentAvailableTime <DateTime>]
[-DeploymentName <String>] [-DeploymentType <DeploymentType>] [-Description <String>]
[-DisableOperationsManagerAlert <Boolean>] [-DownloadFromMicrosoftUpdate <Boolean>]
[-EnforcementDeadline <DateTime>] [-EnforcementDeadlineDay <DateTime>]
[-GenerateOperationsManagerAlert <Boolean>] [-GenerateSuccessAlert <Boolean>] [-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>] [-ProtectedType <ProtectedType>] [-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>] [-SendWakeupPacket <Boolean>] [-SoftwareInstallation <Boolean>]
-SoftwareUpdateGroupId <String> [-TimeBasedOn <TimeType>] [-TimeUnit <TimeUnitType>] [-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>] [-UseBranchCache <Boolean>] [-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>] [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Important
This cmdlet is deprecated. Use New-CMSoftwareUpdateDeployment instead.
The Start-CMSoftwareUpdateDeployment cmdlet initiates a software update deployment.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
PS XYZ:\> 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.
PS XYZ:\> 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.
PS XYZ:\> 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.
PS XYZ:\> 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.
Some software updates include license terms. When you deploy software updates, the license terms aren't displayed. Add this parameter to automatically deploy all software updates regardless of an associated license term.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to allow a restart following installation.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to allow clients to use a metered network to download updates.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a name of a collection in Configuration Manager. A collection is a group of client computers.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a day, in MM/DD/YYYY format, when a software update deployment is available. By default, the update is available immediately.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a time, in HH:MM format, when a software update deployment is available. By default, the update is available immediately.
Type: DateTime
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a name for a software update deployment in Configuration Manager.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a deployment type in Configuration Manager.
Type: DeploymentType
Parameter Sets: (All)
Aliases:
Accepted values: Required, Available
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a description for a software update deployment.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to disable System Center 2012 - Operations Manager alerts during software updates.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether clients download updates directly from Microsoft Update.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: DateTime
Parameter Sets: (All)
Aliases: DeploymentExpireTime
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: DateTime
Parameter Sets: (All)
Aliases: DeploymentExpireDay
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to generate Operations Manager alerts when a software installation fails.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to generate alerts when a software installation succeeds.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Type: IResultObject
Parameter Sets: DeploySoftwareUpdateByValue
Aliases: SoftwareUpdate, SoftwareUpdateGroup
Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specifies a percent success.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a protected type.
Type: ProtectedType
Parameter Sets: (All)
Aliases:
Accepted values: NoInstall, RemoteDistributionPoint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to allow the software update to install, even if the installation occurs outside of a maintenance window.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies an ID for a software update group. A software update group contains individual software updates.
Type: String
Parameter Sets: DeploySoftwareUpdateGroupById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a name for a software update group.
Type: String
Parameter Sets: DeploySoftwareUpdateGroupByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies an ID for a software update in Configuration Manager.
Type: String
Parameter Sets: DeploySoftwareUpdateById
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a name for a software update in Configuration Manager.
Type: String
Parameter Sets: DeploySoftwareUpdateByName
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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: (All)
Aliases:
Accepted values: LocalTime, Utc
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies the time unit in Configuration Manager. Valid values are:
- Days
- Hours
- Months
- Weeks
Type: TimeUnitType
Parameter Sets: (All)
Aliases:
Accepted values: Hours, Days, Weeks, Months
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a time value in the units specified in the TimeUnit parameter.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies an unprotected type.
Type: UnprotectedType
Parameter Sets: (All)
Aliases:
Accepted values: NoInstall, UnprotectedDistributionPoint
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Indicates whether to use Branch Cache as a distribution point for updates.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies a user notification type.
Type: UserNotificationType
Parameter Sets: (All)
Aliases:
Accepted values: DisplayAll, DisplaySoftwareCenterOnly, HideAll
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specifies verbosity level. Valid values are:
- AllMessages
- OnlyErrorMessages
- OnlySuccessAndErrorMessages
Type: VerbosityLevelType
Parameter Sets: (All)
Aliases:
Accepted values: AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.