Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
New-CMTaskSequencePhase
- Module:
- ConfigurationManager Module
Use this cmdlet to create a deployment phase for a task sequence.
Syntax
SearchByCollection
New-CMTaskSequencePhase
[-Collection] <IResultObject>
-PhaseName <String>
[-AllowFallback <Boolean>]
[-AllowRemoteDP <Boolean>]
[-AllowSystemRestart <Boolean>]
[-BeginCondition <BeginConditionType>]
[-Comments <String>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DeploymentOption <DeploymentOptionType>]
[-InstallationChoice <InstallationChoiceType>]
[-PreDownload <Boolean>]
[-SoftwareInstallation <Boolean>]
[-ThrottlingDays <Int32>]
[-UserNotification <UserNotificationType>]
[-WriteFilterCommit <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByCollectionId
New-CMTaskSequencePhase
[-CollectionId] <String>
-PhaseName <String>
[-AllowFallback <Boolean>]
[-AllowRemoteDP <Boolean>]
[-AllowSystemRestart <Boolean>]
[-BeginCondition <BeginConditionType>]
[-Comments <String>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DeploymentOption <DeploymentOptionType>]
[-InstallationChoice <InstallationChoiceType>]
[-PreDownload <Boolean>]
[-SoftwareInstallation <Boolean>]
[-ThrottlingDays <Int32>]
[-UserNotification <UserNotificationType>]
[-WriteFilterCommit <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByCollectionName
New-CMTaskSequencePhase
[-CollectionName] <String>
-PhaseName <String>
[-AllowFallback <Boolean>]
[-AllowRemoteDP <Boolean>]
[-AllowSystemRestart <Boolean>]
[-BeginCondition <BeginConditionType>]
[-Comments <String>]
[-CriteriaOption <CriteriaType>]
[-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>]
[-DeadlineUnit <TimeUnitType>]
[-DeadlineValue <Int32>]
[-DeploymentOption <DeploymentOptionType>]
[-InstallationChoice <InstallationChoiceType>]
[-PreDownload <Boolean>]
[-SoftwareInstallation <Boolean>]
[-ThrottlingDays <Int32>]
[-UserNotification <UserNotificationType>]
[-WriteFilterCommit <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Use this cmdlet to create a deployment phase for a task sequence.
Examples
Example 1: Create a task sequence phase
This example creates a task sequence phase named MyTSPhase for the collection named MyCollection.
New-CMTaskSequencePhase -CollectionName "MyCollection" -PhaseName "MyTSPhase" -UserNotification DisplayAll -AllowRemoteDP $true
Parameters
-AllowFallback
This parameter is the same as the following setting on the Distribution Points page of the Add Phase Wizard in the console: Allow clients to use distribution points from the default site boundary group.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AllowRemoteDP
This parameter is the same as the following setting on the Distribution Points page of the Add Phase Wizard in the console: When no local distribution point is available, use a remote distribution point.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-AllowSystemRestart
This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: System restart (if required to complete installation). This setting applies when the installation deadline is reached, to allow this activity to be performed outside the maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-BeginCondition
Specify an option for beginning this phase of deployment after success of the previous phase:
AfterPeriod: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Automatically begin this phase after a deferral period (in days). If you specify this value, use DaysAfterPreviousPhaseSuccess to configure the period of time.Manually: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Manually begin this phase of deployment.
Parameter properties
| Type: | BeginConditionType |
| Default value: | None |
| Accepted values: | AfterPeriod, Manually |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specify an object for the target collection
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionId
Specify the target collection by ID.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CollectionName
Specify the target collection by name.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Comments
Specify optional comments for this phase. The maximum length is 512 characters.
Parameter properties
| Type: | String |
| 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
-CriteriaOption
Specify an option to choose the criteria for success of the previous phase:
Compliance: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Deployment success percentage. Specify the percentage value with the CriteriaValue parameter.Number: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Number of devices successfully deployed. Specify the number of devices with the CriteriaValue parameter.
Parameter properties
| Type: | CriteriaType |
| Default value: | None |
| Accepted values: | Compliance, Number |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-CriteriaValue
This integer value depends upon the value that you specify for CriteriaOption:
Compliance: Specify the percentageNumber: Specify the number of devices
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DaysAfterPreviousPhaseSuccess
Specify an integer value for the number of days after success of the previous phase to begin this phase. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Automatically begin this phase after a deferral period (in days).
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeadlineUnit
Specify the type of deadline period. Use this parameter with DeadlineValue.
Parameter properties
| Type: | TimeUnitType |
| Default value: | None |
| Accepted values: | Hours, Days, Weeks, Months |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeadlineValue
This parameter is only used if you specify AfterPeriod with the InstallationChoice parameter.
Specify an integer value for the period of time for the deadline. Use the DeadlineUnit parameter to specify the type of period: Hours, Days, Weeks, Months. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required after this period of time.
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeploymentOption
This parameter is the same as the following setting on the Distribution Points page of the Add Phase Wizard in the console: Select the deployment option to use when a client uses a distribution point from a neighbor boundary group or the default site boundary group. It accepts the following values:
DownloadContentLocallyWhenNeededByRunningTaskSequence: Download content locally when needed by the running task sequenceDownloadAllContentLocallyBeforeStartingTaskSequence: Download all content locally before starting task sequence
Parameter properties
| Type: | DeploymentOptionType |
| Default value: | None |
| Accepted values: | DownloadContentLocallyWhenNeededByRunningTaskSequence, DownloadAllContentLocallyBeforeStartingTaskSequence |
| 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. It's not recommended. You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-InstallationChoice
Specify an option for the behavior relative to when the software is made available:
AsSoonAsPossible: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required as soon as possible.AfterPeriod: This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Installation is required after this period of time. If you specify this value, use DeadlineUnit and DeadlineValue to configure the period of time.
Parameter properties
| Type: | InstallationChoiceType |
| Default value: | None |
| Accepted values: | AsSoonAsPossible, AfterPeriod |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-PhaseName
Specify a name for the phase.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
-PreDownload
This parameter is the same as the following setting on the General page of the Add Phase Wizard in the console: Pre-download content for this task sequence.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-SoftwareInstallation
This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Software Installation. This setting applies when the installation deadline is reached, to allow this activity to be performed outside the maintenance window.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ThrottlingDays
Specify an integer value for the number of days to gradually make this software available. This parameter is the same as the following setting on the Phase Settings page of the Add Phase Wizard in the console: Gradually make this software available over this period of time (in days).
Parameter properties
| Type: | Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-UserNotification
This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Specify user experience setting for this deployment with the following values:
DisplayAll: Display in Software Center and show all notificationsHideAll: Hide in Software Center and all notifications
Parameter properties
| Type: | UserNotificationType |
| Default value: | None |
| Accepted values: | DisplayAll, HideAll |
| 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
-WriteFilterCommit
This parameter is the same as the following setting on the User Experience page of the Add Phase Wizard in the console: Commit changes at deadline or during a maintenance window (requires restart). This setting applies to write filter handling for Windows Embedded devices.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
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
None
Outputs
Microsoft.ConfigurationManager.PhasedDeploymentModel.Phase
Feedback
Was this page helpful?