Edit

Share via

Set-CMSoftwareUpdateDeployment

Module:
ConfigurationManager Module

Modify a software update deployment.

Syntax

SetByValueMandatory (Default) 

Set-CMSoftwareUpdateDeployment
    -InputObject <IResultObject>
    [-AlertDateTime <DateTime>]
    [-AllowRestart <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-AvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentName <String>]
    [-DeploymentType <DeploymentType>]
    [-Description <String>]
    [-DisableOperationsManagerAlert <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-GenerateOperationsManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-NewDeploymentName <String>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-ProtectedType <ProtectedType>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RestartServer <Boolean>]
    [-RestartWorkstation <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-TimeBasedOn <TimeType>]
    [-UnprotectedType <UnprotectedType>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-VerbosityLevel <VerbosityLevelType>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetSoftwareUpdateGroupDeploymentByIdMandatory 

Set-CMSoftwareUpdateDeployment
    -SoftwareUpdateGroupId <String>
    [-AlertDateTime <DateTime>]
    [-AllowRestart <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-AvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentName <String>]
    [-DeploymentType <DeploymentType>]
    [-Description <String>]
    [-DisableOperationsManagerAlert <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-GenerateOperationsManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-NewDeploymentName <String>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-ProtectedType <ProtectedType>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RestartServer <Boolean>]
    [-RestartWorkstation <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-TimeBasedOn <TimeType>]
    [-UnprotectedType <UnprotectedType>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-VerbosityLevel <VerbosityLevelType>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetSoftwareUpdateGroupDeploymentByNameMandatory 

Set-CMSoftwareUpdateDeployment
    -SoftwareUpdateGroupName <String>
    [-AlertDateTime <DateTime>]
    [-AllowRestart <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-AvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentName <String>]
    [-DeploymentType <DeploymentType>]
    [-Description <String>]
    [-DisableOperationsManagerAlert <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-GenerateOperationsManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-NewDeploymentName <String>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-ProtectedType <ProtectedType>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RestartServer <Boolean>]
    [-RestartWorkstation <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-TimeBasedOn <TimeType>]
    [-UnprotectedType <UnprotectedType>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-VerbosityLevel <VerbosityLevelType>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetSoftwareUpdateDeploymentByIdMandatory 

Set-CMSoftwareUpdateDeployment
    -SoftwareUpdateId <String>
    [-AlertDateTime <DateTime>]
    [-AllowRestart <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-AvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentName <String>]
    [-DeploymentType <DeploymentType>]
    [-Description <String>]
    [-DisableOperationsManagerAlert <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-GenerateOperationsManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-NewDeploymentName <String>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-ProtectedType <ProtectedType>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RestartServer <Boolean>]
    [-RestartWorkstation <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-TimeBasedOn <TimeType>]
    [-UnprotectedType <UnprotectedType>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-VerbosityLevel <VerbosityLevelType>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetSoftwareUpdateDeploymentByNameMandatory 

Set-CMSoftwareUpdateDeployment
    -SoftwareUpdateName <String>
    [-AlertDateTime <DateTime>]
    [-AllowRestart <Boolean>]
    [-AllowUseMeteredNetwork <Boolean>]
    [-AvailableDateTime <DateTime>]
    [-DeploymentExpireDateTime <DateTime>]
    [-DeploymentName <String>]
    [-DeploymentType <DeploymentType>]
    [-Description <String>]
    [-DisableOperationsManagerAlert <Boolean>]
    [-DownloadFromMicrosoftUpdate <Boolean>]
    [-Enable <Boolean>]
    [-GenerateOperationsManagerAlert <Boolean>]
    [-GenerateSuccessAlert <Boolean>]
    [-NewDeploymentName <String>]
    [-PercentSuccess <Int32>]
    [-PersistOnWriteFilterDevice <Boolean>]
    [-ProtectedType <ProtectedType>]
    [-RequirePostRebootFullScan <Boolean>]
    [-RestartServer <Boolean>]
    [-RestartWorkstation <Boolean>]
    [-SendWakeupPacket <Boolean>]
    [-SoftDeadlineEnabled <Boolean>]
    [-SoftwareInstallation <Boolean>]
    [-TimeBasedOn <TimeType>]
    [-UnprotectedType <UnprotectedType>]
    [-UseBranchCache <Boolean>]
    [-UserNotification <UserNotificationType>]
    [-VerbosityLevel <VerbosityLevelType>]
    [-PassThru]
    [-Collection <IResultObject>]
    [-CollectionId <String>]
    [-CollectionName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to modify a deployment of software updates in Configuration Manager.

For more information, see Deploy software updates in Configuration Manager.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Set a deployment with expiration time

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

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

Example 2: Start a deployment without expiration time

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

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

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

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

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

Example 4: Start a deployment by software update group name

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

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

Parameters

-AlertDateTime

If -GenerateSuccessAlert is $true, specify a time to generate the alert.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowRestart

Indicates whether to allow a restart following installation.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AllowUseMeteredNetwork

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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-AvailableDateTime

Specify when the software updates are available.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentExpireDateTime

Specify an expiration time for the deployment.

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DeploymentName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specifies a description for a software update deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DownloadFromMicrosoftUpdate

Indicates whether clients download updates directly from Microsoft Update.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Enable

Indicates whether this deployment is enabled.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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

Important

This parameter currently only supports deployment of a single software update. It doesn't support deployment of software update groups.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify a software update object to deploy.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:SoftwareUpdate, DeploymentSummary, SoftwareUpdateGroup, Assignment

Parameter sets

SetByValueMandatory
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-NewDeploymentName

Rename this software update deployment.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

Returns an object representing the item with which you're working. By default, this cmdlet may not generate any output.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RestartServer

Indicate whether to suppress a server restart, if a restart is required to complete update installation.

  • $true: Suppress the restart
  • $false: Allow servers to restart

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RestartWorkstation

Indicate whether to suppress a workstation restart, if a restart is required to complete update installation.

  • $true: Suppress the restart
  • $false: Allow servers to restart

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftDeadlineEnabled

Set this parameter to $true to 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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareInstallation

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareUpdateGroupId

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetSoftwareUpdateGroupDeploymentByIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareUpdateGroupName

Specifies a name for a software update group.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetSoftwareUpdateGroupDeploymentByNameMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareUpdateId

Specifies an ID for a software update in Configuration Manager.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetSoftwareUpdateDeploymentByIdMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SoftwareUpdateName

Specifies a name for a software update in Configuration Manager.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetSoftwareUpdateDeploymentByNameMandatory
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:TimeType
Default value:None
Accepted values:LocalTime, Utc
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-UserNotification

Specify a user notification experience.

  • DisplayAll: Display in Software Center and show all notifications
  • DisplaySoftwareCenterOnly: Display in Software Center and only show notifications for computer restarts
  • HideAll: 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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:False
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

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