SMS_TaskSequence_RestoreUserStateAction Server WMI Class
Updated: October 28, 2009
Applies To: System Center Configuration Manager 2007, System Center Configuration Manager 2007 R2, System Center Configuration Manager 2007 R3, System Center Configuration Manager 2007 SP1, System Center Configuration Manager 2007 SP2
The SMS_TaskSequence_RestoreUserStateAction Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a task sequence action initiating the User State Migration Tool (USMT) to restore user state and settings to a target computer.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Class SMS_TaskSequence_RestoreUserStateAction : SMS_TaskSequence_Action
{
SMS_TaskSequence_Condition Condition;
String ConfigFiles[];
Boolean ContinueOnError;
Boolean ContinueOnRestore;
String Description;
Boolean Enabled;
Boolean EnableVerboseLogging;
String LocalAccountPassword;
Boolean LocalAccounts;
String Mode;
String Name;
String SupportedEnvironment;
UInt32 Timeout;
String UsmtRestorePackageID;
};
The SMS_TaskSequence_RestoreUserStateAction class does not define any methods.
- Condition
- Data type: SMS_TaskSequence_Condition Access type: Read/Write Qualifiers: None See SMS_TaskSequence_Action Server WMI Class.
- ConfigFiles
- Data type: String Array Access type: Read/Write Qualifiers: None Configuration files used to capture user profiles. Set this property for customized user profile migration.
- ContinueOnError
- Data type: Boolean Access type: Read/Write Qualifiers: None See SMS_TaskSequence_Action Server WMI Class.
- ContinueOnRestore
- Data type: Boolean Access type: Read/Write Qualifiers: [not_null, VariableName("OSDMigrateContinueOnRestore")]true (default) if user state restoration should continue even if some files cannot be restored. The task sequence variable associated with this property is OSDMigrateContinueOnRestore. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
- Description
- Data type: String Access type: Read/Write Qualifiers: [AllowedLen("0-255")] See SMS_TaskSequence_Action Server WMI Class.
- Enabled
- Data type: Boolean Access type: Read/Write Qualifiers: None See SMS_TaskSequence_Action Server WMI Class.
- EnableVerboseLogging
- Data type: Boolean Access type: Read/Write Qualifiers: [Not_Null]true to enable USMT verbose logging. The default value is false.
- LocalAccountPassword
- Data type: String Access type: Read/Write Qualifiers: [VariableName("OSDMigrateLocalAccountPassword"), Secret] Password for the local user account to reset for restored local user profiles. The task sequence variable associated with this property is OSDMigrateLocalAccountPassword. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
- LocalAccounts
- Data type: Boolean Access type: Read/Write Qualifiers: [VariableName("OSDMigrateLocalAccounts"), Not_Null]true to restore the local computer account. The default value is false. The task sequence variable associated with this property is OSDMigrateLocalAccounts. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
- Mode
-
Data type: String
Access type: Read/Write
Qualifiers: [Not_Null]
Mode for customizing the USMT file list. Possible values are shown below. The default value is Simple.
-
Simple
-
Advanced
-
Simple
- Name
- Data type: String Access type: Read/Write See SMS_TaskSequence_Action Server WMI Class.
- SupportedEnvironment
- Data type: String Access type: Read/Write Qualifiers: [Not_Null:ToInstance] See SMS_TaskSequence_Action Server WMI Class. The default value of this property for this task sequence action is FullOS.
- Timeout
- Data type: UInt32 Access type: Read/Write Qualifiers: None See SMS_TaskSequence_Action Server WMI Class.
- UsmtRestorePackageID
- Data type: String Access type: Read/Write Qualifiers: [Not_Null, TaskSequencePackage, VariableName("_OSDMigrateUsmtRestorePackageID")] ID of the task sequence package containing the USMT program. The task sequence variable associated with this property is _OSDMigrateUsmtRestorePackageID. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
Class qualifiers for this class include:
[CommandLine("osdmigrateuserstate.exe /apply /continueOnError:%%OSDMigrateContinueOnRestore%%"),
VariablePrefix("OSDMigrate"),
ActionCategory{"UserState,3,3"},ActionUI{"AdminUI.TaskSequenceEditor.dll", "Microsoft.ConfigurationManagement.AdminConsole.TaskSequenceEditor", "RestoreUserStateControl", "TaskSequenceOptionControl"}]
For more information about both the class qualifiers and the property qualifiers included in the Properties section, see Configuration Manager Class and Property Qualifiers.
Runtime Requirements
For more information, see Configuration Manager Server Runtime Requirements.
Development Requirements
For more information, see Configuration Manager Server Development Requirements.
Concepts
Operating System Deployment Server WMI ClassesConfiguration Manager Operating System Deployment
About Operating System Deployment Task Sequences
How to Create an Operating System Deployment Task Sequence
How to Add a Condition to an Operating System Deployment Task Sequence Step
How to Add an Operating System Deployment Task Sequence Action