Set-CMTSStepUpgradeOperatingSystem

Module:

ConfigurationManager

Configure an instance of the Upgrade OS task sequence step.

Syntax

Set-CMTSStepUpgradeOperatingSystem
   [-DriverPackage <IResultObject>]
   [-DynamicUpdateSetting <DynamicUpdateOption>]
   [-EditionIndex <Int32>]
   [-IgnoreMessage <Boolean>]
   [-ProductKey <String>]
   [-ScanOnly <Boolean>]
   [-SetupTimeout <Int32>]
   [-SourcePath <String>]
   [-StagedContent <String>]
   [-UpgradePackage <IResultObject>]
   [-SoftwareUpdate <IResultObject[]>]
   [-AddCondition <IResultObject[]>]
   [-ClearCondition]
   [-Description <String>]
   -InputObject <IResultObject>
   [-IsContinueOnError <Boolean>]
   [-IsEnabled <Boolean>]
   [-MoveToIndex <Int32>]
   [-NewStepName <String>]
   [-RemoveConditionFile]
   [-RemoveConditionFolder]
   [-RemoveConditionIfStatement]
   [-RemoveConditionOperatingSystem]
   [-RemoveConditionQueryWmi]
   [-RemoveConditionRegistry]
   [-RemoveConditionSoftware]
   [-RemoveConditionVariable]
   [-StepName <String>]
   [-StepOrder <ReorderType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-DriverPackage <IResultObject>]
   [-DynamicUpdateSetting <DynamicUpdateOption>]
   [-EditionIndex <Int32>]
   [-IgnoreMessage <Boolean>]
   [-ProductKey <String>]
   [-ScanOnly <Boolean>]
   [-SetupTimeout <Int32>]
   [-SourcePath <String>]
   [-StagedContent <String>]
   [-UpgradePackage <IResultObject>]
   [-SoftwareUpdate <IResultObject[]>]
   [-AddCondition <IResultObject[]>]
   [-ClearCondition]
   [-Description <String>]
   [-IsContinueOnError <Boolean>]
   [-IsEnabled <Boolean>]
   [-MoveToIndex <Int32>]
   [-NewStepName <String>]
   [-RemoveConditionFile]
   [-RemoveConditionFolder]
   [-RemoveConditionIfStatement]
   [-RemoveConditionOperatingSystem]
   [-RemoveConditionQueryWmi]
   [-RemoveConditionRegistry]
   [-RemoveConditionSoftware]
   [-RemoveConditionVariable]
   [-StepName <String>]
   [-StepOrder <ReorderType>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-DriverPackage <IResultObject>]
   [-DynamicUpdateSetting <DynamicUpdateOption>]
   [-EditionIndex <Int32>]
   [-IgnoreMessage <Boolean>]
   [-ProductKey <String>]
   [-ScanOnly <Boolean>]
   [-SetupTimeout <Int32>]
   [-SourcePath <String>]
   [-StagedContent <String>]
   [-UpgradePackage <IResultObject>]
   [-SoftwareUpdate <IResultObject[]>]
   [-AddCondition <IResultObject[]>]
   [-ClearCondition]
   [-Description <String>]
   [-IsContinueOnError <Boolean>]
   [-IsEnabled <Boolean>]
   [-MoveToIndex <Int32>]
   [-NewStepName <String>]
   [-RemoveConditionFile]
   [-RemoveConditionFolder]
   [-RemoveConditionIfStatement]
   [-RemoveConditionOperatingSystem]
   [-RemoveConditionQueryWmi]
   [-RemoveConditionRegistry]
   [-RemoveConditionSoftware]
   [-RemoveConditionVariable]
   [-StepName <String>]
   [-StepOrder <ReorderType>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-Condition <IResultObject[]>]
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-Condition <IResultObject[]>]
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-Condition <IResultObject[]>]
   -InputObject <IResultObject>
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   -InputObject <IResultObject>
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   [-SetConditionFile]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   [-SetConditionFile]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   -InputObject <IResultObject>
   [-SetConditionFile]
   [-StepName <String>]
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   [-SetConditionFolder]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   [-SetConditionFolder]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   -InputObject <IResultObject>
   [-SetConditionFolder]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   -InputObject <IResultObject>
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   -InputObject <IResultObject>
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   -InputObject <IResultObject>
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   -InputObject <IResultObject>
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-CMTSStepUpgradeOperatingSystem
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Use this cmdlet to configure an instance of the Upgrade OS task sequence step.

For more information on this step, see About task sequence steps: Upgrade OS.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1

This example changes the Upgrade OS step in the Default OS upgrade task sequence to use a feature update.

$tsNameUpg = "Default OS upgrade"
$tsStepNameUpgradeOs = "Upgrade Operating System"

$update = Get-CMSoftwareUpdate -Name "Feature update to Windows 10 (business editions), version 20H2, en-us x64"

Set-CMTSStepUpgradeOperatingSystem -TaskSequenceName $tsNameUpg -StepName $tsStepNameUpgradeOs -SoftwareUpdate $update

Parameters

-AddCondition

Specify a condition object to add to this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Type:	IResultObject[]
Aliases:	AddConditions
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ClearCondition

Remove a condition from this step. Use the -Condition parameter to specify the condition to remove.

Type:	SwitchParameter
Aliases:	ClearConditions
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Condition

Specify a condition object to use with this step. To get this object, use one of the task sequence condition cmdlets. For example, Get-CMTSStepConditionVariable.

Type:	IResultObject[]
Aliases:	SubCondition, SubConditions
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ConditionVariableName

Specify the name of the task sequence variable to use as a condition.

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

-ConditionVariableValue

Specify the value of the task sequence variable to use in a condition.

Type:	String
Aliases:	Value
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

Specify an optional description for this task sequence step.

Type:	String
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

-DriverPackage

Specify a driver package object to provide its driver content to Windows Setup during upgrade. To get this package, use the Get-CMDriverPackage cmdlet.

Use the StagedContent parameter to specify the location for the driver content.

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

-DynamicUpdateSetting

Use this parameter to dynamically update Windows Setup with Windows Update.

• DisablePolicy: Don't use Dynamic Update
• UsingPolicy: Enable setup to use Dynamic Update, such as search, download, and install updates.
• OverridePolicy: Temporarily override the local policy in real time to run Dynamic Update operations. The computer gets updates from Windows Update.

Type:	DynamicUpdateOption
Accepted values:	DisablePolicy, UsingPolicy, OverridePolicy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-EditionIndex

Specify an integer value of the OS upgrade package edition. Use this parameter with the UpgradePackage parameter.

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

-FileDateTimeOperator

Specify a variable operator type for a file date/time condition.

Type:	VariableOperatorType
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FilePath

Specify the path for a file condition.

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

-FileTimestamp

Specify a date/time value to use for a file condition.

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

-FileVersion

Specify a version string for a file condition.

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

-FolderDateTimeOperator

Specify a variable operator for a folder date/time condition.

Type:	VariableOperatorType
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-FolderPath

Specify the path for a folder condition.

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

-FolderTimestamp

Specify a date/time value to use for a folder condition.

Type:	DateTime
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

-IgnoreMessage

Set this parameter to $true to specify that Windows Setup completes the installation, ignoring any dismissible compatibility messages.

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

-InputObject

Specify a task sequence object that has the Upgrade OS step to configure. To get this 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

-IsAnyVersion

Use this parameter with the SetConditionSoftware parameter to match any version of the product.

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

-IsContinueOnError

Use this parameter to enable the step option Continue on error. When you enable this option, if the step fails, the task sequence continues.

Type:	Boolean
Aliases:	IsThisStepContinueOnError
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IsEnabled

Use this parameter to enable this task sequence step.

Type:	Boolean
Aliases:	IsThisStepEnabled
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MoveToIndex

Move this step to the specified index position in the task sequence.

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

-MsiFilePath

Specify the path to a Windows Installer file for a software condition.

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

-Namespace

Specify the namespace for a WMI query condition.

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

-NewStepName

Use this parameter to rename this task sequence step.

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

-OperatorType

Specify an operator to use with a task sequence variable condition.

Type:	VariableOperatorType
Accepted values:	Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual, Like, NotLike
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProductKey

Specify the product key to apply to the upgrade process.

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

-Query

Specify a WMI query string to use for a condition.

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

-RegistryKey

Specify the key to use with a registry condition.

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

-RegistryOperator

Specify an operator to use with a registry condition.

Type:	VariableOperatorType
Accepted values:	Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RegistryValueData

Specify the value data to use with a registry condition.

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

-RegistryValueName

Specify the value name to use with a registry condition.

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

-RemoveConditionFile

Use this parameter to remove a file condition.

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

-RemoveConditionFolder

Use this parameter to remove a folder condition.

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

-RemoveConditionIfStatement

Use this parameter to remove an if statement condition.

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

-RemoveConditionOperatingSystem

Use this parameter to remove an OS condition.

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

-RemoveConditionQueryWmi

Use this parameter to remove a WMI query condition.

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

-RemoveConditionRegistry

Use this parameter to remove a registry condition.

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

-RemoveConditionSoftware

Use this parameter to remove a software condition.

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

-RemoveConditionVariable

Use this parameter to remove a task sequence variable condition.

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

-RootKey

Specify the root key to use with a registry condition.

Type:	RegistryRootKeyType
Accepted values:	HKeyCurrentUser, HKeyLocalMachine, HKeyUsers, HKeyCurrentConfig
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ScanOnly

Set this parameter to $true to run the Windows Setup compatibility scan without starting upgrade.

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

-SetConditionFile

Add a new file condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionFolder

Add a new folder condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionIfStatement

Add a new if statement condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionOperatingSystem

Add a new OS condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionQueryWmi

Add a new WMI query condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionRegistry

Add a new registry condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionSoftware

Add a new software condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetConditionVariable

Add a new task sequence variable condition.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SetupTimeout

Specify the number of minutes before Configuration Manager fails this step. This option is useful if Windows Setup stops processing but doesn't terminate.

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

-SoftwareUpdate

Starting in version 2107, specify a software update object to upgrade a client's Windows OS by using a feature update. To get this object, use the Get-CMSoftwareUpdate cmdlet.

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

-SourcePath

Specify a local or network path to the Windows media that Windows Setup uses.

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

-StagedContent

Use this parameter with DriverPackage to specify the location for the driver content. You can specify a local folder, network path, or a task sequence variable.

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

-StatementType

Set the type for an if statement condition.

Type:	ConditionStatementType
Aliases:	Operator
Accepted values:	All, Any, None
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StepName

Specify the name of the step to select for changes.

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

-StepOrder

Use this parameter to reorder the step in the task sequence.

Type:	ReorderType
Accepted values:	MoveUp, MoveDown, MoveToIndex
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SupportedPlatform

Use this parameter to specify the platforms for an OS condition.

Type:	IResultObject[]
Aliases:	SupportedPlatforms
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TaskSequenceId

Specify the package ID of the task sequence with the Upgrade OS step to configure. This value is a standard package ID, for example XYZ00858.

Type:	String
Aliases:	Id, TaskSequencePackageId
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-TaskSequenceName

Specify the name of the task sequence to target for changes.

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

-UpgradePackage

Specify an OS upgrade package object. Use the EditionIndex parameter to set the edition.

To get this object, use the Get-CMOperatingSystemInstaller cmdlet.

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

-ValueType

Specify the type of value for a registry condition.

Type:	RegistryValueType
Accepted values:	RegistrySZ, RegistryExpandSZ, RegistryDWord
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VersionOperator

Specify an operator to use with a file condition.

Type:	VariableOperatorType
Accepted values:	Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
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:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object

Related Links

• Get-CMTSStepUpgradeOperatingSystem
• New-CMTSStepUpgradeOperatingSystem
• Remove-CMTSStepUpgradeOperatingSystem
• About task sequence steps: Upgrade OS