SMS_TaskSequence_CaptureUserStateAction Server WMI Class
Applies To: System Center 2012 Configuration Manager, System Center 2012 Configuration Manager SP1, System Center 2012 R2 Configuration Manager
The SMS_TaskSequence_CaptureUserStateAction Windows Management Instrumentation (WMI) class is an SMS Provider server class, in Configuration Manager, that represents a task sequence action that uses the User State Migration Tool (USMT) to capture user state and settings from the target computer.
The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties.
Syntax
Class SMS_TaskSequence_CaptureUserStateAction : SMS_TaskSequence_Action
{
SMS_TaskSequence_Condition Condition;
String ConfigFiles[];
Boolean ContinueOnError;
Boolean ContinueOnLockedFiles;
String Description;
Boolean Enabled;
Boolean EnableVerboseLogging;
String FileAccess;
String Mode;
String Name;
Boolean OfflineUserState;
Boolean SkipEncryptedFiles;
String SupportedEnvironment;
UInt32 Timeout;
Boolean UseHardlinks;
String UsmtPackageID;
};
Methods
The SMS_TaskSequence_CaptureUserStateAction class does not define any methods.
Properties
Condition
Data type: SMS_TaskSequence_ConditionAccess type: Read/Write
Qualifiers: None
ConfigFiles
Data type: String ArrayAccess type: Read/Write
Qualifiers: None
The configuration files used to capture user profiles. Set this property for customized user profile migration.
ContinueOnError
Data type: BooleanAccess type: Read/Write
Qualifiers: None
ContinueOnLockedFiles
Data type: BooleanAccess type: Read/Write
Qualifiers: [Not_Null, VariableName("OSDMigrateContinueOnLockedFiles")]
true (default) to allow the capture user state action to proceed even if some files cannot be captured. This property is required.
The task sequence variable associated with this property is OSDMigrateContinueOnLockedFiles. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
Description
Data type: StringAccess type: Read/Write
Qualifiers: [AllowedLen("0-255")]
Enabled
Data type: BooleanAccess type: Read/Write
Qualifiers: None
EnableVerboseLogging
Data type: BooleanAccess type: Read/Write
Qualifiers: [Not_Null]
true to enable verbose logging for the USMT. The default value is false. This property is required.
FileAccess
Data type: StringAccess type: Read/Write
Qualifiers: [Not_Null]
FileAccess …. Possible values are:
Normal (default)
VSS
Mode
Data type: StringAccess type: Read/Write
Qualifiers: [Not_Null]
Mode that allows customization of the files captured by the USMT. Possible values are:
Simple (default)
Advanced
This property is required.
Name
Data type: StringAccess type: Read/Write
Qualifiers: [AllowedLen("1-100")]
OfflineUserState
Data type: BooleanAccess type: Read/Write
Qualifiers: [Not_Null, VariableName("_OSDMigrateOfflineUserState")]
true to migrate offline user state. The default value is false.
SkipEncryptedFiles
Data type: BooleanAccess type: Read/Write
Qualifiers: [Not_Null, VariableName("OSDMigrateSkipEncryptedFiles")]
true to skip encrypted files. The default value is false.
The task sequence variable associated with this property is OSDMigrateSkipEncryptedFiles. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
SupportedEnvironment
Data type: StringAccess 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: UInt32Access type: Read/Write
Qualifiers: None
UseHardlinks
Data type: BooleanAccess type: Read/Write
Qualifiers: [Not_Null, VariableName("_OSDMigrateUseHardlinks")]
true to …. The default value is false.
UsmtPackageID
Data type: StringAccess type: Read/Write
Qualifiers: [Not_Null, VariableName("_OSDMigrateUsmtPackageID"), TaskSequencePackage]
The ID of the Configuration Manager package that contains USMT binaries. This property is required.
The task sequence variable associated with this property is _OSDMigrateUsmtPackageID. For more information, see the MSDN documentation for Operating System Deployment Task Sequence Variables.
Remarks
Class qualifiers for this class include:
[CommandLine("osdmigrateuserstate.exe /collect /continueOnError:%%OSDMigrateContinueOnLockedFiles%% /skipefs:%%OSDMigrateSkipEncryptedFiles%%"),VariablePrefix("OSDMigrate"),
ActionCategory{"UserState,2,3"},ActionUI{"AdminUI.TaskSequenceEditor.dll", "Microsoft.ConfigurationManagement.AdminConsole.TaskSequenceEditor", "CaptureUserStateControl", "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.
Requirements
Runtime Requirements
For more information, see Configuration Manager Server Runtime Requirements.
Development Requirements
For more information, see Configuration Manager Server Development Requirements.
See Also
Operating System Deployment Server WMI Classes
SMS_TaskSequence_Action Server WMI Class