Start-CMTaskSequenceDeployment
(Deprecated) Start a task sequence deployment.
Syntax
Start-CMTaskSequenceDeployment
[-AlertDateTime <DateTime>]
[-AlertDay <DateTime>]
[-AlertTime <DateTime>]
[-AllowFallback <Boolean>]
[-AllowSharedContent <Boolean>]
[-Availability <MakeAvailableToType>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-Comment <String>]
[-DeploymentAvailableDateTime <DateTime>]
[-DeploymentAvailableDay <DateTime>]
[-DeploymentAvailableTime <DateTime>]
[-DeploymentExpireDateTime <DateTime>]
[-DeploymentExpireDay <DateTime>]
[-DeploymentExpireTime <DateTime>]
[-DeploymentOption <DeploymentOptionType>]
[-DeployPurpose <DeployPurposeType>]
[-InputObject] <IResultObject>
[-InternetOption <Boolean>]
[-PassThru]
[-PercentFailure <Int32>]
[-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>]
[-RerunBehavior <RerunBehaviorType>]
[-RunFromSoftwareCenter <Boolean>]
[-Schedule <IResultObject[]>]
[-ScheduleEvent <ScheduleEventType[]>]
[-SendWakeupPacket <Boolean>]
[-ShowTaskSequenceProgress <Boolean>]
[-SoftwareInstallation <Boolean>]
[-SystemRestart <Boolean>]
[-UseMeteredNetwork <Boolean>]
[-UseUtcForAvailableSchedule <Boolean>]
[-UseUtcForExpireSchedule <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Start-CMTaskSequenceDeployment
[-AlertDateTime <DateTime>]
[-AlertDay <DateTime>]
[-AlertTime <DateTime>]
[-AllowFallback <Boolean>]
[-AllowSharedContent <Boolean>]
[-Availability <MakeAvailableToType>]
[-Collection <IResultObject>]
[-CollectionId <String>]
[-CollectionName <String>]
[-Comment <String>]
[-DeploymentAvailableDateTime <DateTime>]
[-DeploymentAvailableDay <DateTime>]
[-DeploymentAvailableTime <DateTime>]
[-DeploymentExpireDateTime <DateTime>]
[-DeploymentExpireDay <DateTime>]
[-DeploymentExpireTime <DateTime>]
[-DeploymentOption <DeploymentOptionType>]
[-DeployPurpose <DeployPurposeType>]
[-InternetOption <Boolean>]
[-PassThru]
[-PercentFailure <Int32>]
[-PercentSuccess <Int32>]
[-PersistOnWriteFilterDevice <Boolean>]
[-RerunBehavior <RerunBehaviorType>]
[-RunFromSoftwareCenter <Boolean>]
[-Schedule <IResultObject[]>]
[-ScheduleEvent <ScheduleEventType[]>]
[-SendWakeupPacket <Boolean>]
[-ShowTaskSequenceProgress <Boolean>]
[-SoftwareInstallation <Boolean>]
[-SystemRestart <Boolean>]
[-TaskSequencePackageId] <String>
[-UseMeteredNetwork <Boolean>]
[-UseUtcForAvailableSchedule <Boolean>]
[-UseUtcForExpireSchedule <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Important
This cmdlet is deprecated. Use New-CMTaskSequenceDeployment instead.
Use this cmdlet to start a task sequence deployment. A task sequence deployment assigns a task sequence to a collection of computers. For more information, see Deploy a task sequence in Configuration Manager.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>
. For more information, see getting started.
Examples
Example 1: Start a task sequence deployment with default options
This command starts a task sequence deployment by using the name of the task sequence deployment and the name of a collection.
Get-CMTaskSequence -Name "Upgrade Windows 10" | Start-CMTaskSequenceDeployment -CollectionName "Collection 01"
Example 2: Start a task sequence deployment with configured options
This command starts a task sequence deployment with several configured options.
Start-CMTaskSequenceDeployment -TaskSequencePackageId "XYZ00003" -CollectionName "Collection 02" -Comment "Task sequence test" -DeployPurpose Required -SendWakeUpPacket $True -UseMeteredNetwork $True -ScheduleEvent AsSoonAsPossible -RerunBehavior NeverRerunDeployedProgram -RunFromSoftwareCenter $True -ShowTaskSequenceProgress $False -SoftwareInstallation $True -SystemRestart $True -PersistOnWriteFilterDevice $False -AllowFallback $True -DeploymentOption DownloadAllContentLocallyBeforeStartingTaskSequence -AllowSharedContent $True -InternetOption $True
Parameters
-AlertDateTime
When you configure the deployment to create an alert for successful deployment, use this parameter to specify a DateTime object. Configuration Manager creates a deployment alert when the threshold is lower than the PercentSuccess after this date.
To get this object, use the Get-Date built-in cmdlet.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AlertDay
This parameter is deprecated. Use AlertDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AlertTime
This parameter is deprecated. Use AlertDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowFallback
Allow clients to use distribution points from the default site boundary group.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowSharedContent
Allow clients to use distribution points from a neighbor boundary group.
Type: | Boolean |
Aliases: | AllowUseRemoteDistributionPoint |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Availability
Specify whether to make this task sequence available to Configuration Manager clients, and whether it's available to run when you deploy an OS by using boot media, prestaged media, or PXE.
If you specify Clients
, the default value for the DeploymentOption parameter is DownloadAllContentLocallyBeforeStartingTaskSequence
.
If you specify ClientsMediaAndPxe
, MediaAndPxe
, or MediaAndPxeHidden
, the default value for the DeploymentOption parameter is DownloadContentLocallyWhenNeededByRunningTaskSequence
.
Type: | MakeAvailableToType |
Aliases: | MakeAvailableTo |
Accepted values: | Clients, ClientsMediaAndPxe, MediaAndPxe, MediaAndPxeHidden |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Collection
Specify a collection object to which this task sequence is deployed. To get this object, use the Get-CMCollection cmdlet.
Type: | IResultObject |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CollectionId
Specify the ID of the collection to which this task sequence is deployed.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-CollectionName
Specify the name of the collection to which this task sequence is deployed.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Comment
Specify an optional comment for the task sequence deployment.
Type: | String |
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: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentAvailableDateTime
Specify a DateTime object for when this deployment is available. To get this object, use the Get-Date built-in cmdlet.
Use DeploymentExpireDateTime to specify when the deployment expires, and Schedule to specify the deployment assignment, or deadline.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentAvailableDay
This parameter is deprecated. Use DeploymentAvailableDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentAvailableTime
This parameter is deprecated. Use DeploymentAvailableDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentExpireDateTime
Specify a DateTime object for when this deployment expires. To get this object, use the Get-Date built-in cmdlet.
Use DeploymentAvailableDateTime to specify when the deployment is available, and Schedule to specify the deployment assignment, or deadline.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentExpireDay
This parameter is deprecated. Use DeploymentExpireDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentExpireTime
This parameter is deprecated. Use DeploymentExpireDateTime.
Type: | DateTime |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeploymentOption
Specify how clients interact with the distribution points to get content for the task sequence. Not all options are available in specific scenarios. For more information, see Deploy a task sequence - Deployment options.
If you specify Clients
for the Availability parameter, the default value for this parameter is DownloadAllContentLocallyBeforeStartingTaskSequence
.
If you specify ClientsMediaAndPxe
, MediaAndPxe
, or MediaAndPxeHidden
for the Availability parameter, the default value for this parameter is DownloadContentLocallyWhenNeededByRunningTaskSequence
.
Type: | DeploymentOptionType |
Accepted values: | DownloadContentLocallyWhenNeededByRunningTaskSequence, DownloadAllContentLocallyBeforeStartingTaskSequence, RunFromDistributionPoint |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DeployPurpose
Specify whether this deployment is available for users to install, or it's required to install at the deadline.
Type: | DeployPurposeType |
Accepted values: | Available, Required |
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 |
-InputObject
Specify a task sequence deployment object. To get this object, use the Get-CMTaskSequenceDeployment cmdlet.
Type: | IResultObject |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InternetOption
Indicates whether the task sequence runs on clients connecting over the internet.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Add this parameter to return an object that represents 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 |
-PercentFailure
If you create an alert for failed deployments, the site generates an alert when the percentage of failed deployments is higher than this number.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PercentSuccess
If you create an alert for successful deployments, the site generates an alert when the percentage of successful deployments is lower than this number.
Type: | Int32 |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PersistOnWriteFilterDevice
Configure how the client handles the write filter on Windows Embedded devices.
$true
: Commit changes at the deadline or during a maintenance window. A restart is required.$false
: Apply content on the overlay and commit later.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RerunBehavior
Specify whether the task sequence reruns on a computer if it previously ran before the scheduled mandatory time. By default, the task sequence always reruns.
Type: | RerunBehaviorType |
Accepted values: | NeverRerunDeployedProgram, AlwaysRerunProgram, RerunIfFailedPreviousAttempt, RerunIfSucceededOnPreviousAttempt |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RunFromSoftwareCenter
Allow users to run the program independently of assignments.
Type: | Boolean |
Aliases: | AllowUsersRunIndependently |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Schedule
Use this parameter to specify the deployment assignment, or deadline.
Use AvailableDateTime to specify when the deployment is available, and DeadlineDateTime to specify when the deployment expires.
Specify an array of schedule objects. A schedule object defines the mandatory assignment schedule for a deployment. To create a schedule object, use the New-CMSchedule cmdlet.
Type: | IResultObject[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ScheduleEvent
Specifies an array of events that determine when the task sequence deployment runs.
Type: | ScheduleEventType[] |
Accepted values: | AsSoonAsPossible, LogOn, LogOff |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SendWakeupPacket
Indicates whether to send a wake-up packet to computers before the deployment begins. If this value is $True
, Configuration Manager wakes a computer from sleep. If this value is $False
, it doesn't wake computers from sleep. For computers to wake, first configure Wake On LAN.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ShowTaskSequenceProgress
Indicates whether to show a process dialog for a task sequence.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SoftwareInstallation
When the installation deadline is reached, set this parameter to $true
to allow the task sequence to install outside the maintenance window.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-SystemRestart
When the installation deadline is reached, set this parameter to $true
to allow system restart if necessary outside the maintenance window.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-TaskSequencePackageId
Specify the ID of the task sequence to deploy.
Type: | String |
Aliases: | PackageId |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseMeteredNetwork
Indicates whether to allow clients on a metered internet connection to download content after the installation deadline, which might incur extra costs.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseUtcForAvailableSchedule
Indicates whether client computers use UTC time to determine the availability of a program. UTC time makes the task sequence available at the same time for all computers.
Type: | Boolean |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-UseUtcForExpireSchedule
Indicates whether client computers use UTC time to determine the expiration of a program. UTC time makes the task sequence available at the same time for all computers.
Type: | Boolean |
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: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
IResultObject