New-​CM​Software​Update​Deployment

Creates a software update deployment

Syntax

New-CMSoftwareUpdateDeployment
   [-AcceptEula]
   [-AllowRestart <Boolean>]
   [-AvailableDateTime <DateTime>]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-Comment <String>]
   [-Confirm]
   [-DeadlineDateTime <DateTime>]
   [-DeploymentName <String>]
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DistributeCollectionName <String>]
   [-DistributeContent]
   [-DistributionPointGroupName <String>]
   [-DistributionPointName <String>]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   -InputObject <IResultObject>
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RequirePostRebootFullScan <Boolean>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SavedPackageId <String>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-TimeBasedOn <TimeType>]
   [-TimeUnit <TimeUnitType>]
   [-TimeValue <Int32>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]
New-CMSoftwareUpdateDeployment
   [-AcceptEula]
   [-AllowRestart <Boolean>]
   [-AvailableDateTime <DateTime>]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-Comment <String>]
   [-Confirm]
   [-DeadlineDateTime <DateTime>]
   [-DeploymentName <String>]
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DistributeCollectionName <String>]
   [-DistributeContent]
   [-DistributionPointGroupName <String>]
   [-DistributionPointName <String>]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RequirePostRebootFullScan <Boolean>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SavedPackageId <String>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   -SoftwareUpdateGroupId <String>
   [-TimeBasedOn <TimeType>]
   [-TimeUnit <TimeUnitType>]
   [-TimeValue <Int32>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]
New-CMSoftwareUpdateDeployment
   [-AcceptEula]
   [-AllowRestart <Boolean>]
   [-AvailableDateTime <DateTime>]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-Comment <String>]
   [-Confirm]
   [-DeadlineDateTime <DateTime>]
   [-DeploymentName <String>]
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DistributeCollectionName <String>]
   [-DistributeContent]
   [-DistributionPointGroupName <String>]
   [-DistributionPointName <String>]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RequirePostRebootFullScan <Boolean>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SavedPackageId <String>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   -SoftwareUpdateGroupName <String>
   [-TimeBasedOn <TimeType>]
   [-TimeUnit <TimeUnitType>]
   [-TimeValue <Int32>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]
New-CMSoftwareUpdateDeployment
   [-AcceptEula]
   [-AllowRestart <Boolean>]
   [-AvailableDateTime <DateTime>]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-Comment <String>]
   [-Confirm]
   [-DeadlineDateTime <DateTime>]
   [-DeploymentName <String>]
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DistributeCollectionName <String>]
   [-DistributeContent]
   [-DistributionPointGroupName <String>]
   [-DistributionPointName <String>]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RequirePostRebootFullScan <Boolean>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SavedPackageId <String>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   -SoftwareUpdateId <String>
   [-TimeBasedOn <TimeType>]
   [-TimeUnit <TimeUnitType>]
   [-TimeValue <Int32>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]
New-CMSoftwareUpdateDeployment
   [-AcceptEula]
   [-AllowRestart <Boolean>]
   [-AvailableDateTime <DateTime>]
   [-Collection <IResultObject>]
   [-CollectionId <String>]
   [-CollectionName <String>]
   [-Comment <String>]
   [-Confirm]
   [-DeadlineDateTime <DateTime>]
   [-DeploymentName <String>]
   [-DeploymentType <DeploymentType>]
   [-Description <String>]
   [-DisableOperationsManagerAlert <Boolean>]
   [-DisableWildcardHandling]
   [-DistributeCollectionName <String>]
   [-DistributeContent]
   [-DistributionPointGroupName <String>]
   [-DistributionPointName <String>]
   [-DownloadFromMicrosoftUpdate <Boolean>]
   [-ForceWildcardHandling]
   [-GenerateOperationsManagerAlert <Boolean>]
   [-GenerateSuccessAlert <Boolean>]
   [-PercentSuccess <Int32>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-ProtectedType <ProtectedType>]
   [-RequirePostRebootFullScan <Boolean>]
   [-RestartServer <Boolean>]
   [-RestartWorkstation <Boolean>]
   [-SavedPackageId <String>]
   [-SendWakeupPacket <Boolean>]
   [-SoftwareInstallation <Boolean>]
   -SoftwareUpdateName <String>
   [-TimeBasedOn <TimeType>]
   [-TimeUnit <TimeUnitType>]
   [-TimeValue <Int32>]
   [-UnprotectedType <UnprotectedType>]
   [-UseBranchCache <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-UserNotification <UserNotificationType>]
   [-VerbosityLevel <VerbosityLevelType>]
   [-WhatIf]
   [<CommonParameters>]

Description

{{Fill in the Description}}

Examples

Example 1

PS C:\> {{ Add example code here }}

{{ Add example description here }}

Required Parameters

-InputObject

{{Fill InputObject Description}}

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

{{Fill SoftwareUpdateGroupId Description}}

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

{{Fill SoftwareUpdateGroupName Description}}

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

{{Fill SoftwareUpdateId Description}}

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

{{Fill SoftwareUpdateName Description}}

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

Optional Parameters

-AcceptEula

{{Fill AcceptEula Description}}

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

{{Fill AllowRestart Description}}

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

{{Fill AvailableDateTime Description}}

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

{{Fill Collection Description}}

Type:IResultObject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CollectionId

{{Fill CollectionId Description}}

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

{{Fill CollectionName Description}}

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

{{Fill Comment Description}}

Type:String
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:None
Accept pipeline input:False
Accept wildcard characters:False
-DeadlineDateTime

{{Fill DeadlineDateTime Description}}

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

{{Fill DeploymentName Description}}

Type:String
Aliases:UpdateGroupDeploymentName
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentType

{{Fill DeploymentType Description}}

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

{{Fill Description Description}}

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

{{Fill DisableOperationsManagerAlert Description}}

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
-DistributeCollectionName

{{Fill DistributeCollectionName Description}}

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

{{Fill DistributeContent Description}}

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

{{Fill DistributionPointGroupName Description}}

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

{{Fill DistributionPointName Description}}

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

{{Fill DownloadFromMicrosoftUpdate Description}}

Type:Boolean
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

{{Fill GenerateOperationsManagerAlert Description}}

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

{{Fill GenerateSuccessAlert Description}}

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

{{Fill PercentSuccess Description}}

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

{{Fill PersistOnWriteFilterDevice Description}}

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

{{Fill ProtectedType Description}}

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

{{Fill RequirePostRebootFullScan Description}}

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

{{Fill RestartServer Description}}

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

{{Fill RestartWorkstation Description}}

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

{{Fill SavedPackageId Description}}

Type:String
Aliases:SavedDeploymentPackageId
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SendWakeupPacket

{{Fill SendWakeupPacket Description}}

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

{{Fill SoftwareInstallation Description}}

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

{{Fill TimeBasedOn Description}}

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

{{Fill TimeUnit Description}}

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

{{Fill TimeValue Description}}

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

{{Fill UnprotectedType Description}}

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

{{Fill UseBranchCache Description}}

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

{{Fill UseMeteredNetwork Description}}

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

{{Fill UserNotification Description}}

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

{{Fill VerbosityLevel Description}}

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:None
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object