Edit

Share via

Set-CMTSStepUpgradeOperatingSystem

Module:
ConfigurationManager Module

Configure an instance of the Upgrade OS task sequence step.

Syntax

ByValue (Default) 

Set-CMTSStepUpgradeOperatingSystem
    -InputObject <IResultObject>
    [-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>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ById 

Set-CMTSStepUpgradeOperatingSystem
    -TaskSequenceId <String>
    [-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>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByName 

Set-CMTSStepUpgradeOperatingSystem
    -TaskSequenceName <String>
    [-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>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByIdSetConditionIfStatement 

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

ByNameSetConditionIfStatement 

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

ByValueSetConditionIfStatement 

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

ByIdSetConditionVariable 

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

ByNameSetConditionVariable 

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

ByValueSetConditionVariable 

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

ByIdSetConditionFile 

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

ByNameSetConditionFile 

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

ByValueSetConditionFile 

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

ByIdSetConditionFolder 

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

ByNameSetConditionFolder 

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

ByValueSetConditionFolder 

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

ByValueSetConditionQueryWmi 

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

ByValueSetConditionOperatingSystem 

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

ByValueSetConditionRegistry 

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

ByValueSetConditionSoftware 

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

ByIdSetConditionSoftware 

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

ByNameSetConditionSoftware 

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

ByIdSetConditionQueryWmi 

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

ByNameSetConditionQueryWmi 

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

ByIdSetConditionRegistry 

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

ByNameSetConditionRegistry 

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

ByIdSetConditionOperatingSystem 

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

ByNameSetConditionOperatingSystem 

Set-CMTSStepUpgradeOperatingSystem
    -TaskSequenceName <String>
    [-SetConditionOperatingSystem]
    [-StepName <String>]
    [-SupportedPlatform <IResultObject[]>]
    [-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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:AddConditions

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ClearCondition

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ClearConditions

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SubCondition, SubConditions

Parameter sets

ByIdSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConditionVariableName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Variable

Parameter sets

ByIdSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ConditionVariableValue

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Value

Parameter sets

ByIdSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Description

Specify an optional description for this task sequence step.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:DynamicUpdateOption
Default value:None
Accepted values:DisablePolicy, UsingPolicy, OverridePolicy
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EditionIndex

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FileDateTimeOperator

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

Parameter properties

Type:VariableOperatorType
Default value:None
Accepted values:Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FilePath

Specify the path for a file condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FileTimestamp

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

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FileVersion

Specify a version string for a file condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FolderDateTimeOperator

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

Parameter properties

Type:VariableOperatorType
Default value:None
Accepted values:Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FolderPath

Specify the path for a folder condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-FolderTimestamp

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

Parameter properties

Type:DateTime
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFolder
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IgnoreMessage

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Specify a task sequence object that has the Upgrade OS step to configure. To get this object, use the Get-CMTaskSequence cmdlet.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:TaskSequence

Parameter sets

ByValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-IsAnyVersion

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IsThisStepContinueOnError

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-IsEnabled

Use this parameter to enable this task sequence step.

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:IsThisStepEnabled

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MoveToIndex

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-MsiFilePath

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionSoftware
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Namespace

Specify the namespace for a WMI query condition.

Parameter properties

Type:

String[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-NewStepName

Use this parameter to rename this task sequence step.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-OperatorType

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

Parameter properties

Type:VariableOperatorType
Default value:None
Accepted values:Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual, Like, NotLike
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionVariable
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ProductKey

Specify the product key to apply to the upgrade process.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Query

Specify a WMI query string to use for a condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionQueryWmi
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RegistryKey

Specify the key to use with a registry condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RegistryOperator

Specify an operator to use with a registry condition.

Parameter properties

Type:VariableOperatorType
Default value:None
Accepted values:Exists, NotExists, Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RegistryValueData

Specify the value data to use with a registry condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RegistryValueName

Specify the value name to use with a registry condition.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionFile

Use this parameter to remove a file condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionFolder

Use this parameter to remove a folder condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionIfStatement

Use this parameter to remove an if statement condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionOperatingSystem

Use this parameter to remove an OS condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionQueryWmi

Use this parameter to remove a WMI query condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionRegistry

Use this parameter to remove a registry condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionSoftware

Use this parameter to remove a software condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RemoveConditionVariable

Use this parameter to remove a task sequence variable condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-RootKey

Specify the root key to use with a registry condition.

Parameter properties

Type:RegistryRootKeyType
Default value:None
Accepted values:HKeyCurrentUser, HKeyLocalMachine, HKeyUsers, HKeyCurrentConfig
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ScanOnly

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionFile

Add a new file condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionFolder

Add a new folder condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionIfStatement

Add a new if statement condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionOperatingSystem

Add a new OS condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionQueryWmi

Add a new WMI query condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionRegistry

Add a new registry condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionSoftware

Add a new software condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SetConditionVariable

Add a new task sequence variable condition.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SourcePath

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StatementType

Set the type for an if statement condition.

Parameter properties

Type:ConditionStatementType
Default value:None
Accepted values:All, Any, None
Supports wildcards:False
DontShow:False
Aliases:Operator

Parameter sets

ByIdSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionIfStatement
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StepName

Specify the name of the step to select for changes.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-StepOrder

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

Parameter properties

Type:ReorderType
Default value:None
Accepted values:MoveUp, MoveDown, MoveToIndex
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SupportedPlatform

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

Parameter properties

Type:

IResultObject[]

Default value:None
Supports wildcards:False
DontShow:False
Aliases:SupportedPlatforms

Parameter sets

ByValueSetConditionOperatingSystem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionOperatingSystem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionOperatingSystem
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:Id, TaskSequencePackageId

Parameter sets

ById
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-TaskSequenceName

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionIfStatement
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionVariable
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFolder
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionSoftware
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionQueryWmi
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionOperatingSystem
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments: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.

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

ByValue
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ById
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByName
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ValueType

Specify the type of value for a registry condition.

Parameter properties

Type:RegistryValueType
Default value:None
Accepted values:RegistrySZ, RegistryExpandSZ, RegistryDWord
Supports wildcards:False
DontShow:False

Parameter sets

ByValueSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByIdSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionRegistry
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-VersionOperator

Specify an operator to use with a file condition.

Parameter properties

Type:VariableOperatorType
Default value:None
Accepted values:Equals, NotEquals, Greater, GreaterEqual, Less, LessEqual
Supports wildcards:False
DontShow:False

Parameter sets

ByIdSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByNameSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False
ByValueSetConditionFile
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object