Set-CMTaskSequence
Sets a Configuration Manager task sequence.
Syntax
Set-CMTaskSequence
[-AddSupportedOperatingSystemPlatform <IResultObject[]>]
[-BootImageId <String>]
[-Category <String>]
[-CustomText <String>]
[-DeploymentPackageId <String>]
[-Description <String>]
[-DisableTaskSequence <Boolean>]
[-EnableNotification <Boolean>]
[-EnableTaskSequence <Boolean>]
[-HighPerformance <Boolean>]
-InputObject <IResultObject>
[-MaxRunTimeMins <Int64>]
[-NewName <String>]
[-PassThru]
[-ProgramName <String>]
[-RemoveSupportedOperatingSystemPlatform <IResultObject[]>]
[-RunAnotherProgram <Boolean>]
[-RunEveryTime <Boolean>]
[-RunOnAnyPlatform]
[-SuppressNotification <Boolean>]
[-UseBootImage <Boolean>]
[-UseDefaultText <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMTaskSequence
[-AddSupportedOperatingSystemPlatform <IResultObject[]>]
[-BootImageId <String>]
[-Category <String>]
[-CustomText <String>]
[-DeploymentPackageId <String>]
[-Description <String>]
[-DisableTaskSequence <Boolean>]
[-EnableNotification <Boolean>]
[-EnableTaskSequence <Boolean>]
[-HighPerformance <Boolean>]
[-MaxRunTimeMins <Int64>]
[-NewName <String>]
[-PassThru]
[-ProgramName <String>]
[-RemoveSupportedOperatingSystemPlatform <IResultObject[]>]
[-RunAnotherProgram <Boolean>]
[-RunEveryTime <Boolean>]
[-RunOnAnyPlatform]
[-SuppressNotification <Boolean>]
-TaskSequenceId <String>
[-UseBootImage <Boolean>]
[-UseDefaultText <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-CMTaskSequence
[-AddSupportedOperatingSystemPlatform <IResultObject[]>]
[-BootImageId <String>]
[-Category <String>]
[-CustomText <String>]
[-DeploymentPackageId <String>]
[-Description <String>]
[-DisableTaskSequence <Boolean>]
[-EnableNotification <Boolean>]
[-EnableTaskSequence <Boolean>]
[-HighPerformance <Boolean>]
[-MaxRunTimeMins <Int64>]
[-NewName <String>]
[-PassThru]
[-ProgramName <String>]
[-RemoveSupportedOperatingSystemPlatform <IResultObject[]>]
[-RunAnotherProgram <Boolean>]
[-RunEveryTime <Boolean>]
[-RunOnAnyPlatform]
[-SuppressNotification <Boolean>]
-TaskSequenceName <String>
[-UseBootImage <Boolean>]
[-UseDefaultText <Boolean>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-CMTaskSequence cmdlet modifies a Configuration Manager task sequence.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Get a task sequence and change its name
PS XYZ:\> $TaskSequence = Get-CMTaskSequence -Name "TaskSequence01"
PS XYZ:\> Set-CMTaskSequence -InputObject $TaskSequence -NewName "NewTS01"The first command gets the task sequence object named TaskSequence01 and stores the object in the $TaskSequence variable.
The second command changes the name of the task sequence stored in $TaskSequence to NewTS01.
Example 2: Pass a task sequence and change its name
PS XYZ:\> Get-CMTaskSequence -Name "TaskSequence02" | Set-CMTaskSequence -NewName "NewTS02"This command gets the task sequence object named TaskSequence02 and uses the pipeline operator to pass the object to Set-CMTaskSequence, which changes the name of the task sequence object to NewTS02.
Parameters
-AddSupportedOperatingSystemPlatform
Adds a supported operating system platform object to the task sequence. To obtain a supported operating system platform object, use the Get-CMSupportedPlatform cmdlet.
| Type: | IResultObject[] |
| Aliases: | AddSupportedOperatingSystemPlatforms |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BootImageId
Specifies the ID of a boot image.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Category
Specifies a category for the task sequence. You can use categories to group task sequences.
| 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 |
-CustomText
Specifies custom text for the task sequence. Custom text appears in the progress notification dialog box while the task sequence runs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeploymentPackageId
Specifies the ID of a package. If you specify a value of $True for the RunAnotherProgram parameter, the specified package runs before the task sequence runs.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Description
Specifies a description for the task sequence.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableTaskSequence
Indicates whether to disable this task sequence.
| Type: | Boolean |
| 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 |
-EnableNotification
Indicates whether to enable notifications for this task sequence.
| Type: | Boolean |
| Aliases: | EnableNotifications |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-EnableTaskSequence
Indicates whether to enable this task sequence.
| Type: | Boolean |
| 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 |
-HighPerformance
Use this parameter to set the following option on the Performance page of the task sequence properties: Run as high performance power plan.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies a task sequence object. To obtain a task sequence object, use the Get-CMTaskSequence cmdlet.
| Type: | IResultObject |
| Aliases: | TaskSequence |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-MaxRunTimeMins
Specifies, in minutes, the maximum running time for the task sequence.
| Type: | Int64 |
| Aliases: | Duration |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NewName
Specifies a new name for the task sequence.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProgramName
Specifies the name of a program to run from a Configuration Manager software package specified by the DeploymentPackageId parameter.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoveSupportedOperatingSystemPlatform
Removes a supported operating system platform object from the task sequence. To obtain a supported operating system platform object, use the Get-CMSupportedPlatform cmdlet.
| Type: | IResultObject[] |
| Aliases: | RemoveSupportedOperatingSystemPlatforms |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunAnotherProgram
Indicates whether to run another program before running the task sequence. Specify the program by using the DeploymentPackageId parameter and the ProgramName parameter.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunEveryTime
Indicates whether the program specified in the ProgramName parameter runs every time that the task sequence runs. If you specify a value of $False, the program does not run if it has run successfully in the past.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RunOnAnyPlatform
Indicates that the task sequence runs on any operating system platform.
| Type: | SwitchParameter |
| Aliases: | ClearSupportedOperatingSystemPlatforms |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SuppressNotification
Indicates whether to suppress notifications for this task sequence.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TaskSequenceId
Specifies the ID of a task sequence.
| Type: | String |
| Aliases: | Id, TaskSequencePackageId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TaskSequenceName
Specifies the name of a task sequence.
| Type: | String |
| Aliases: | Name |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseBootImage
Indicates whether the task sequence uses the boot image specified by using the BootImageID parameter.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultText
Indicates whether to use default text in the progress notification dialog box while the task sequence runs. If you select a value of $False for this parameter, be sure to specify custom text by using the CustomText parameter.
| 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 is not 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
System.Object
Related Links
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for