Edit

Share via

Set-CMSoftwareUpdatePhasedDeployment

  • Reference
Module:
ConfigurationManager

Configure a phased deployment for a software update.

Syntax

Set-CMSoftwareUpdatePhasedDeployment
   [-AddPhases <Phase[]>]
   [-Description <String>]
   -InputObject <IResultObject>
   [-NewName <String>]
   [-PassThru]
   [-RemovePhaseIds <String[]>]
   [-RemovePhaseOrders <Int32[]>]
   [-RemovePhases <Phase[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMSoftwareUpdatePhasedDeployment
   [-AddPhases <Phase[]>]
   [-Description <String>]
   [-NewName <String>]
   [-PassThru]
   [-RemovePhaseIds <String[]>]
   [-RemovePhaseOrders <Int32[]>]
   [-RemovePhases <Phase[]>]
   -Id <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMSoftwareUpdatePhasedDeployment
   [-AddPhases <Phase[]>]
   [-Description <String>]
   [-NewName <String>]
   [-PassThru]
   [-RemovePhaseIds <String[]>]
   [-RemovePhaseOrders <Int32[]>]
   [-RemovePhases <Phase[]>]
   -Name <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Applies to version 2006 and later. Configure a phased deployment for a software update. For more information, see Create phased deployments.

Examples

Example 1: Rename a phased deployment

This example renames a software update phased deployment that's passed through on the command line.

$suPhasedDeployment = Get-CMSoftwareUpdatePhasedDeployment -Name "myPhasedDeployment"

$suPhasedDeployment | Set-CMSoftwareUpdatePhasedDeployment -NewName "New SU phased deployment" -Description "New description" -PassThru

Example 2: Add a phase

This example adds a phase to a software update phased deployment targeted by its ID.

$newPhase = New-CMSoftwareUpdatePhase -CollectionName "MyCollection" -PhaseName "MySUPhase" -UserNotificationOption DisplaySoftwareCenterOnly

Set-CMSoftwareUpdatePhasedDeployment -Id "da0a01a3-b7ea-4d4b-8392-94b39ecabf8b" -AddPhases ($newPhase)

Parameters

-AddPhases

Use this parameter to add one or more phases to a software update phased deployment. Use the New-CMSoftwareUpdatePhase cmdlet to create a new phase object.

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

-Description

Specify an optional description to better identify this software update phased deployment.

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

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

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

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

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

-Id

Specify the ID of the software update phased deployment to configure. The format of this value is a GUID.

Type:String
Aliases:PhasedDeploymentId
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specify an object for an software update phased deployment to configure. For example, use the Get-CMSoftwareUpdatePhasedDeployment cmdlet to get this object.

Type:IResultObject
Aliases:PhasedDeployment
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specify the name of the software update phased deployment to configure.

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

-NewName

Use this parameter to rename the software update phased deployment.

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

-PassThru

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

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

-RemovePhaseIds

Remove one or more phases specified by their ID.

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

-RemovePhaseOrders

Remove one or more phases specified by their order in the phased deployment.

Type:Int32[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemovePhases

Remove one or more phases from a software update phased deployment. Use the Get-CMPhase cmdlet to identify the phase to remove.

Type:Phase[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject