New-CMSoftwareUpdateManualPhasedDeployment

Module:

ConfigurationManager Module

Create a phased deployment for software updates.

Syntax

SearchByGroupMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdateGroup] <IResultObject>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByGroupIdMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdateGroupId] <String>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByGroupNameMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdateGroupName] <String>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByIdMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdateIds] <String[]>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByNameMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdateNames] <String[]>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SearchByValueMandatory

New-CMSoftwareUpdateManualPhasedDeployment
    [-SoftwareUpdates] <IResultObject[]>
    -AddPhases <Phase[]>
    -Name <String>
    [-Description <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Use this cmdlet to create a phased deployment for software updates. Before you use this cmdlet, add new customized deployment phases with the cmdlet New-CMSoftwareUpdatePhase.

For more information, see Create phased deployments with Configuration Manager.

Note

Examples

Example 1: Create a deployment for software updates by name

This example creates a two-phase deployment named myPhaseDeployment for two software updates.

$phase1 = New-CMSoftwareUpdatePhase -CollectionId "SMSDM001" -PhaseName "test01" -UserNotificationOption DisplaySoftwareCenterOnly
$phase2 = New-CMSoftwareUpdatePhase -CollectionId "SMSDM003" -PhaseName "test02" -UserNotificationOption DisplaySoftwareCenterOnly
New-CMSoftwareUpdateManualPhasedDeployment -SoftwareUpdateNames ("myUpdateA", "myUpdateB") -Name "myPhaseDeployment" -AddPhases ($phase1, $phase2)

Example 2: Create a deployment for a software update group by name

This example creates a two-phase deployment named myPhaseDeploymentForGroup for the software update group myGroup.

$phase3 = New-CMSoftwareUpdatePhase -CollectionId "SMSDM001" -PhaseName "test03" -UserNotificationOption DisplaySoftwareCenterOnly
$phase4 = New-CMSoftwareUpdatePhase -CollectionId "SMSDM003" -PhaseName "test04" -UserNotificationOption DisplaySoftwareCenterOnly
New-CMSoftwareUpdateManualPhasedDeployment -SoftwareUpdateGroupName "myGroup" -Name "myPhaseDeploymentForGroup" -AddPhases ($phase3, $phase4)

Parameters

-AddPhases

Specify an array of phases. Use New-CMSoftwareUpdatePhase to create the phases.

Parameter properties

Type:	Phase[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

(All)

Position:	Named
Mandatory:	True
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:	None
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

-Description

Specify a description for the software update phased 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

-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

-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

-Name

Specify a name for the software update phased deployment.

Parameter properties

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

Parameter sets

(All)

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

-SoftwareUpdateGroup

Specify an object for a software update group. To get this object, use the Get-CMSoftwareUpdateGroup cmdlet.

Parameter properties

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

Parameter sets

SearchByGroupMandatory

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

-SoftwareUpdateGroupId

Specify a software update group by ID.

Parameter properties

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

Parameter sets

SearchByGroupIdMandatory

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

-SoftwareUpdateGroupName

Specify a software update group by name.

Parameter properties

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

Parameter sets

SearchByGroupNameMandatory

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

-SoftwareUpdateIds

Specify an array of software update IDs.

Parameter properties

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

Parameter sets

SearchByIdMandatory

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

-SoftwareUpdateNames

Specify an array of software update names.

Parameter properties

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

Parameter sets

SearchByNameMandatory

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

-SoftwareUpdates

Specify an array of software update objects. To get this object, use the Get-CMSoftwareUpdate cmdlet.

Parameter properties

Type:	IResultObject[]
Default value:	None
Supports wildcards:	False
DontShow:	False

Parameter sets

SearchByValueMandatory

Position:	0
Mandatory:	True
Value from pipeline:	True
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:	None
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

IResultObject

Notes

The return object is the SMS_PhasedDeployment server WMI class.

Related Links

• Get-CMSoftwareUpdatePhasedDeployment
• Remove-CMSoftwareUpdatePhasedDeployment
• Set-CMSoftwareUpdatePhasedDeployment
• Get-CMPhasedDeploymentStatus
• Move-CMPhasedDeploymentToNext
• Resume-CMPhasedDeployment
• Suspend-CMPhasedDeployment
• Create phased deployments with Configuration Manager