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

説明

このコマンドレットは、新しいユーザー状態 の復元手順オブジェクトを 作成します。 次に 、Add-CMTaskSequenceStep コマンドレットを使用して、手順をタスク シーケンスに追加します。 この手順の詳細については、「タスク シーケンスの手順 について:ユーザー状態の復元」を参照してください

注意

Configuration Manager サイト ドライブから Configuration Manager コマンドレットを実行します PS XYZ:\> 。 詳細については 、「Getting started」を参照してください

例 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

この手順で使用する条件オブジェクトを指定します。 このオブジェクトを取得するには、タスク シーケンス条件コマンドレットのいずれかを使用します。 たとえば 、Get-CMTSStepConditionVariable です

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

ユーザー プロファイルの復元方法をカスタマイズする場合は、このパラメーターを使用してカスタム XML 構成ファイルのファイル名 -ModeOption Customize を指定します。 これらのファイルは USMT パッケージ内にある必要があります。

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

コマンドレットを実行する前に確認メッセージを表示します。

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

USMT が一部のファイルを復元できない場合でも、ユーザーの状態と設定の復元を続行するには、このパラメーター $true を設定します。

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

このパラメーターを追加して、このタスク シーケンス ステップを無効にします。

Type:SwitchParameter
Aliases:DisableThisStep
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
-ForceWildcardHandling

このパラメーターはワイルドカード文字を処理し、予期しない動作を引き起こします (推奨されません)。 DisableWildcardHandling と組み合わせは使用できない

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

USMT が動作できるモードは次の 2 つがあります。

  • Standard: 標準オプションを使用して、キャプチャされたユーザー プロファイルを復元します。 このオプションは既定です。

  • Customize: ユーザー プロファイルの復元方法をカスタマイズします。 このオプションを指定する場合は 、ConfigFile パラメーターを使用してカスタム XML 構成ファイルを指定します。

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

タスク シーケンスで識別するには、この手順の名前を指定します。

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

USMT パッケージのオブジェクトを指定します。 このオブジェクトを取得するには 、Get-CMPackage コマンドレットを使用 します。

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

RestoreLocalAccountパラメーターを有効にする場合は、このパラメーターを使用して、復元されたローカル ユーザー アカウントに新しいパスワードを割り当てる必要があります。 USMT では、元のパスワードを移行できません。 ローカル アカウントのパスワードのセキュリティで保護された文字列を指定します。

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

ローカル コンピューターのユーザー $true プロファイルを復元するには、このパラメーターを設定します。 これらのプロファイルは、ドメイン ユーザー向けではない。 USMT では、元のパスワードを移行できません。 復元されたローカル ユーザー アカウントに新しいパスワードを割り当てるには 、Password パラメーターを使用します。

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

USMT 詳細ログを $true 有効にするには、このパラメーターを設定します。

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

コマンドレットが実行されるとどうなるかを示します。 コマンドレットは実行されません。

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

入力

なし

出力

IResultObject

メモ

この戻り値オブジェクトとそのプロパティの詳細については、「SMS_TaskSequence_RestoreUserStateAction WMI クラス」を参照してください