New-CMTSStepRestoreUserState
Créez une étape Restaurer l’état utilisateur , que vous pouvez ajouter à une séquence de tâches.
Syntaxe
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
Cette applet de commande crée un nouvel objet d’étape Restaurer l’état utilisateur . Utilisez ensuite l’applet de commande Add-CMTaskSequenceStep pour ajouter l’étape à une séquence de tâches. Pour plus d’informations sur cette étape, consultez À propos des étapes de séquence de tâches : Restaurer l’état utilisateur.
Remarque
Exécutez des applets de commande Configuration Manager à partir du lecteur de site Configuration Manager, par exemple PS XYZ:\>
. Pour plus d’informations, consultez Prise en main.
Exemples
Exemple 1
Cet exemple obtient d’abord un objet de package pour l’outil de migration d’état utilisateur (USMT). La ligne suivante crée un objet pour l’étape Restaurer l’état utilisateur , qui utilise ce package USMT et configure plusieurs paramètres d’étape. Il obtient ensuite un objet de séquence de tâches et ajoute cette nouvelle étape à la séquence de tâches à l’index 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
Paramètres
-Condition
Spécifiez un objet de condition à utiliser avec cette étape. Pour obtenir cet objet, utilisez l’une des applets de commande de condition de séquence de tâches. Par exemple, Get-CMTSStepConditionVariable.
Type: | IResultObject[] |
Alias: | Conditions |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ConfigFile
Lorsque vous spécifiez -ModeOption Customize
de personnaliser la façon dont les profils utilisateur sont restaurés, utilisez ce paramètre pour spécifier les noms de fichiers de fichiers de configuration XML personnalisés. Ces fichiers doivent se trouver dans le package USMT.
Type: | String[] |
Alias: | ConfigFiles |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Confirm
Une invite de confirmation apparaît avant d’exécuter le cmdlet.
Type: | SwitchParameter |
Alias: | cf |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ContinueOnError
Ajoutez ce paramètre pour activer l’option d’étape Continuer en cas d’erreur. Lorsque vous activez cette option, si l’étape échoue, la séquence de tâches continue.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ContinueOnRestore
Définissez ce paramètre sur $true
pour continuer à restaurer l’état utilisateur et les paramètres même si l’outil USMT ne peut pas restaurer certains fichiers.
Type: | Boolean |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Description
Spécifiez une description facultative pour cette étape de séquence de tâches.
Type: | String |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Disable
Ajoutez ce paramètre pour désactiver cette étape de séquence de tâches.
Type: | SwitchParameter |
Alias: | DisableThisStep |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-DisableWildcardHandling
Ce paramètre traite les caractères génériques comme des valeurs de caractère littéral. Vous ne pouvez pas la combiner avec ForceWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ForceWildcardHandling
Ce paramètre traite les caractères génériques et peut entraîner un comportement inattendu (non recommandé). Vous ne pouvez pas la combiner avec DisableWildcardHandling.
Type: | SwitchParameter |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-ModeOption
Il existe deux modes dans lesquels USMT peut fonctionner :
Standard
: Restaurez tous les profils utilisateur capturés avec des options standard. Cette option est activée par défaut.Customize
: personnalisez la façon dont les profils utilisateur sont restaurés. Si vous spécifiez cette option, utilisez le paramètre ConfigFile pour spécifier les fichiers de configuration XML personnalisés.
Type: | ModeType |
Valeurs acceptées: | Standard, Customize |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Name
Spécifiez un nom pour cette étape afin de l’identifier dans la séquence de tâches.
Type: | String |
Alias: | StepName |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Package
Spécifiez un objet pour le package USMT. Pour obtenir cet objet, utilisez l’applet de commande Get-CMPackage .
Type: | IResultObject |
Alias: | UserStateMigrationToolPackage |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | True |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-Password
Si vous activez le paramètre RestoreLocalAccount , utilisez ce paramètre pour affecter un nouveau mot de passe aux comptes d’utilisateur locaux restaurés. L’outil USMT ne peut pas migrer les mots de passe d’origine. Spécifiez une chaîne sécurisée pour le mot de passe du compte local.
Type: | SecureString |
Alias: | NewPasswordForLocalAccount |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-RestoreLocalAccount
Définissez ce paramètre sur $true
pour restaurer les profils utilisateur de l’ordinateur local. Ces profils ne sont pas destinés aux utilisateurs de domaine. L’outil USMT ne peut pas migrer les mots de passe d’origine. Pour affecter de nouveaux mots de passe aux comptes d’utilisateur locaux restaurés, utilisez le paramètre Password .
Type: | Boolean |
Alias: | RestoreLocalComputerUserProfile |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-VerboseLogging
Définissez ce paramètre sur $true
pour activer la journalisation détaillée USMT.
Type: | Boolean |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
-WhatIf
Présente ce qui se produit si le cmdlet s’exécute. L’applet de commande ne s’exécute pas.
Type: | SwitchParameter |
Alias: | wi |
Position: | Named |
Valeur par défaut: | None |
Obligatoire: | False |
Accepter l'entrée de pipeline: | False |
Accepter les caractères génériques: | False |
Entrées
None
Sorties
IResultObject
Notes
Pour plus d’informations sur cet objet de retour et ses propriétés, consultez SMS_TaskSequence_RestoreUserStateAction classe WMI du serveur.