New-CMTSStepRestoreUserState

  • リファレンス
モジュール:
ConfigurationManager

タスク シーケンスに追加できる [ユーザー状態の復元 ] ステップを作成します。

構文

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:\>)。 詳細については、「作業の 開始」を参照してください。

例

例 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ConfigFile

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

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

-Confirm

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

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

-ContinueOnError

このパラメーターを追加して、ステップ オプション [ エラー時に続行] を有効にします。 このオプションを有効にすると、ステップが失敗した場合、タスク シーケンスは続行されます。

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

-ContinueOnRestore

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

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

-Description

このタスク シーケンス ステップの説明 (省略可能) を指定します。

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

-Disable

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

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

-DisableWildcardHandling

このパラメーターは、ワイルドカード文字をリテラル文字の値として扱います。 ForceWildcardHandling と組み合わせることはできません。

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

-ForceWildcardHandling

このパラメーターはワイルドカード文字を処理し、予期しない動作が発生する可能性があります (推奨されません)。 DisableWildcardHandling と組み合わせることはできません。

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

-Name

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

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

-Package

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

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

-Password

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

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

-RestoreLocalAccount

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

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

-VerboseLogging

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

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

-WhatIf

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

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

入力

None

出力

IResultObject

メモ

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