Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Set-CMSoftwareUpdatePhasedDeployment
- Module:
- ConfigurationManager Module
Configure a phased deployment for a software update.
Syntax
SearchByValue
Set-CMSoftwareUpdatePhasedDeployment
-InputObject <IResultObject>
[-AddPhases <Phase[]>]
[-Description <String>]
[-NewName <String>]
[-PassThru]
[-RemovePhaseIds <String[]>]
[-RemovePhaseOrders <Int32[]>]
[-RemovePhases <Phase[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchById
Set-CMSoftwareUpdatePhasedDeployment
-Id <String>
[-AddPhases <Phase[]>]
[-Description <String>]
[-NewName <String>]
[-PassThru]
[-RemovePhaseIds <String[]>]
[-RemovePhaseOrders <Int32[]>]
[-RemovePhases <Phase[]>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByName
Set-CMSoftwareUpdatePhasedDeployment
-Name <String>
[-AddPhases <Phase[]>]
[-Description <String>]
[-NewName <String>]
[-PassThru]
[-RemovePhaseIds <String[]>]
[-RemovePhaseOrders <Int32[]>]
[-RemovePhases <Phase[]>]
[-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.
Parameter properties
| Type: | Phase[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
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
-Description
Specify an optional description to better identify this software update phased deployment.
Parameter properties
| Type: | String |
| 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
-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
-Id
Specify the ID of the software update phased deployment to configure. The format of this value is a GUID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PhasedDeploymentId |
Parameter sets
-InputObject
Specify an object for an software update phased deployment to configure. For example, use the Get-CMSoftwareUpdatePhasedDeployment cmdlet to get this object.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PhasedDeployment |
Parameter sets
-Name
Specify the name of the software update phased deployment to configure.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NewName
Use this parameter to rename the software update phased deployment.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-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
-RemovePhaseIds
Remove one or more phases specified by their ID.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RemovePhaseOrders
Remove one or more phases specified by their order in the phased deployment.
Parameter properties
| Type: | Int32[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-RemovePhases
Remove one or more phases from a software update phased deployment. Use the Get-CMPhase cmdlet to identify the phase to remove.
Parameter properties
| Type: | Phase[] |
| Default value: | None |
| 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
IResultObject
Related Links
- Get-CMSoftwareUpdatePhasedDeployment
- New-CMSoftwareUpdateAutoPhasedDeployment
- New-CMSoftwareUpdateManualPhasedDeployment
- Remove-CMSoftwareUpdatePhasedDeployment
- Get-CMPhase
- New-CMSoftwareUpdatePhase
- Set-CMSoftwareUpdatePhase
- Get-CMPhasedDeploymentStatus
- Move-CMPhasedDeploymentToNext
- Resume-CMPhasedDeployment
- Suspend-CMPhasedDeployment
- Create phased deployments
Feedback
Was this page helpful?