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>]
Description
此 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 類別。