external help file | Module Name | online version | schema |
---|---|---|---|
AdminUI.PS.dll-Help.xml |
ConfigurationManager |
2.0.0 |
Use this cmdlet to create a phased deployment for a task sequence by generating two phases with same settings.
New-CMTaskSequenceAutoPhasedDeployment [-TaskSequence] <IResultObject> [-AddPhases <Phase[]>]
[-BeginCondition <BeginConditionType>] [-CriteriaOption <CriteriaType>] [-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>] [-DeadlineUnit <TimeUnitType>] [-DeadlineValue <Int32>]
[-FirstCollection <IResultObject>] [-FirstCollectionId <String>] [-FirstCollectionName <String>]
[-InsertAtOrder <Int32>] [-InstallationChoice <InstallationChoiceType>] [-SecondCollection <IResultObject>]
[-SecondCollectionId <String>] [-SecondCollectionName <String>] [-ThrottlingDays <Int32>]
[-Description <String>] -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
New-CMTaskSequenceAutoPhasedDeployment [-TaskSequenceId] <String> [-AddPhases <Phase[]>]
[-BeginCondition <BeginConditionType>] [-CriteriaOption <CriteriaType>] [-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>] [-DeadlineUnit <TimeUnitType>] [-DeadlineValue <Int32>]
[-FirstCollection <IResultObject>] [-FirstCollectionId <String>] [-FirstCollectionName <String>]
[-InsertAtOrder <Int32>] [-InstallationChoice <InstallationChoiceType>] [-SecondCollection <IResultObject>]
[-SecondCollectionId <String>] [-SecondCollectionName <String>] [-ThrottlingDays <Int32>]
[-Description <String>] -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
New-CMTaskSequenceAutoPhasedDeployment [-TaskSequenceName] <String> [-AddPhases <Phase[]>]
[-BeginCondition <BeginConditionType>] [-CriteriaOption <CriteriaType>] [-CriteriaValue <Int32>]
[-DaysAfterPreviousPhaseSuccess <Int32>] [-DeadlineUnit <TimeUnitType>] [-DeadlineValue <Int32>]
[-FirstCollection <IResultObject>] [-FirstCollectionId <String>] [-FirstCollectionName <String>]
[-InsertAtOrder <Int32>] [-InstallationChoice <InstallationChoiceType>] [-SecondCollection <IResultObject>]
[-SecondCollectionId <String>] [-SecondCollectionName <String>] [-ThrottlingDays <Int32>]
[-Description <String>] -Name <String> [-DisableWildcardHandling] [-ForceWildcardHandling] [-WhatIf]
[-Confirm] [<CommonParameters>]
Use this cmdlet to create a phased deployment for a task sequence by generating two phases with same settings. This cmdlet's behavior is the same as the Create Phased Deployment wizard on a task sequence, when you select the option to Automatically create a default two phase deployment.
Note
Before you create a phased deployment, make sure to distribute the task sequence content to a distribution point.
This example creates a new task sequence phased deployment named myDPName for the task sequence myTaskSequenceName.
New-CMTaskSequenceAutoPhasedDeployment -TaskSequenceName "myTaskSequenceName" -Name "myPDName" -FirstCollectionID "SMSDM001" -SecondCollectionID "SMSDM003" -CriteriaOption Compliance -CriteriaValue 1 -BeginCondition AfterPeriod -DaysAfterPreviousPhaseSuccess 2 -ThrottlingDays 3 -InstallationChoice AfterPeriod -DeadlineUnit Hours -DeadlineValue 4 -Description "MyDescription"
This example creates a new task sequence phased deployment named myPDName for a piped task sequence object.
$myTS | New-CMTaskSequenceAutoPhasedDeployment -Name "myPDName" -FirstCollectionID "SMSDM001" -SecondCollectionID "SMSDM003" -CriteriaOption Compliance -CriteriaValue 1 -BeginCondition AfterPeriod -DaysAfterPreviousPhaseSuccess 2 -ThrottlingDays 3 -InstallationChoice AfterPeriod -DeadlineUnit Hours -DeadlineValue 4 -Description "MyDescription"
This cmdlet automatically creates two phases for the specified two collections. You can also add more phases with this parameter. Specify an array of phases. Use New-CMTaskSequencePhase to create the phases.
Type: Phase[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an option for beginning the second phase of deployment after success of the first phase:
-
AfterPeriod
: This parameter is the same as the following setting on the Settings page of the Create Phased Deployment 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 Settings page of the Create Phased Deployment wizard in the console: Manually begin the second phase deployment.
Type: BeginConditionType
Parameter Sets: (All)
Aliases:
Accepted values: AfterPeriod, Manually
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an option to choose the criteria for success of the first phase:
-
Compliance
: This parameter is the same as the following setting on the Settings page of the Create Phased Deployment 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 Settings page of the Create Phased Deployment wizard in the console: Number of devices successfully deployed. Specify the number of devices with the CriteriaValue parameter.
Type: CriteriaType
Parameter Sets: (All)
Aliases:
Accepted values: Compliance, Number
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This integer value depends upon the value that you specify for CriteriaOption:
-
Compliance
: Specify the percentage -
Number
: Specify the number of devices
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify an integer value for the number of days after success of the first phase to begin the second phase. This parameter is the same as the following setting on the Settings page of the Create Phased Deployment wizard in the console: Automatically begin this phase after a deferral period (in days).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify the type of deadline period. Use this parameter with DeadlineValue.
Type: TimeUnitType
Parameter Sets: (All)
Aliases:
Accepted values: Hours, Days, Weeks, Months
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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 Settings page of the Create Phased Deployment wizard in the console: Installation is required after this period of time.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a description for the task sequence phased deployment.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection object for the first phase.
Type: IResultObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection ID for the first phase.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection name for the first phase.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This parameter processes wildcard characters and may lead to unexpected behavior. It's not recommended. You can't combine it with DisableWildcardHandling.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
If you use the AddPhases parameter, use this parameter to determine where in the order of phases to insert the additional phases. Specify an integer with the order number.
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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 Settings page of the Create Phased Deployment wizard in the console: Installation is required as soon as possible. -
AfterPeriod
: This parameter is the same as the following setting on the Settings page of the Create Phased Deployment 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.
Type: InstallationChoiceType
Parameter Sets: (All)
Aliases:
Accepted values: AsSoonAsPossible, AfterPeriod
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a name for the task sequence phased deployment.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection object for the second phase.
Type: IResultObject
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection ID for the second phase.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a collection name for the second phase.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a task sequence object.
Type: IResultObject
Parameter Sets: SearchByValueMandatory
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
Specify a task sequence by ID.
Type: String
Parameter Sets: SearchByIdMandatory
Aliases: TaskSequencePackageId
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Specify a task sequence by name.
Type: String
Parameter Sets: SearchByNameMandatory
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
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 Settings page of the Create Phased Deployment wizard in the console: Gradually make this software available over this period of time (in days).
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
Shows what would happen if the cmdlet runs. The cmdlet doesn't run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.