Edit

Share via

Set-CMTSStepRestoreUserState

Module:
ConfigurationManager Module

Configure an instance of the Restore User State task sequence step.

Syntax

ByValue (Default) 

Set-CMTSStepRestoreUserState
    -InputObject <IResultObject>
    [-AddConfigFile <String[]>]
    [-CleanConfigFile]
    [-ContinueOnRestore <Boolean>]
    [-ModeOption <ModeType>]
    [-Package <IResultObject>]
    [-Password <SecureString>]
    [-RemoveConfigFile <String[]>]
    [-RestoreLocalAccount <Boolean>]
    [-VerboseLogging <Boolean>]
    [-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-CMTSStepRestoreUserState
    -TaskSequenceId <String>
    [-AddConfigFile <String[]>]
    [-CleanConfigFile]
    [-ContinueOnRestore <Boolean>]
    [-ModeOption <ModeType>]
    [-Package <IResultObject>]
    [-Password <SecureString>]
    [-RemoveConfigFile <String[]>]
    [-RestoreLocalAccount <Boolean>]
    [-VerboseLogging <Boolean>]
    [-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-CMTSStepRestoreUserState
    -TaskSequenceName <String>
    [-AddConfigFile <String[]>]
    [-CleanConfigFile]
    [-ContinueOnRestore <Boolean>]
    [-ModeOption <ModeType>]
    [-Package <IResultObject>]
    [-Password <SecureString>]
    [-RemoveConfigFile <String[]>]
    [-RestoreLocalAccount <Boolean>]
    [-VerboseLogging <Boolean>]
    [-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-CMTSStepRestoreUserState
    -TaskSequenceId <String>
    [-Condition <IResultObject[]>]
    [-SetConditionIfStatement]
    [-StatementType <ConditionStatementType>]
    [-StepName <String>]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

ByNameSetConditionIfStatement 

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

ByValueSetConditionIfStatement 

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

ByIdSetConditionVariable 

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

ByNameSetConditionVariable 

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

ByValueSetConditionVariable 

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

ByIdSetConditionFile 

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

ByNameSetConditionFile 

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

ByValueSetConditionFile 

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

ByIdSetConditionFolder 

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

ByNameSetConditionFolder 

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

ByValueSetConditionFolder 

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

ByValueSetConditionQueryWmi 

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

ByValueSetConditionOperatingSystem 

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

ByValueSetConditionRegistry 

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

ByValueSetConditionSoftware 

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

ByIdSetConditionSoftware 

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

ByNameSetConditionSoftware 

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

ByIdSetConditionQueryWmi 

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

ByNameSetConditionQueryWmi 

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

ByIdSetConditionRegistry 

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

ByNameSetConditionRegistry 

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

ByIdSetConditionOperatingSystem 

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

ByNameSetConditionOperatingSystem 

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

Description

Use this cmdlet to configure an instance of the Restore User State task sequence step.

For more information on this step, see About task sequence steps: Restore User State.

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 Restore User State step in the Default OS deployment task sequence to use custom restore with a configuration file.

$tsNameOsd = "Default OS deployment"
$tsStepNameRestoreState = "Restore User State"

Set-CMTSStepRestoreUserState -TaskSequenceName $tsNameOsd -StepName $tsStepNameRestoreState -ModeOption Customize -ConfigFiles "contoso.xml"

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

-AddConfigFile

When you specify -ModeOption Customize to customize how user profiles are restored, use this parameter to add file names of custom XML configuration files. These files need to be in the USMT package. Use this parameter to append to an existing list. To create a new list, use the ConfigFile parameter.

Parameter properties

Type:

String[]

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

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

-CleanConfigFile

Add this parameter to remove all of the file names for custom XML configuration files. To remove individual file names, use the RemoveConfigFile parameter.

Parameter properties

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

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

-ContinueOnRestore

Set this parameter to $true to continue restoring user state and settings even if USMT is unable to restore some files.

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

-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

-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

-InputObject

Specify a task sequence object from which to get the Restore User State step. 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

-ModeOption

There are two modes in which USMT can operate:

  • Standard: Restore all captured user profiles with standard options. This option is the default.

  • Customize: Customize how user profiles are restored. If you specify this option, use the ConfigFile parameter to specify the custom XML configuration files.

Parameter properties

Type:ModeType
Default value:None
Accepted values:Standard, Customize
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

-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

-Package

Specify an object for the USMT package. To get this object, use the Get-CMPackage cmdlet.

Parameter properties

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

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

-Password

If you enable the RestoreLocalAccount parameter, use this parameter to assign a new password to the restored local user accounts. USMT can't migrate the original passwords. Specify a secure string for the local account password.

Parameter properties

Type:SecureString
Default value:None
Supports wildcards:False
DontShow:False
Aliases:NewPasswordForLocalAccount

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

-RemoveConfigFile

Specify the file names of custom XML configuration files to remove from the list. To remove all configuration files, use the CleanConfigFile parameter.

Parameter properties

Type:

String[]

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

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

-RestoreLocalAccount

Set this parameter to $true to restore local computer user profiles. These profiles aren't for domain users. USMT can't migrate the original passwords. To assign new passwords to the restored local user accounts, use the Password parameter.

Parameter properties

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

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

-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

-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 from which to get the Restore User State step. 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

-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

-VerboseLogging

Set this parameter to $true to enable USMT verbose logging.

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

-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