New-CMTSStepCaptureUserState

建立可讓您新增至任務順序的「 捕獲使用者狀態 」步驟。

Syntax

New-CMTSStepCaptureUserState
   [-ConfigFile <String[]>]
   [-ContinueOnLockedFile <Boolean>]
   [-FileAccessOption <FileAccessType>]
   [-ModeOption <ModeType>]
   [-OfflineUserState <Boolean>]
   -Package <IResultObject>
   [-SkipEncryptedFile <Boolean>]
   [-UseHardLinks <Boolean>]
   [-VerboseLogging <Boolean>]
   [-Condition <IResultObject[]>]
   [-ContinueOnError]
   [-Description <String>]
   [-Disable]
   -Name <String>
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

此 Cmdlet 會建立新的 Capture User State step 物件。 然後使用 CMTaskSequenceStep Cmdlet,將步驟新增至任務順序。 如需此步驟的詳細資訊,請參閱 關於任務順序的步驟:捕獲使用者狀態

注意

從 Configuration Manager 網站磁碟機執行 Configuration Manager Cmdlet,例如 PS XYZ:\> 。 如需詳細資訊,請參閱 快速入門。

範例

範例 1

這個範例會先取得使用者狀態遷移工具 (USMT) 的 package 物件。 下一行會為 Capture User State 步驟建立一個物件,該物件會使用該 USMT 套件,並設定數個步驟設定。 然後,它會取得任務順序物件,並將此新步驟加入至索引11的任務順序。

$pkgUsmt = Get-CMPackage -Name "User State Migration Tool for Windows" -Fast

$step = New-CMTSStepCaptureUserState -Name "Capture User State" -Package $pkgUsmt -ModeOption Standard -VerboseLogging $true -FileAccessOption Normal -ContinueOnLockedFile $true -UseHardLinks $true

$tsNameOsd = "Default OS deployment"
$tsOsd = Get-CMTaskSequence -Name $tsNameOsd -Fast

$tsOsd | Add-CMTaskSequenceStep -Step $step -InsertStepStartIndex 11

參數

-Confirm

執行 Cmdlet 之前提示您確認。

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

-ContinueOnError

新增此參數以啟用 [步驟] 選項 [ 在錯誤時繼續] 選項。 當您啟用此選項時,任務順序會繼續執行。

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

-ContinueOnLockedFile

如果您指定 -FileAccessOption Normal 此參數,請將此參數設定為,以 $true 允許 USMT 繼續,如果無法捕獲某些檔案。

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

-Description

指定此任務順序步驟的選用描述。

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

-DisableWildcardHandling

此參數會將萬用字元視為常值字元值。 您無法將它與 ForceWildcardHandling合併。

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

-FileAccessOption

USMT 如何存取檔案系統有兩個選項:

  • Normal: USMT 使用標準檔案系統存取。 當您指定此選項時,您也可以啟用 ContinueOnLockedFileOfflineUserState-

  • VolumeCopyShadowService: USMT 使用大量副本陰影服務 (VSS) 。

Type:FileAccessType
Accepted values:Normal, VolumeCopyShadowService
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

這個參數會處理萬用字元,而且可能會造成未預期的行為 (不建議) 。 您無法將它與 DisableWildcardHandling合併。

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

-ModeOption

有兩種模式可供 USMT 運作:

  • Standard:使用標準選項來捕獲所有使用者設定檔。 預設值為此選項。

  • Customize:自訂如何捕獲使用者設定檔。 如果您指定此選項,請使用 read-configfile 參數來指定自訂的 XML 設定檔。

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

-OfflineUserState

當您指定時 -FileAccessOption Normal ,請將此參數設定為 $true 在 Windows PE 中以離線模式捕獲。

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

-Read-configfile

當您指定 -ModeOption Customize 自訂如何捕獲使用者設定檔時,請使用此參數指定自訂 XML 設定檔的檔案名。 這些檔案必須位於 USMT 套件中。

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

-SkipEncryptedFile

將此參數設定為 $true 以略過使用加密檔案系統 (EFS) 的檔案。

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

-UseHardLinks

指定時 -FileAccessOption Normal ,請將此參數設定為 $true 使用 NTFS 硬連結在本機上捕獲。

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

-VerboseLogging

將此參數設定為 $true 以啟用 USMT 詳細記錄。

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

-WhatIf

顯示執行 Cmdlet 時會發生什麼情況。 不會執行 Cmdlet。

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

-停用

新增此參數以停用此任務序列步驟。

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

-名稱

指定此步驟的名稱,以在任務順序中識別。

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

-封裝

指定 USMT 套件的物件。 若要取得此物件,請使用 CMPackage Cmdlet。

Type:IResultObject
Aliases:UserStateMigrationToolPackage
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-條件

指定要與此步驟搭配使用的 condition 物件。 若要取得此物件,請使用其中一個工作順序條件 Cmdlet。 例如, CMTSStepConditionVariable

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

輸入

輸出

IResultObject

備註

如需此 return 物件及其屬性的詳細資訊,請參閱 SMS_TaskSequence_CaptureUserStateAction SERVER WMI 類別