Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-CMSoftwareUpdateDeployment
- Module:
- ConfigurationManager Module
Create a software update deployment.
Syntax
DeploySoftwareUpdateByValue (Default)
New-CMSoftwareUpdateDeployment
-InputObject <IResultObject>
[-AcceptEula]
[-AllowRestart <Boolean>]
[-DeploymentName <String>]
[-DeploymentType <DeploymentType>]
[-Comment <String>]
[-DisableOperationsManagerAlert <Boolean>]
[-DownloadFromMicrosoftUpdate <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-PercentSuccess <Int32>]
[-ProtectedType <ProtectedType>]
[-DeployWithNoPackage <Boolean>]
[-RequirePostRebootFullScan <Boolean>]
[-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>]
[-SavedPackageId <String>]
[-SoftDeadlineEnabled <Boolean>]
[-SoftwareInstallation <Boolean>]
[-TimeBasedOn <TimeType>]
[-TimeUnit <TimeUnitType>]
[-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-DeadlineDateTime <DateTime>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeploySoftwareUpdateGroupById
New-CMSoftwareUpdateDeployment
-SoftwareUpdateGroupId <String>
[-AcceptEula]
[-AllowRestart <Boolean>]
[-DeploymentName <String>]
[-DeploymentType <DeploymentType>]
[-Comment <String>]
[-DisableOperationsManagerAlert <Boolean>]
[-DownloadFromMicrosoftUpdate <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-PercentSuccess <Int32>]
[-ProtectedType <ProtectedType>]
[-DeployWithNoPackage <Boolean>]
[-RequirePostRebootFullScan <Boolean>]
[-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>]
[-SavedPackageId <String>]
[-SoftDeadlineEnabled <Boolean>]
[-SoftwareInstallation <Boolean>]
[-TimeBasedOn <TimeType>]
[-TimeUnit <TimeUnitType>]
[-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-DeadlineDateTime <DateTime>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeploySoftwareUpdateGroupByName
New-CMSoftwareUpdateDeployment
-SoftwareUpdateGroupName <String>
[-AcceptEula]
[-AllowRestart <Boolean>]
[-DeploymentName <String>]
[-DeploymentType <DeploymentType>]
[-Comment <String>]
[-DisableOperationsManagerAlert <Boolean>]
[-DownloadFromMicrosoftUpdate <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-PercentSuccess <Int32>]
[-ProtectedType <ProtectedType>]
[-DeployWithNoPackage <Boolean>]
[-RequirePostRebootFullScan <Boolean>]
[-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>]
[-SavedPackageId <String>]
[-SoftDeadlineEnabled <Boolean>]
[-SoftwareInstallation <Boolean>]
[-TimeBasedOn <TimeType>]
[-TimeUnit <TimeUnitType>]
[-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-DeadlineDateTime <DateTime>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeploySoftwareUpdateById
New-CMSoftwareUpdateDeployment
-SoftwareUpdateId <String>
[-AcceptEula]
[-AllowRestart <Boolean>]
[-DeploymentName <String>]
[-DeploymentType <DeploymentType>]
[-Comment <String>]
[-DisableOperationsManagerAlert <Boolean>]
[-DownloadFromMicrosoftUpdate <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-PercentSuccess <Int32>]
[-ProtectedType <ProtectedType>]
[-DeployWithNoPackage <Boolean>]
[-RequirePostRebootFullScan <Boolean>]
[-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>]
[-SavedPackageId <String>]
[-SoftDeadlineEnabled <Boolean>]
[-SoftwareInstallation <Boolean>]
[-TimeBasedOn <TimeType>]
[-TimeUnit <TimeUnitType>]
[-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-DeadlineDateTime <DateTime>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
DeploySoftwareUpdateByName
New-CMSoftwareUpdateDeployment
-SoftwareUpdateName <String>
[-AcceptEula]
[-AllowRestart <Boolean>]
[-DeploymentName <String>]
[-DeploymentType <DeploymentType>]
[-Comment <String>]
[-DisableOperationsManagerAlert <Boolean>]
[-DownloadFromMicrosoftUpdate <Boolean>]
[-GenerateOperationsManagerAlert <Boolean>]
[-GenerateSuccessAlert <Boolean>]
[-PercentSuccess <Int32>]
[-ProtectedType <ProtectedType>]
[-DeployWithNoPackage <Boolean>]
[-RequirePostRebootFullScan <Boolean>]
[-RestartServer <Boolean>]
[-RestartWorkstation <Boolean>]
[-SavedPackageId <String>]
[-SoftDeadlineEnabled <Boolean>]
[-SoftwareInstallation <Boolean>]
[-TimeBasedOn <TimeType>]
[-TimeUnit <TimeUnitType>]
[-TimeValue <Int32>]
[-UnprotectedType <UnprotectedType>]
[-UseBranchCache <Boolean>]
[-UserNotification <UserNotificationType>]
[-VerbosityLevel <VerbosityLevelType>]
[-DistributeCollectionName <String>]
[-DistributeContent]
[-DistributionPointGroupName <String>]
[-DistributionPointName <String>]
[-AvailableDateTime <DateTime>]
[-DeadlineDateTime <DateTime>]
[-PersistOnWriteFilterDevice <Boolean>]
[-SendWakeupPacket <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use this cmdlet to deploy software updates to a target collection.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1
New-CMSoftwareUpdateDeployment -DeploymentName "updates deployment" -SoftwareUpdateGroupName "software update group" -CollectionName "Desktop clients for SUM" -Description "a more detailed description of this deployment" -DeploymentType Required -VerbosityLevel AllMessages -AvailableDateTime "2020/08/25 02:00AM" -DeadlineDateTime "2020/08/26 02:00AM" -UserNotification DisplaySoftwareCenterOnly -SoftwareInstallation $True -AllowRestart $True -RestartServer $False -RestartWorkstation $False -PersistOnWriteFilterDevice $True -RequirePostRebootFullScan $True -ProtectedType RemoteDistributionPoint
Parameters
-AcceptEula
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.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AllowRestart
When the installation deadline is reached, set this parameter to $true to allow system restart if necessary outside the maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AvailableDateTime
Specify when the software updates are available.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specifies a collection object in Configuration Manager the deployment will target. Get this object with the Get-CMCollection cmdlet.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionId
Specify the collection ID as the target for this software update deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionName
Specify the collection name as the target for this software update deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
-Comment
Specify an optional description for the software update deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Description |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-DeadlineDateTime
Specify an installation deadline for required software updates. When the deadline is reached, the client installs required software updates on the device, and restarts the device if necessary.
Parameter properties
| Type: | DateTime |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeploymentName
Specify a name for the software update deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | UpdateGroupDeploymentName |
Parameter sets
-DeploymentType
Specify if this deployment is available for users to install or if it's a required installation at the specified deadline schedule.
Parameter properties
| Type: | DeploymentType |
| Default value: | None |
| Accepted values: | Required, Available |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeployWithNoPackage
Set this parameter to $true to not use a deployment package. Clients download software update content from peers or the Microsoft cloud.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableOperationsManagerAlert
Indicates whether to disable Operations Manager alerts during software updates.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributeCollectionName
The site distributes content to the distribution point groups that are associated with this collection name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributeContent
Add this parameter to distribute the software update content when you create this deployment. Clients can't install the software updates until you distribute content to distribution points that the clients can access.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributionPointGroupName
The site distributes content to this distribution point group.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DistributionPointName
The site distributes content to this distribution point.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DownloadFromMicrosoftUpdate
If software update content isn't available on a distribution point in current, neighbor, or site boundary groups, download content from Microsoft Update.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-GenerateOperationsManagerAlert
Indicates whether to generate Operations Manager alerts when a software installation fails.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-GenerateSuccessAlert
If compliance of the deployment is below a specified threshold, the deployment generates an alert in the Configuration Manager console. The default threshold is 95 percent. To change the threshold, use the PercentSuccess parameter.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InputObject
Specify a software update object to deploy.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SoftwareUpdate, SoftwareUpdateGroup |
Parameter sets
-PercentSuccess
If you set -GenerateSuccessAlert to $true, use this parameter to specify the percentage compliance threshold at which the site generates a Configuration Manager console alert. If not specified, the site generates an alert if the deployment doesn't achieve 95 percent compliance by the specified deadline.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ProtectedType
Specify whether clients can use a distribution point from a neighbor boundary group or the default site boundary group.
Parameter properties
| Type: | ProtectedType |
| Default value: | None |
| Accepted values: | NoInstall, RemoteDistributionPoint |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RequirePostRebootFullScan
This parameter controls the following console option: Software updates deployment re-evaluation behavior upon restart. If you set this option to $true, after clients restart when they install updates from this deployment, they then run a full update deployment evaluation cycle.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | RunEvaluationAfterRestart |
Parameter sets
-RestartServer
Indicates whether to allow a server to restart following a software update.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RestartWorkstation
Indicates whether to allow a workstation to restart following a software update.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SavedPackageId
Use this cmdlet to deploy software updates to a target collection.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | SavedDeploymentPackageId |
Parameter sets
-SendWakeupPacket
Indicates whether to send a wake-up packet to computers before the deployment begins.
$True: Configuration Manager wakes a computer from sleep.$False: It doesn't wake computers from sleep.
For computers to wake, first configure Wake On LAN.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftDeadlineEnabled
Use this parameter to set the following option on the Deployment Schedule page of the ADR deployment settings: Delay enforcement of this deployment according to user preferences, up to the grace period defined in client settings.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DelayEnforcementAndUpToGracePeriod |
Parameter sets
-SoftwareInstallation
When the installation deadline is reached, set this parameter to $true to allow software update installation outside the maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftwareUpdateGroupId
Specify the ID of a software update group to deploy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftwareUpdateGroupName
Specify the name of a software update group to deploy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftwareUpdateId
Specify the ID of a software update to deploy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftwareUpdateName
Specify the name of a software update to deploy.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TimeBasedOn
Specify that clients use either local or UTC time to determine the availability of the deployment. UTC time makes the software update available at the same time for all computers.
Parameter properties
| Type: | TimeType |
| Default value: | None |
| Accepted values: | LocalTime, Utc |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TimeUnit
Specify the type of value of the -TimeValue parameter.
Parameter properties
| Type: | TimeUnitType |
| Default value: | None |
| Accepted values: | Hours, Days, Weeks, Months |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-TimeValue
Specify an integer value for the time. Use the -TimeUnit parameter to determine the type of time for this value.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UnprotectedType
When software updates aren't available on any distribution points in current or neighbor boundary group, specify whether clients can download and install software updates from distribution points in the site default boundary group.
Parameter properties
| Type: | UnprotectedType |
| Default value: | None |
| Accepted values: | NoInstall, UnprotectedDistributionPoint |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UseBranchCache
Indicates whether to use Windows BranchCache to download software update content.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UseMeteredNetwork
Indicates whether to allow clients to use a metered network to download updates.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserNotification
Specify a user notification experience.
DisplayAll: Display in Software Center and show all notificationsDisplaySoftwareCenterOnly: Display in Software Center and only show notifications for computer restartsHideAll: Hide in Software Center and all notifications
Parameter properties
| Type: | UserNotificationType |
| Default value: | None |
| Accepted values: | DisplayAll, DisplaySoftwareCenterOnly, HideAll |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-VerbosityLevel
Specify the state message detail level returned by clients for this software update deployment.
Parameter properties
| Type: | VerbosityLevelType |
| Default value: | None |
| Accepted values: | AllMessages, OnlySuccessAndErrorMessages, OnlyErrorMessages |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Related Links
Feedback
Was this page helpful?