New-CMTSStepRestoreUserState
创建可添加到任务序列的 “还原用户状态” 步骤。
语法
New-CMTSStepRestoreUserState
[-ConfigFile <String[]>]
[-ContinueOnRestore <Boolean>]
[-ModeOption <ModeType>]
-Package <IResultObject>
[-Password <SecureString>]
[-RestoreLocalAccount <Boolean>]
[-VerboseLogging <Boolean>]
[-Condition <IResultObject[]>]
[-ContinueOnError]
[-Description <String>]
[-Disable]
-Name <String>
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] 说明
此 cmdlet 将创建新的 “还原用户状态” 步骤对象。 然后使用 Add-CMTaskSequenceStep cmdlet 将步骤添加到任务序列。 有关此步骤的详细信息，请参阅 关于任务序列步骤：还原用户状态。
注意
从 Configuration Manager 站点驱动器运行 Configuration Manager cmdlet，例如 PS XYZ:\>。 有关详细信息，请参阅 入门。
示例
示例 1
此示例首先获取用户状态迁移工具 (USMT) 的包对象。 下一行为 “还原用户状态” 步骤创建对象，该步骤使用该 USMT 包并配置多个步骤设置。 然后，它获取任务序列对象，并将此新步骤添加到索引 11 处的任务序列。
$pkgUsmt = Get-CMPackage -Name "User State Migration Tool for Windows" -Fast
$step = New-CMTSStepRestoreUserState -Name "Restore User State" -Package $pkgUsmt -ModeOption Standard -VerboseLogging $true -ContinueOnRestore $true -RestoreLocalAccount $false
$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast
$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11参数
-Condition
指定要用于此步骤的条件对象。 若要获取此对象，请使用任务序列条件 cmdlet 之一。 例如 Get-CMTSStepConditionVariable。
| 类型: | IResultObject[] |
| 别名: | Conditions |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ConfigFile
指定 -ModeOption Customize 自定义用户配置文件的还原方式时，请使用此参数指定自定义 XML 配置文件的文件名。 这些文件需要位于 USMT 包中。
| 类型: | String[] |
| 别名: | ConfigFiles |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Confirm
提示你在运行 cmdlet 之前进行确认。
| 类型: | SwitchParameter |
| 别名: | cf |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ContinueOnError
添加此参数以启用步骤选项“ 出错时继续”。 启用此选项时，如果步骤失败，任务序列将继续。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ContinueOnRestore
将此参数设置为 $true 以继续还原用户状态和设置，即使 USMT 无法还原某些文件也是如此。
| 类型: | Boolean |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Description
为此任务序列步骤指定可选说明。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Disable
添加此参数以禁用此任务序列步骤。
| 类型: | SwitchParameter |
| 别名: | DisableThisStep |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-DisableWildcardHandling
此参数将通配符视为文本字符值。 不能将其与 ForceWildcardHandling 组合使用。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ForceWildcardHandling
此参数处理通配符，并可能导致意外行为， (不建议) 。 不能将其与 DisableWildcardHandling 组合使用。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ModeOption
USMT 可以运行两种模式：
Standard：使用标准选项还原所有捕获的用户配置文件。 此选项是默认选项。Customize：自定义用户配置文件的还原方式。 如果指定此选项，请使用 ConfigFile 参数指定自定义 XML 配置文件。
| 类型: | ModeType |
| 接受的值: | Standard, Customize |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Name
指定此步骤的名称，以便在任务序列中标识它。
| 类型: | String |
| 别名: | StepName |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-Package
为 USMT 包指定对象。 若要获取此对象，请使用 Get-CMPackage cmdlet。
| 类型: | IResultObject |
| 别名: | UserStateMigrationToolPackage |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-Password
如果启用 RestoreLocalAccount 参数，请使用此参数为还原的本地用户帐户分配新密码。 USMT 无法迁移原始密码。 为本地帐户密码指定安全字符串。
| 类型: | SecureString |
| 别名: | NewPasswordForLocalAccount |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-RestoreLocalAccount
将此参数设置为 以 $true 还原本地计算机用户配置文件。 这些配置文件不适用于域用户。 USMT 无法迁移原始密码。 若要将新密码分配给还原的本地用户帐户，请使用 Password 参数。
| 类型: | Boolean |
| 别名: | RestoreLocalComputerUserProfile |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-VerboseLogging
将此参数设置为 以 $true 启用 USMT 详细日志记录。
| 类型: | Boolean |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-WhatIf
显示在 cmdlet 运行时发生的情况。 cmdlet 不会运行。
| 类型: | SwitchParameter |
| 别名: | wi |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
None
输出
IResultObject
备注
有关此返回对象及其属性的详细信息，请参阅 SMS_TaskSequence_RestoreUserStateAction服务器 WMI 类。