Set-CMTaskSequenceDeployment

Creates a task sequence deployment in Configuration Manager.

Syntax

Set-CMTaskSequenceDeployment
   -InputObject <IResultObject>
   [-Comment <String>]
   [-SendWakeupPacket <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-MakeAvailableTo <MakeAvailableToType>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-DeploymentExpireDateTime <DateTime>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-Schedule <IResultObject[]>]
   [-RerunBehavior <RerunBehaviorType>]
   [-AllowUsersRunIndependently <Boolean>]
   [-ShowTaskSequenceProgress <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-SystemRestart <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-InternetOption <Boolean>]
   [-DeploymentOption <DeploymentOptionType>]
   [-AllowSharedContent <Boolean>]
   [-AllowFallback <Boolean>]
   [-CreateAlertOnSuccess <Boolean>]
   [-PercentSuccess <Int32>]
   [-AlertDateTime <DateTime>]
   [-CreateAlertOnFailure <Boolean>]
   [-PercentFailure <Int32>]
   [-PassThru]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTaskSequenceDeployment
   -TaskSequenceDeploymentId <String>
   [-Comment <String>]
   [-SendWakeupPacket <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-MakeAvailableTo <MakeAvailableToType>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-DeploymentExpireDateTime <DateTime>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-Schedule <IResultObject[]>]
   [-RerunBehavior <RerunBehaviorType>]
   [-AllowUsersRunIndependently <Boolean>]
   [-ShowTaskSequenceProgress <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-SystemRestart <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-InternetOption <Boolean>]
   [-DeploymentOption <DeploymentOptionType>]
   [-AllowSharedContent <Boolean>]
   [-AllowFallback <Boolean>]
   [-CreateAlertOnSuccess <Boolean>]
   [-PercentSuccess <Int32>]
   [-AlertDateTime <DateTime>]
   [-CreateAlertOnFailure <Boolean>]
   [-PercentFailure <Int32>]
   [-PassThru]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTaskSequenceDeployment
   -TaskSequenceName <String>
   [-Comment <String>]
   [-SendWakeupPacket <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-MakeAvailableTo <MakeAvailableToType>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-DeploymentExpireDateTime <DateTime>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-Schedule <IResultObject[]>]
   [-RerunBehavior <RerunBehaviorType>]
   [-AllowUsersRunIndependently <Boolean>]
   [-ShowTaskSequenceProgress <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-SystemRestart <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-InternetOption <Boolean>]
   [-DeploymentOption <DeploymentOptionType>]
   [-AllowSharedContent <Boolean>]
   [-AllowFallback <Boolean>]
   [-CreateAlertOnSuccess <Boolean>]
   [-PercentSuccess <Int32>]
   [-AlertDateTime <DateTime>]
   [-CreateAlertOnFailure <Boolean>]
   [-PercentFailure <Int32>]
   [-PassThru]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTaskSequenceDeployment
   -TaskSequencePackageId <String>
   [-Comment <String>]
   [-SendWakeupPacket <Boolean>]
   [-UseMeteredNetwork <Boolean>]
   [-MakeAvailableTo <MakeAvailableToType>]
   [-DeploymentAvailableDateTime <DateTime>]
   [-UseUtcForAvailableSchedule <Boolean>]
   [-DeploymentExpireDateTime <DateTime>]
   [-UseUtcForExpireSchedule <Boolean>]
   [-ScheduleEvent <ScheduleEventType[]>]
   [-Schedule <IResultObject[]>]
   [-RerunBehavior <RerunBehaviorType>]
   [-AllowUsersRunIndependently <Boolean>]
   [-ShowTaskSequenceProgress <Boolean>]
   [-SoftwareInstallation <Boolean>]
   [-SystemRestart <Boolean>]
   [-PersistOnWriteFilterDevice <Boolean>]
   [-InternetOption <Boolean>]
   [-DeploymentOption <DeploymentOptionType>]
   [-AllowSharedContent <Boolean>]
   [-AllowFallback <Boolean>]
   [-CreateAlertOnSuccess <Boolean>]
   [-PercentSuccess <Int32>]
   [-AlertDateTime <DateTime>]
   [-CreateAlertOnFailure <Boolean>]
   [-PercentFailure <Int32>]
   [-PassThru]
   [-CollectionName <String>]
   [-CollectionId <String>]
   [-Collection <IResultObject>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMTaskSequenceDeployment cmdlet creates a task sequence deployment. A task sequence deployment assigns a task sequence to a collection of computers.

Examples

Example 1: Create a task sequence deployment

PS C:\> Set-CMTaskSequenceDeployment -TaskSequenceName "Task Sequence 1333" -CollectionName "All Systems" -Comment "Task sequence test" -ShowTaskSequenceProgress $True

This command creates the task sequence deployment by using the task sequence name and collection name.

Example 2: Create a task sequence deployment with a task sequence name

PS C:\> Set-CMTaskSequenceDeployment -TaskSequenceName "Task Sequence 1333" -CollectionName "All Desktop and Server Clients" -Comment "Task sequence test" -SendWakeUpPacket $True -UseMeteredNetwork $True -DeploymentExpireDay 2014/12/30 -DeploymentExpireTime 15:52 -UseUtcForExpireSchedule $True -ScheduleEvent LogOff -RerunBehavior NeverRerunDeployedProgram -AllowUsersRunIndependently $True -ShowTaskSequenceProgress $False -SoftwareInstallation $True -SystemRestart $True -PersistOnWriteFilterDevice $False -InternetOption $True -DeploymentOption DownloadAllContentLocallyBeforeStartingTaskSequence -AllowFallback $True -AllowSharedContent $True -CreatAlertBaseOnPercentSuccess $True -CreatAlertBaseOnPercentFailure $True

This command creates the task sequence deployment by using the task sequence name and collection name.

Required Parameters

-InputObject

Specifies an task sequence deployment object. To obtain a task sequence object, use the Get-CMTaskSequenceDeployment cmdlet.

Type:IResultObject
Aliases:Deployment, DeploymentSummary, TaskSequence, Advertisement
Position:Named
Default value:None
Accept pipeline input:True (ByValue)
Accept wildcard characters:False
-TaskSequenceDeploymentId

Specifies an ID for a task sequence deployment.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TaskSequenceName

Specifies a name for a task sequence.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-TaskSequencePackageId

Specifies an ID for a task sequence package.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

Optional Parameters

-AlertDateTime
Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowFallback

Indicates whether to allow clients to use a fallback source location for content.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowSharedContent
Type:Boolean
Aliases:AllowUseRemoteDistributionPoint
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-AllowUsersRunIndependently

Indicates whether to allow users to independently run the program, regardless of its assignment status.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Collection
Type:IResultObject
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CollectionId
Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CollectionName

Specifies a name of a collection designated to receive a task sequence deployment. A collection is a group of client computers.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Comment

Specifies a comment for the task sequence deployment.

Type:String
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-CreateAlertOnFailure
Type:Boolean
Aliases:CreateAlertBaseOnPercentFailure
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-CreateAlertOnSuccess
Type:Boolean
Aliases:CreateAlertBaseOnPercentSuccess
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentAvailableDateTime
Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentExpireDateTime
Type:DateTime
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DeploymentOption

Specifies if clients download all content before starting the task sequence, or download content as needed by the running task sequence. By default, clients download content as needed. The acceptable values for this parameter are:

  • DownloadAllContentLocallyBeforeStartingTaskSequence
  • DownloadContentLocallyWhenNeededByRunningTaskSequence
Type:DeploymentOptionType
Parameter Sets:DownloadContentLocallyWhenNeededByRunningTaskSequence, DownloadAllContentLocallyBeforeStartingTaskSequence, RunFromDistributionPoint
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-DisableWildcardHandling

DisableWildcardHandling treats wildcard characters as literal character values. Cannot be combined with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ForceWildcardHandling

ForceWildcardHandling processes wildcard characters and may lead to unexpected behavior (not recommended). Cannot be combined with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-InternetOption

Indicates whether the task sequence runs on clients connecting over the Internet.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-MakeAvailableTo

Specifies whether to make this task sequence available to Configuration Manager clients, and whether to make it available when you deploy an operating system by using boot media, prestaged media, or PXE. The acceptable values for this parameter are:

  • Clients
  • ClientsMediaAndPxe
  • MediaAndPxe
  • MediaAndPxeHidden
Type:MakeAvailableToType
Parameter Sets:Clients, ClientsMediaAndPxe, MediaAndPxe, MediaAndPxeHidden
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PassThru

Returns the current working object. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PercentFailure

Specifies a threshold percentage for failed task sequence deployment.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PercentSuccess

Specifies a threshold percentage for successful task sequence deployment.

Type:Int32
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-PersistOnWriteFilterDevice

Indicates whether to install a task sequence on the temporary overlay and commit changes later, or commit the changes at an installation deadline or a maintenance window.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-RerunBehavior

Specifies that a task sequence will be rerun on a computer if it has previously been run before the scheduled mandatory time. By default, the task sequence is always rerun. The acceptable values for this parameter are:

  • AlwaysRerunProgram
  • NeverRerunDeployedProgram
  • RerunIfFailedPreviousAttempt
  • RerunIfSucceededOnPreviousAttempt
Type:RerunBehaviorType
Parameter Sets:NeverRerunDeployedProgram, AlwaysRerunProgram, RerunIfFailedPreviousAttempt, RerunIfSucceededOnPreviousAttempt
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-Schedule

Specifies an array of CMSchedule objects. A CMSchedule object defines the mandatory assignment schedule for a deployment. To create a CMSchedule object, use the New-CMSchedule cmdlet.

Type:IResultObject[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-ScheduleEvent

Specifies an array of events that determine when the task sequence deployment runs. The acceptable values for this parameter are:

  • AsSoonAsPossible
  • LogOff
  • LogOn
Type:ScheduleEventType[]
Parameter Sets:AsSoonAsPossible, LogOn, LogOff
Position:Named
Default value:None
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 does not wake computers from sleep. For computers to wake, you must first configure Wake On LAN.

Type:Boolean
Position:Named
Default value:None
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
Accept pipeline input:False
Accept wildcard characters:False
-SoftwareInstallation

Indicates whether to allow the application to install, even if the installation occurs outside of a maintenance window.

Type:Boolean
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
-SystemRestart

Indicates whether to allow an advertised program to restart the system, even if the restart occurs outside of a maintenance window.

Type:Boolean
Position:Named
Default value:None
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 additional costs.

Type:Boolean
Position:Named
Default value:None
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
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
Accept pipeline input:False
Accept wildcard characters:False
-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Accept pipeline input:False
Accept wildcard characters:False