Set-CMTSStepRestoreUserState

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

Syntax

Set-CMTSStepRestoreUserState
   [-AddConfigFile <String[]>]
   [-CleanConfigFile]
   [-ContinueOnRestore <Boolean>]
   [-ModeOption <ModeType>]
   [-Package <IResultObject>]
   [-Password <SecureString>]
   [-RemoveConfigFile <String[]>]
   [-RestoreLocalAccount <Boolean>]
   [-VerboseLogging <Boolean>]
   [-AddCondition <IResultObject[]>]
   [-ClearCondition]
   [-Description <String>]
   -InputObject <IResultObject>
   [-IsContinueOnError <Boolean>]
   [-IsEnabled <Boolean>]
   [-MoveToIndex <Int32>]
   [-NewStepName <String>]
   [-RemoveConditionFile]
   [-RemoveConditionFolder]
   [-RemoveConditionIfStatement]
   [-RemoveConditionOperatingSystem]
   [-RemoveConditionQueryWmi]
   [-RemoveConditionRegistry]
   [-RemoveConditionSoftware]
   [-RemoveConditionVariable]
   [-StepName <String>]
   [-StepOrder <ReorderType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-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>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-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>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-Condition <IResultObject[]>]
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-Condition <IResultObject[]>]
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-Condition <IResultObject[]>]
   -InputObject <IResultObject>
   [-SetConditionIfStatement]
   [-StatementType <ConditionStatementType>]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-ConditionVariableName <String>]
   [-ConditionVariableValue <String>]
   -InputObject <IResultObject>
   [-OperatorType <VariableOperatorType>]
   [-SetConditionVariable]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   [-SetConditionFile]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   [-SetConditionFile]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FileDateTimeOperator <VariableOperatorType>]
   [-FilePath <String>]
   [-FileTimestamp <DateTime>]
   [-FileVersion <String>]
   -InputObject <IResultObject>
   [-SetConditionFile]
   [-StepName <String>]
   [-VersionOperator <VariableOperatorType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   [-SetConditionFolder]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   [-SetConditionFolder]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-FolderDateTimeOperator <VariableOperatorType>]
   [-FolderPath <String>]
   [-FolderTimestamp <DateTime>]
   -InputObject <IResultObject>
   [-SetConditionFolder]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   -InputObject <IResultObject>
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   -InputObject <IResultObject>
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   -InputObject <IResultObject>
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   -InputObject <IResultObject>
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-IsAnyVersion <Boolean>]
   [-MsiFilePath <String>]
   [-SetConditionSoftware]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-Namespace <String[]>]
   [-Query <String>]
   [-SetConditionQueryWmi]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   -TaskSequenceId <String>
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-RegistryKey <String>]
   [-RegistryOperator <VariableOperatorType>]
   [-RegistryValueData <String>]
   [-RegistryValueName <String>]
   [-RootKey <RegistryRootKeyType>]
   [-SetConditionRegistry]
   [-StepName <String>]
   -TaskSequenceName <String>
   [-ValueType <RegistryValueType>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   -TaskSequenceId <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMTSStepRestoreUserState
   [-SetConditionOperatingSystem]
   [-StepName <String>]
   [-SupportedPlatform <IResultObject[]>]
   -TaskSequenceName <String>
   [-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.

Type:IResultObject[]
Aliases:AddConditions
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:String[]
Aliases:AddConfigFiles
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-ClearCondition

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

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

-Condition

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

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

-ConditionVariableName

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

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

-ConditionVariableValue

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

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

-Confirm

Prompts you for confirmation before running the cmdlet.

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

-ContinueOnRestore

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

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

-Description

Specify an optional description for this task sequence step.

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

-DisableWildcardHandling

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

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

-FileDateTimeOperator

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

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

-FilePath

Specify the path for a file condition.

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

-FileTimestamp

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

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

-FileVersion

Specify a version string for a file condition.

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

-FolderDateTimeOperator

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

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

-FolderPath

Specify the path for a folder condition.

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

-FolderTimestamp

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

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

-ForceWildcardHandling

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

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

-InputObject

Specify a task sequence object from which to get the Restore User State step. To get this object, use the Get-CMTaskSequence cmdlet.

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

-IsAnyVersion

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

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

-IsContinueOnError

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

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

-IsEnabled

Use this parameter to enable this task sequence step.

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

-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.

Type:ModeType
Accepted values:Standard, Customize
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-MoveToIndex

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

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

-MsiFilePath

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

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

-Namespace

Specify the namespace for a WMI query condition.

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

-NewStepName

Use this parameter to rename this task sequence step.

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

-OperatorType

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

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

-Package

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

Type:IResultObject
Aliases:UserStateMigrationToolPackage
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

Type:SecureString
Aliases:NewPasswordForLocalAccount
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Query

Specify a WMI query string to use for a condition.

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

-RegistryKey

Specify the key to use with a registry condition.

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

-RegistryOperator

Specify an operator to use with a registry condition.

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

-RegistryValueData

Specify the value data to use with a registry condition.

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

-RegistryValueName

Specify the value name to use with a registry condition.

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

-RemoveConditionFile

Use this parameter to remove a file condition.

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

-RemoveConditionFolder

Use this parameter to remove a folder condition.

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

-RemoveConditionIfStatement

Use this parameter to remove an if statement condition.

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

-RemoveConditionOperatingSystem

Use this parameter to remove an OS condition.

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

-RemoveConditionQueryWmi

Use this parameter to remove a WMI query condition.

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

-RemoveConditionRegistry

Use this parameter to remove a registry condition.

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

-RemoveConditionSoftware

Use this parameter to remove a software condition.

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

-RemoveConditionVariable

Use this parameter to remove a task sequence variable condition.

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

-RemoveConfigFile

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

Type:String[]
Aliases:RemoveConfigFiles
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters: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.

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

-RootKey

Specify the root key to use with a registry condition.

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

-SetConditionFile

Add a new file condition.

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

-SetConditionFolder

Add a new folder condition.

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

-SetConditionIfStatement

Add a new if statement condition.

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

-SetConditionOperatingSystem

Add a new OS condition.

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

-SetConditionQueryWmi

Add a new WMI query condition.

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

-SetConditionRegistry

Add a new registry condition.

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

-SetConditionSoftware

Add a new software condition.

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

-SetConditionVariable

Add a new task sequence variable condition.

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

-StatementType

Set the type for an if statement condition.

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

-StepName

Specify the name of the step to select for changes.

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

-StepOrder

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

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

-SupportedPlatform

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

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

-TaskSequenceId

Specify the package ID of the task sequence from which to get the Restore User State step. This value is a standard package ID, for example XYZ00858.

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

-TaskSequenceName

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

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

-ValueType

Specify the type of value for a registry condition.

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

-VerboseLogging

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

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

-VersionOperator

Specify an operator to use with a file condition.

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

-WhatIf

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

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object