+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -185,33 +165,13 @@ The following list shows the supported values:
**System/AllowCommercialDataPipeline**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -302,33 +262,13 @@ The following list shows the supported values:
**System/AllowDeviceNameInDiagnosticData**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -376,33 +316,13 @@ The following list shows the supported values:
**System/AllowEmbeddedMode**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -437,33 +357,13 @@ The following list shows the supported values:
**System/AllowExperimentation**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -503,33 +403,13 @@ The following list shows the supported values:
**System/AllowFontProviders**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -583,33 +463,13 @@ To verify if System/AllowFontProviders is set to true:
**System/AllowLocation**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -680,33 +540,13 @@ If you disable this policy setting, devices may not appear in Microsoft Managed
**System/AllowStorageCard**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -741,33 +581,13 @@ The following list shows the supported values:
**System/AllowTelemetry**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -792,28 +612,6 @@ The following list shows the supported values for Windows 8.1:
- 1 – Allowed, except for Secondary Data Requests.
- 2 (default) – Allowed.
-
In Windows 10, you can configure this policy setting to decide what level of diagnostic data to send to Microsoft.
@@ -835,35 +633,6 @@ The following list shows the supported values for Windows 10 version 1809 and ol
Most restrictive value is 0.
-
-
ADMX Info:
@@ -882,33 +651,13 @@ ADMX Info:
**System/AllowUpdateComplianceProcessing**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -961,33 +710,13 @@ The following list shows the supported values:
**System/AllowUserToResetPhone**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1053,33 +782,13 @@ The following list shows the supported values:
**System/BootStartDriverInitialization**
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
diff --git a/windows/client-management/mdm/policy-csp-textinput.md b/windows/client-management/mdm/policy-csp-textinput.md
index 77bf576304..d4bc93e500 100644
--- a/windows/client-management/mdm/policy-csp-textinput.md
+++ b/windows/client-management/mdm/policy-csp-textinput.md
@@ -134,38 +134,14 @@ Placeholder only. Do not use in production environment.
**TextInput/AllowIMELogging**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -204,38 +180,14 @@ The following list shows the supported values:
**TextInput/AllowIMENetworkAccess**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -272,38 +224,14 @@ The following list shows the supported values:
**TextInput/AllowInputPanel**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -342,38 +270,14 @@ The following list shows the supported values:
**TextInput/AllowJapaneseIMESurrogatePairCharacters**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -413,38 +317,14 @@ The following list shows the supported values:
**TextInput/AllowJapaneseIVSCharacters**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -483,38 +363,14 @@ The following list shows the supported values:
**TextInput/AllowJapaneseNonPublishingStandardGlyph**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -553,38 +409,14 @@ The following list shows the supported values:
**TextInput/AllowJapaneseUserDictionary**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -623,38 +455,14 @@ The following list shows the supported values:
**TextInput/AllowKeyboardTextSuggestions**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -713,38 +521,14 @@ This policy has been deprecated.
**TextInput/AllowLanguageFeaturesUninstall**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -791,38 +575,14 @@ The following list shows the supported values:
**TextInput/AllowLinguisticDataCollection**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -860,38 +620,14 @@ This setting supports a range of values between 0 and 1.
**TextInput/ConfigureJapaneseIMEVersion**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -929,38 +665,14 @@ The following list shows the supported values:
**TextInput/ConfigureSimplifiedChineseIMEVersion**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -998,38 +710,14 @@ The following list shows the supported values:
**TextInput/ConfigureTraditionalChineseIMEVersion**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1066,38 +754,14 @@ The following list shows the supported values:
**TextInput/EnableTouchKeyboardAutoInvokeInDesktopMode**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1136,38 +800,14 @@ The following list shows the supported values:
**TextInput/ExcludeJapaneseIMEExceptJIS0208**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1204,38 +844,14 @@ The following list shows the supported values:
**TextInput/ExcludeJapaneseIMEExceptJIS0208andEUDC**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1272,38 +888,14 @@ The following list shows the supported values:
**TextInput/ExcludeJapaneseIMEExceptShiftJIS**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1340,38 +932,14 @@ The following list shows the supported values:
**TextInput/ForceTouchKeyboardDockedState**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1405,38 +973,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardDictationButtonAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1470,38 +1014,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardEmojiButtonAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1535,38 +1055,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardFullModeAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1600,38 +1096,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardHandwritingModeAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1665,38 +1137,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardNarrowModeAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1730,38 +1178,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardSplitModeAvailability**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -1795,38 +1219,14 @@ The following list shows the supported values:
**TextInput/TouchKeyboardWideModeAvailability**
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -101,38 +77,14 @@ Supported values:
- 5 - Allow the user to choose their own recommended troubleshooting settings.
By default, this policy is not configured and the SKU based defaults are used for managed devices. Current policy values for SKU's are as follows:
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -3402,38 +2367,14 @@ The following list shows the supported values:
**Update/PauseQualityUpdatesStartTime**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -3563,38 +2504,14 @@ By using this Windows Update for Business policy to upgrade devices to a new pro
**Update/RequireDeferUpgrade**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
No
-
-
-
Business
-
Yes
-
No
-
-
-
Enterprise
-
Yes
-
No
-
-
-
Education
-
Yes
-
No
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|No|
+|Business|Yes|No|
+|Enterprise|Yes|No|
+|Education|Yes|No|
@@ -3638,38 +2555,14 @@ The following list shows the supported values:
**Update/RequireUpdateApproval**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
No
-
-
-
Business
-
Yes
-
No
-
-
-
Enterprise
-
Yes
-
No
-
-
-
Education
-
Yes
-
No
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|No|
+|Business|Yes|No|
+|Enterprise|Yes|No|
+|Education|Yes|No|
@@ -3708,38 +2601,14 @@ The following list shows the supported values:
**Update/ScheduleImminentRestartWarning**
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -4645,38 +3226,14 @@ The following list shows the supported values:
**Update/SetProxyBehaviorForUpdateDetection**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -4722,38 +3279,14 @@ The following list shows the supported values:
**Update/TargetReleaseVersion**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -4796,38 +3329,14 @@ Value type is a string containing Windows 10 version number. For example, 1809,
**Update/UpdateNotificationLevel**
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
diff --git a/windows/client-management/mdm/policy-csp-userrights.md b/windows/client-management/mdm/policy-csp-userrights.md
index 606e5b3100..a67e1377cd 100644
--- a/windows/client-management/mdm/policy-csp-userrights.md
+++ b/windows/client-management/mdm/policy-csp-userrights.md
@@ -197,38 +197,14 @@ For example, the following syntax grants user rights to a specific user or group
**UserRights/AccessCredentialManagerAsTrustedCaller**
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
diff --git a/windows/client-management/mdm/policy-csp-windowssandbox.md b/windows/client-management/mdm/policy-csp-windowssandbox.md
index f3fd70ab14..c8066ba2b0 100644
--- a/windows/client-management/mdm/policy-csp-windowssandbox.md
+++ b/windows/client-management/mdm/policy-csp-windowssandbox.md
@@ -48,38 +48,14 @@ ms.date: 10/14/2020
Available in the latest Windows 10 insider preview build.
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
No
-
No
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|No|No|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -142,38 +118,14 @@ The following are the supported values:
Available in the latest Windows 10 insider preview build.
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
No
-
No
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|No|No|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -233,38 +185,14 @@ The following are the supported values:
Available in the latest Windows 10 insider preview build.
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
No
-
No
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|No|No|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -322,38 +250,14 @@ The following are the supported values:
Available in the latest Windows 10 insider preview build.
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
No
-
No
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|No|No|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -412,38 +316,14 @@ The following are the supported values:
Available in the latest Windows 10 insider preview build.
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
No
-
No
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|No|No|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -505,38 +385,14 @@ The following are the supported values:
Available in the latest Windows 10 insider preview build.
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -117,38 +93,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowMdnsDiscovery**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -181,38 +133,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowProjectionFromPC**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -245,38 +173,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowProjectionFromPCOverInfrastructure**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -309,38 +213,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowProjectionToPC**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -385,38 +265,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowProjectionToPCOverInfrastructure**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -449,38 +305,14 @@ The following list shows the supported values:
**WirelessDisplay/AllowUserInputFromWirelessDisplayReceiver**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
@@ -513,38 +345,14 @@ The following list shows the supported values:
**WirelessDisplay/RequirePinForPairing**
-
-
-
Edition
-
Windows 10
-
Windows 11
-
-
-
Home
-
No
-
No
-
-
-
Pro
-
Yes
-
Yes
-
-
-
Business
-
Yes
-
Yes
-
-
-
Enterprise
-
Yes
-
Yes
-
-
-
Education
-
Yes
-
Yes
-
-
+
+|Edition|Windows 10|Windows 11|
+|--- |--- |--- |
+|Home|No|No|
+|Pro|Yes|Yes|
+|Business|Yes|Yes|
+|Enterprise|Yes|Yes|
+|Education|Yes|Yes|
diff --git a/windows/client-management/mdm/pxlogical-csp.md b/windows/client-management/mdm/pxlogical-csp.md
index 1b7b94e690..5535a11feb 100644
--- a/windows/client-management/mdm/pxlogical-csp.md
+++ b/windows/client-management/mdm/pxlogical-csp.md
@@ -17,7 +17,8 @@ ms.date: 06/26/2017
The PXLOGICAL configuration service provider is used to add, remove, or modify WAP logical and physical proxies by using WAP or the standard Windows techniques.
-> **Note** This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_NETWORKING\_ADMIN capabilities to be accessed from a network configuration application.
+> [!NOTE]
+> This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_NETWORKING\_ADMIN capabilities to be accessed from a network configuration application.
The following shows the PXLOGICAL configuration service provider management object in tree format as used by OMA Client Provisioning for initial bootstrapping of the device. The OMA DM protocol is not supported by this configuration service provider.
@@ -151,36 +152,12 @@ The following table shows the Microsoft custom elements that this configuration
These features are available only for the device technique. In addition, the parameter-query and characteristic-query features are not supported for all PXPHYSICAL proxy parameters for all PXADDR types. All parameters can be queried when the PXPHYSICAL proxy PXADDRType is IPv4. For example, if a mobile operator queries the TO-NAPID parameter of a PXPHYSICAL proxy and the PXADDR Type is E164, a noparm is returned.
-
-
-
-
-
-
-
-
Feature
-
Available
-
-
-
-
-
parm-query
-
Yes
-
-
-
noparm
-
Yes
-
-
-
nocharacteristic
-
Yes
-
-
-
characteristic-query
-
Yes
-
-
-
+|Feature|Available|
+|--- |--- |
+|parm-query|Yes|
+|noparm|Yes|
+|nocharacteristic|Yes|
+|characteristic-query|Yes|
@@ -189,12 +166,3 @@ These features are available only for the device technique. In addition, the par
[Configuration service provider reference](configuration-service-provider-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/client-management/mdm/reclaim-seat-from-user.md b/windows/client-management/mdm/reclaim-seat-from-user.md
index 3beb6993e3..35928407be 100644
--- a/windows/client-management/mdm/reclaim-seat-from-user.md
+++ b/windows/client-management/mdm/reclaim-seat-from-user.md
@@ -18,120 +18,31 @@ The **Reclaim seat from user** operation returns reclaimed seats for a user in t
## Request
-
+|Method|Request URI|
+|--- |--- |
+|DELETE|`https://bspmts.mp.microsoft.com/V1/Inventory/{productId}/{skuId}/Seats/{username}`|
### URI parameters
The following parameters may be specified in the request URI.
-
-
-
-
-
-
-
-
-
Parameter
-
Type
-
Description
-
-
-
-
-
productId
-
string
-
Required. Product identifier for an application that is used by the Store for Business.
-
-
-
skuId
-
string
-
Required. Product identifier that specifies a specific SKU of an application.
-
-
-
username
-
string
-
Requires UserPrincipalName (UPN). User name of the target user account.
-
-
-
+|Parameter|Type|Description|
+|--- |--- |--- |
+|productId|string|Required. Product identifier for an application that is used by the Store for Business.|
+|skuId|string|Required. Product identifier that specifies a specific SKU of an application.|
+|username|string|Requires UserPrincipalName (UPN). User name of the target user account.|
-
## Response
### Response body
The response body contain [SeatDetails](data-structures-windows-store-for-business.md#seatdetails).
-
+|Error code|Description|Retry|Data field|Details|
+|--- |--- |--- |--- |--- |
+|400|Invalid parameters|No|Parameter name Reason: Invalid parameter Details: String|Invalid can include productId, skuId or userName|
+|404|Not found||Item type: Inventory, User, Seat Values: ProductId/SkuId, UserName, ProductId/SkuId/UserName|ItemType: Inventory, User, Seat Values: ProductId/SkuId, UserName, ProductId/SkuId/UserName|
+|409|Conflict||Reason: Not online||
-
-
-
-
-
-
-
diff --git a/windows/client-management/mdm/registry-csp.md b/windows/client-management/mdm/registry-csp.md
index 4978cc70e0..d678652ec7 100644
--- a/windows/client-management/mdm/registry-csp.md
+++ b/windows/client-management/mdm/registry-csp.md
@@ -33,7 +33,7 @@ For OMA Client Provisioning, the follows notes apply:
- This documentation describes the default characteristics. Additional characteristics may be added.
-- Because the **Registry** configuration service provider uses the backslash (\\) character as a separator between key names, backslashes which occur in the name of a registry key must be escaped. Backslashes can be escaped by using two sequential backslashes (\\\\).
+- Because the **Registry** configuration service provider uses the backslash (\\) character as a separator between key names, backslashes, which occur in the name of a registry key must be escaped. Backslashes can be escaped by using two sequential backslashes (\\\\).
The default security role maps to each subnode unless specific permission is granted to the subnode. The security role for subnodes is implementation specific, and can be changed by OEMs and mobile operators.
@@ -41,38 +41,12 @@ The default security role maps to each subnode unless specific permission is gra
The following table shows the Microsoft custom elements that this configuration service provider supports for OMA Client Provisioning.
-
Top-level query: No|
Use these elements to build standard OMA Client Provisioning configuration XML. For information about specific elements, see MSPROV DTD elements.
@@ -82,62 +56,16 @@ Use these elements to build standard OMA Client Provisioning configuration XML.
The following table shows the data types this configuration service provider supports.
-
-
-
-
-
-
-
-
-
XML Data Type
-
Native Registry Type
-
XML Format
-
-
-
-
-
integer
-
REG_DWORD
-
Integer. A query of this parameter returns an integer type.
-
-
-
boolean
-
REG_DWORD
-
Integer value of 1 or 0. A query of this parameter returns an integer type.
-
-
-
float
-
REG_SZ
-
Float. A query of this parameter returns a string type.
-
-
-
string
-
REG_SZ
-
String. A query of this parameter returns a string type.
-
-
-
multiplestring
-
REG_MULTI_SZ
-
Multiple strings are separated by  and ended with two  - A query of this parameter returns a multistring type.
-
-
-
binary
-
REG_BINARY
-
Base64 encoded. A query of this parameter returns a binary type.
-
-
-
time
-
FILETIME in REG_BINARY
-
The time format conforms to the ISO8601 standard, with the date portion optional. If the date portion is omitted, also omit the "T" delimiter. A query of this parameter returns a binary type.
-
-
-
date
-
FILETIME in REG_BINARY
-
The date format conforms to the ISO8601 standard, with the time portion optional. If the time portion is omitted, also omit the "T" delimiter. A query of this parameter returns a binary type.
-
-
-
+|XML Data Type|Native Registry Type|XML Format|
+|--- |--- |--- |
+|Integer|REG_DWORD|Integer. A query of this parameter returns an integer type.|
+|Boolean|REG_DWORD|Integer value of 1 or 0. A query of this parameter returns an integer type.|
+|Float|REG_SZ|Float. A query of this parameter returns a string type.|
+|String|REG_SZ|String. A query of this parameter returns a string type.|
+|multiple string|REG_MULTI_SZ|Multiple strings are separated by **** and ended with two **** - A query of this parameter returns a multi-string type.|
+|Binary|REG_BINARY|Base64 encoded. A query of this parameter returns a binary type.|
+|Time|FILETIME in REG_BINARY|The time format conforms to the ISO8601 standard, with the date portion optional. If the date portion is omitted, also omit the "T" delimiter. A query of this parameter returns a binary type.|
+|Date|FILETIME in REG_BINARY|The date format conforms to the ISO8601 standard, with the time portion optional. If the time portion is omitted, also omit the "T" delimiter. A query of this parameter returns a binary type.|
@@ -147,13 +75,3 @@ It is not possible to access registry keys nested under the current path by usin
[Configuration service provider reference](configuration-service-provider-reference.md)
-
-
-
-
-
-
-
-
-
-
diff --git a/windows/client-management/mdm/remotelock-csp.md b/windows/client-management/mdm/remotelock-csp.md
index 47ee3981e4..86f5a419c8 100644
--- a/windows/client-management/mdm/remotelock-csp.md
+++ b/windows/client-management/mdm/remotelock-csp.md
@@ -26,71 +26,21 @@ The RemoteLock CSP supports the ability to lock a device that has a PIN set on t
**Lock**
Required. The setting accepts requests to lock the device screen. The device screen will lock immediately if a PIN has been set. If no PIN is set, the lock request is ignored and the OMA DM (405) Forbidden error is returned over the management channel. All OMA DM errors are listed [here](https://go.microsoft.com/fwlink/p/?LinkId=522607) in the protocol specification. The supported operations are Get and Exec.
-
-
-
-
-
-
-
-
-
Status
-
Description
-
Meaning [Standard]
-
-
-
-
-
(200) OK
-
The device was successfully locked.
-
The command and the associated Alert action are completed successfully.
-
-
-
(405)
-
The device could not be locked because there is no PIN currently set on the device.
-
The requested command is not allowed on the target.
-
-
-
(500) Command failed
-
The device was not locked for some unknown reason.
-
Non-specific errors were created by the recipient while attempting to complete the command.
-
-
-
-
-
+|Status|Description|Meaning [Standard]|
+|--- |--- |--- |
+|(200) OK|The device was successfully locked.|The command and the associated Alert action are completed successfully.|
+|(405)|The device could not be locked because there is no PIN currently set on the device.|The requested command is not allowed on the target.|
+|(500) Command failed|The device was not locked for some unknown reason.|Non-specific errors were created by the recipient while attempting to complete the command.|
**LockAndResetPIN**
This setting can be used to lock and reset the PIN on the device. It is used in conjunction with the NewPINValue node. After the **Exec** operation is called successfully on this node, the previous PIN will no longer work and cannot be recovered. The supported operation is Exec.
This node will return the following status. All OMA DM errors are listed [here](https://go.microsoft.com/fwlink/p/?LinkId=522607) in the protocol specification.
-
-
-
-
-
-
-
-
-
Status
-
Description
-
Meaning
-
-
-
-
-
(200) OK
-
The device has been locked with a new password which has been reset.
-
The command and the associated Alert action are completed successfully.
-
-
-
(500) Command failed
-
N/A
-
Non-specific errors were created by the recipient while attempting to complete the command.
-
-
-
+|Status|Description|Meaning|
+|--- |--- |--- |
+|(200) OK|The device has been locked with a new password which has been reset.|The command and the associated Alert action are completed successfully.|
+|(500) Command failed|N/A|Non-specific errors were created by the recipient while attempting to complete the command.|
**LockAndRecoverPIN**
Added in Windows 10, version 1703. This setting performs a similar function to the LockAndResetPIN node. With LockAndResetPIN any Windows Hello keys associated with the PIN gets deleted, but with LockAndRecoverPIN those keys are saved. After the Exec operation is called successfully on this setting, the new PIN can be retrieved from the NewPINValue setting. The previous PIN will no longer work.
diff --git a/windows/client-management/mdm/securitypolicy-csp.md b/windows/client-management/mdm/securitypolicy-csp.md
index fbc7a1ec31..a08448947e 100644
--- a/windows/client-management/mdm/securitypolicy-csp.md
+++ b/windows/client-management/mdm/securitypolicy-csp.md
@@ -17,7 +17,8 @@ ms.date: 06/26/2017
The SecurityPolicy configuration service provider is used to configure security policy settings for WAP push, OMA Client Provisioning, OMA DM, Service Indication (SI), Service Loading (SL), and MMS.
-> **Note** This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_DEVICE\_MANAGEMENT\_SECURITY\_POLICIES capabilities to be accessed from a network configuration application.
+> [!NOTE]
+> This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION and ID\_CAP\_DEVICE\_MANAGEMENT\_SECURITY\_POLICIES capabilities to be accessed from a network configuration application.
@@ -36,122 +37,78 @@ Defines the security policy identifier as a decimal value.
The following security policies are supported.
-
-
-
-
-
-
-
-
-
PolicyID
-
Policy name
-
Policy description
-
-
-
-
-
4104
-
Hex: 1008
-
TPS Policy
-
This setting indicates whether mobile operators can be assigned the Trusted Provisioning Server (TPS) SECROLE_OPERATOR_TPS role.
-
Default value: 1
-
Supported values:
-
0: The TPS role assignment is disabled.
-
1: The TPS role assignment is enabled, and can be assigned to mobile operators.
-
-
-
4105
-
Hex: 1009
-
Message Authentication Retry Policy
-
This setting specifies the maximum number of times the user is allowed to try authenticating a Wireless Application Protocol (WAP) PIN-signed message.
-
Default value: 3
-
Possible values: 0 through 256.
-
-
-
4108
-
Hex: 100c
-
Service Loading Policy
-
This setting indicates whether SL messages are accepted, by specifying the security roles that can accept SL messages. An SL message downloads new services or provisioning XML to the device.
This setting indicates whether SI messages are accepted, by specifying the security roles that can accept SI messages. An SI message is sent to the device to notify users of new services, service updates, and provisioning services.
This setting determines whether PIN signed OMA Client Provisioning messages will be processed. This policy's value specifies a role mask. If a message contains at least one of the following roles in the role mask, then the message is processed. To ensure properly signed OMA Client Provisioning messages are accepted by the configuration client, all of the roles that are set in 4141, 4142, and 4143 policies must also be set in this policy. For example, to ensure properly signed USERNETWPIN signed OMA Client Provisioning messages are accepted by the device, if policy 4143 is set to 4096 (SECROLE_ANY_PUSH_SOURCE) for an carrier-unlocked device, policy 4111 must also have the SECROLE_ANY_PUSH_SOURCE role set.
This setting indicates whether Wireless Session Protocol (WSP) notifications from the WAP stack are routed.
-
Default value: 1
-
Supported values:
-
0: Routing of WSP notifications is not allowed.
-
1: Routing of WSP notifications is allowed.
-
-
-
4132
-
Hex:1024
-
Network PIN signed OTA Provision Message User Prompt Policy
-
This policy specifies whether the device will prompt a UI to get the user confirmation before processing a pure network pin signed OTA Provisioning message. If prompt, the user has the ability to discard the OTA provisioning message.
-
Default value: 0
-
Supported values:
-
0: The device prompts a UI to get user confirmation when the OTA WAP provisioning message is signed purely with network pin.
-
1: There is no user prompt.
-
-
-
4141
-
Hex:102d
-
OMA CP NETWPIN Policy
-
This setting determines whether the OMA network PIN signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
This setting determines whether the OMA user PIN or user MAC signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
This setting determines whether the OMA user network PIN signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
This setting determines whether MMS messages will be processed. This policy's value specifies a role mask. If a message contains at least one of the roles in the role mask, then the message is processed.
+- **PolicyID**: 4104 | Hex: 1008
+ - **Policy name**: TPS Policy
+ - **Policy description**: This setting indicates whether mobile operators can be assigned the Trusted Provisioning Server (TPS) SECROLE_OPERATOR_TPS role.
+ - Default value: 1
+ - Supported values:
+ - 0: The TPS role assignment is disabled.
+ - 1: The TPS role assignment is enabled, and can be assigned to mobile operators.
+
+- **PolicyID**: 4105 | Hex: 1009
+ - **Policy name**: Message Authentication Retry Policy
+ - **Policy description**: This setting specifies the maximum number of times the user is allowed to try authenticating a Wireless Application Protocol (WAP) PIN-signed message.
+ - Default value: 3
+ - Supported values: 0 through 256
+
+- **PolicyID**: 4108 | Hex: 100c
+ - **Policy name**: Service Loading Policy
+ - **Policy description**: This setting indicates whether SL messages are accepted, by specifying the security roles that can accept SL messages. An SL message downloads new services or provisioning XML to the device.
+ - Default value: 256 (SECROLE_KNOWN_PPG)
+ - Supported values: SECROLE_ANY_PUSH_SOURCE, SECROLE_KNOWN_PPG
+
+- **PolicyID**: 4109 | Hex:100d
+ - **Policy name**: Service Indication Policy
+ - **Policy description**: This setting indicates whether SI messages are accepted, by specifying the security roles that can accept SI messages. An SI message is sent to the device to notify users of new services, service updates, and provisioning services.
+ - Default value: 256 (SECROLE_KNOWN_PPG)
+ - Supported values: SECROLE_ANY_PUSH_SOURCE, SECROLE_KNOWN_PPG
+
+- **PolicyID**: 4111 | Hex:100f
+ - **Policy name**: OTA Provisioning Policy
+ - **Policy description**: This setting determines whether PIN signed OMA Client Provisioning messages will be processed. This policy's value specifies a role mask. If a message contains at least one of the following roles in the role mask, then the message is processed. To ensure properly signed OMA Client Provisioning messages are accepted by the configuration client, all of the roles that are set in 4141, 4142, and 4143 policies must also be set in this policy. For example, to ensure properly signed USERNETWPIN signed OMA Client Provisioning messages are accepted by the device, if policy 4143 is set to 4096 (SECROLE_ANY_PUSH_SOURCE) for an carrier-unlocked device, policy 4111 must also have the SECROLE_ANY_PUSH_SOURCE role set.
+ - Default value: 384 (SECROLE_OPERATOR_TPS | SECROLE_KNOWN_PPG)
+ - Supported values: SECROLE_KNOWN_PPG, SECROLE_ANY_PUSH_SOURCE, SECROLE_OPERATOR_TPS
+
+- **PolicyID**: 4113 | Hex:1011
+ - **Policy name**: WSP Push Policy
+ - **Policy description**: This setting indicates whether Wireless Session Protocol (WSP) notifications from the WAP stack are routed.
+ - Default value: 1
+ - Supported values:
+ - 0: Routing of WSP notifications is not allowed.
+ - 1: Routing of WSP notifications is allowed.
+
+- **PolicyID**: 4132 | Hex:1024
+ - **Policy name**: Network PIN signed OTA Provision Message User Prompt Policy
+ - **Policy description**: This policy specifies whether the device will prompt a UI to get the user confirmation before processing a pure network pin signed OTA Provisioning message. If prompt, the user has the ability to discard the OTA provisioning message.
+ - Default value: 0
+ - Supported values:
+ - 0: The device prompts a UI to get user confirmation when the OTA WAP provisioning message is signed purely with network pin.
+ - 1: There is no user prompt.
+
+- **PolicyID**: 4141 | Hex:102d
+ - **Policy name**: OMA CP NETWPIN Policy
+ - **Policy description**: This setting determines whether the OMA network PIN signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
+ - Default value: 0
+ - Supported values: SECROLE_KNOWN_PPG, SECROLE_ANY_PUSH_SOURCE , SECROLE_OPERATOR_TPS
+
+- **PolicyID**: 4142 | Hex:102e
+ - **Policy name**: OMA CP USERPIN Policy
+ - **Policy description**: This setting determines whether the OMA user PIN or user MAC signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
+ - Default value: 256
+ - Supported values: SECROLE_OPERATOR_TPS, SECROLE_ANY_PUSH_SOURCE, SECROLE_KNOWN_PPG
+
+- **PolicyID**: 4143 | Hex:102f
+ - **Policy name**: OMA CP USERNETWPIN Policy
+ - **Policy description**: This setting determines whether the OMA user network PIN signed message will be accepted. The message's role mask and the policy's role mask are combined using the AND operator. If the result is non-zero, then the message is accepted.
+ - Default value: 256
+ - Supported values: SECROLE_KNOWN_PPG, SECROLE_ANY_PUSH_SOURCE, SECROLE_OPERATOR_TPS
+
+- **PolicyID**: 4144 | Hex:1030
+ - **Policy name**: MMS Message Policy
+ - **Policy description**: This setting determines whether MMS messages will be processed. This policy's value specifies a role mask. If a message contains at least one of the roles in the role mask, then the message is processed.
+ - Default value: 256 (SECROLE_KNOWN_PPG)
+ - Supported values: SECROLE_KNOWN_PPG, SECROLE_ANY_PUSH_SOURCE
-
## Remarks
@@ -160,41 +117,11 @@ Security roles allow or restrict access to device resources. The security role i
The following security roles are supported.
-
-
-
-
-
-
-
-
-
Security role
-
Decimal value
-
Description
-
-
-
-
-
SECROLE_OPERATOR_TPS
-
128
-
Trusted Provisioning Server.
-
Assigned to WAP messages that come from a Push Initiator that is authenticated (SECROLE_PPG_AUTH) by a trusted Push Proxy Gateway (SECROLE_TRUSTED_PPG), and where the Uniform Resource Identifier (URI) of the Push Initiator corresponds to the URI of the Trusted Provisioning Server (TPS) on the device.
-
The mobile operator can determine whether this role and the SECROLE_OPERATOR role require the same permissions.
-
-
-
SECROLE_KNOWN_PPG
-
256
-
Known Push Proxy Gateway.
-
Messages assigned this role indicate that the device knows the address to the Push Proxy Gateway.
-
-
-
SECROLE_ANY_PUSH_SOURCE
-
4096
-
Push Router.
-
Messages received by the push router will be assigned to this role.
-
-
-
+|Security role|Decimal value|Description|
+|--- |--- |--- |
+|SECROLE_OPERATOR_TPS|128|Trusted Provisioning Server. Assigned to WAP messages that come from a Push Initiator that is authenticated (SECROLE_PPG_AUTH) by a trusted Push Proxy Gateway (SECROLE_TRUSTED_PPG), and where the Uniform Resource Identifier (URI) of the Push Initiator corresponds to the URI of the Trusted Provisioning Server (TPS) on the device. The mobile operator can determine whether this role and the SECROLE_OPERATOR role require the same permissions.|
+|SECROLE_KNOWN_PPG|256|Known Push Proxy Gateway. Messages assigned this role indicate that the device knows the address to the Push Proxy Gateway.|
+|SECROLE_ANY_PUSH_SOURCE|4096|Push Router. Messages received by the push router will be assigned to this role.|
@@ -271,28 +198,10 @@ Querying a security policy:
The following table shows the Microsoft custom elements that this Configuration Service Provider supports for OMA Client Provisioning.
-
-
-
-
-
-
-
-
Elements
-
Available
-
-
-
-
-
parm-query
-
Yes
-
-
-
noparm
-
Yes. If this is used, then the policy is set to 0 by default (corresponding to the most restrictive of policy values).
-
-
-
+|Elements|Available|
+|--- |--- |
+|parm-query|Yes|
+|noparm|Yes. If this is used, then the policy is set to 0 by default (corresponding to the most restrictive of policy values).|
@@ -300,13 +209,3 @@ The following table shows the Microsoft custom elements that this Configuration
[Configuration service provider reference](configuration-service-provider-reference.md)
-
-
-
-
-
-
-
-
-
-
diff --git a/windows/client-management/mdm/structure-of-oma-dm-provisioning-files.md b/windows/client-management/mdm/structure-of-oma-dm-provisioning-files.md
index 2b482383bd..00da69a8cb 100644
--- a/windows/client-management/mdm/structure-of-oma-dm-provisioning-files.md
+++ b/windows/client-management/mdm/structure-of-oma-dm-provisioning-files.md
@@ -22,32 +22,10 @@ Each message is composed of a header, specified by the SyncHdr element, and a me
The following table shows the OMA DM versions that are supported.
-
</SyncML>|
+|OMA DM version 1.2|<SyncML xmlns='SYNCML:SYNCML1.2'>
</SyncML>|
## File format
@@ -103,7 +81,8 @@ This information is used to by the client device to properly manage the DM sessi
The following example shows the header component of a DM message. In this case, OMA DM version 1.2 is used as an example only.
-> **Note** The <LocURI> node value for the <Source> element in the SyncHdr of the device-generated DM package should be the same as the value of ./DevInfo/DevID. For more information about DevID, see [DevInfo configuration service provider](devinfo-csp.md).
+> [!NOTE]
+> The `` node value for the `` element in the SyncHdr of the device-generated DM package should be the same as the value of ./DevInfo/DevID. For more information about DevID, see [DevInfo configuration service provider](devinfo-csp.md).
@@ -147,7 +126,7 @@ The following example shows the body component of a DM message. In this example,
When using SyncML for OMA DM provisioning, a LocURI in SyncBody can have a "." as a valid segment name only in the first segment. However, a "." is not a valid segment name for the other segments. For example, the following LocURI is not valid because the segment name of the seventh segment is a ".".
-```
+```xml
./Vendor/MSFT/Registry/HKLM/Security/./Test
```
@@ -188,11 +167,3 @@ The following example illustrates how to use the Replace command to update a dev
```
-
-
-
-
-
-
-
-
diff --git a/windows/client-management/mdm/supl-csp.md b/windows/client-management/mdm/supl-csp.md
index e41a8c2374..d2df672d1e 100644
--- a/windows/client-management/mdm/supl-csp.md
+++ b/windows/client-management/mdm/supl-csp.md
@@ -16,56 +16,30 @@ ms.date: 09/12/2019
The SUPL configuration service provider is used to configure the location client, as shown in the following table:
-
-
-
-
-
-
-
-
-
Location Service
-
SUPL
-
V2 UPL
-
-
-
-
-
Connection type
-
All connections other than CDMA
-
CDMA
-
-
-
Configuration
-
-
Settings that need to get pushed to the GNSS driver to configure the SUPL behavior:
-
-
Address of the Home SUPL (H-SLP) server.
-
H-SLP server certificate.
-
Positioning method.
-
Version of the protocol to use by default.
-
-
MCC/MNC value pairs which are used to specify which networks' UUIC the SUPL account matches.
-
-
-
Address of the server — a mobile positioning center for non-trusted mode.
-
The positioning method used by the MPC for non-trusted mode.
-
-
-
-
+- **Location Service**: Connection type
+ - **SUPL**: All connections other than CDMA
+ - **V2 UPL**: CDMA
-
+- **Location Service**: Configuration
+ - **SUPL**:
+ - Settings that need to get pushed to the GNSS driver to configure the SUPL behavior:
+ - Address of the Home SUPL (H-SLP) server.
+ - H-SLP server certificate.
+ - Positioning method.
+ - Version of the protocol to use by default.
+ - MCC/MNC value pairs which are used to specify which networks' UUIC the SUPL account matches.
+ - **V2 UPL**:
+ - Address of the server — a mobile positioning center for non-trusted mode.
+ - The positioning method used by the MPC for non-trusted mode.
The SUPL or V2 UPL connection will be reconfigured every time the device is rebooted, a new UICC is inserted, or new settings are provisioned by using OMA Client Provisioning, OMA DM, or test tools. When the device is in roaming mode, it reverts to Mobile Station Standalone mode, in which only the built–in Microsoft location components are used.
The following shows the SUPL configuration service provider management object in tree format as used by OMA DM and OMA Client Provisioning.
-> **Note** This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION capability to be accessed from a network configuration application.
+> [!NOTE]
+> This configuration service provider requires the ID\_CAP\_CSP\_FOUNDATION capability to be accessed from a network configuration application.
-
-
-```
+```console
./Vendor/MSFT/
SUPL
----SUPL1
@@ -97,6 +71,7 @@ SUPL
--------NIDefaultTimeout
--------ServerAccessInterval
```
+
**SUPL1**
Required for SUPL. Defines the account for the SUPL Enabled Terminal (SET) node. Only one SUPL account is supported at a given time.
@@ -126,50 +101,21 @@ For OMA DM, if the format for this node is incorrect the entry will be ignored a
**HighAccPositioningMethod**
Optional. Specifies the positioning method that the SUPL client will use for mobile originated position requests. The value can be one of the following integers:
-
-
-
-
-
-
-
-
Value
-
Description
-
-
-
-
-
0
-
None: The device uses the default positioning method. In this default mode, the GNSS obtains assistance (time injection, coarse position injection and ephemeris data) from the Microsoft Positioning Service.
-
-
-
1
-
Mobile Station Assisted: The device contacts the H-SLP server to obtain a position. The H-SLP does the calculation of the position and returns it to the device.
-
-
-
2
-
Mobile Station Based: The device obtains location-aiding data (almanac, ephemeris data, time and coarse initial position of the device) from the H-SLP server, and the device uses this information to help GPS obtain a fix. All position calculations are done in the device.
-
-
-
3
-
Mobile Station Standalone: The device obtains assistance as required from the Microsoft location services.
-
-
-
4
-
OTDOA
-
-
-
5
-
AFLT
-
-
-
+|Value|Description|
+|--- |--- |
+|0|None: The device uses the default positioning method. In this default mode, the GNSS obtains assistance (time injection, coarse position injection and ephemeris data) from the Microsoft Positioning Service.|
+|1|Mobile Station Assisted: The device contacts the H-SLP server to obtain a position. The H-SLP does the calculation of the position and returns it to the device.|
+|2|Mobile Station Based: The device obtains location-aiding data (almanac, ephemeris data, time and coarse initial position of the device) from the H-SLP server, and the device uses this information to help GPS obtain a fix. All position calculations are done in the device.|
+|3|Mobile Station Standalone: The device obtains assistance as required from the Microsoft location services.|
+|4|OTDOA|
+|5|AFLT|
The default is 0. The default method in Windows devices provides high-quality assisted GNSS positioning for mobile originated position requests without loading the mobile operator’s network or location services.
-> **Important** The Mobile Station Assisted, OTDOA, and AFLT positioning methods must only be configured for test purposes.
+> [!IMPORTANT]
+> The Mobile Station Assisted, OTDOA, and AFLT positioning methods must only be configured for test purposes.
@@ -180,44 +126,13 @@ Optional. Boolean. Specifies whether the location toggle on the **location** scr
This value manages the settings for both SUPL and v2 UPL. If a device is configured for both SUPL and V2 UPL and these values differ, the SUPL setting will always be used.
-
-
-
-
-
-
-
-
-
Location toggle setting
-
LocMasterSwitchDependencyNII setting
-
NI request processing allowed
-
-
-
-
-
On
-
0
-
Yes
-
-
-
On
-
1
-
Yes
-
-
-
Off
-
0
-
Yes
-
-
-
Off
-
1
-
No (unless privacyOverride is set)
-
-
-
+|Location toggle setting|LocMasterSwitchDependencyNII setting|NI request processing allowed|
+|--- |--- |--- |
+|On|0|Yes|
+|On|1|Yes|
+|Off|0|Yes|
+|Off|1|No (unless privacyOverride is set)|
-
When the location toggle is set to Off and this value is set to 1, the following application requests will fail:
@@ -309,46 +224,18 @@ Optional. The address of the Position Determination Entity (PDE), in the format
**PositioningMethod\_MR**
Optional. Specifies the positioning method that the SUPL client will use for mobile originated position requests. The value can be one of the following integers:
-
-
-
-
-
-
-
-
Value
-
Description
-
-
-
-
-
0
-
None: The device uses the default positioning method. In this default mode, the GNSS obtains assistance (time injection, coarse position injection, and ephemeris data) from the Microsoft Positioning Service.
-
-
-
1
-
Mobile Station Assisted: The device contacts the H-SLP server to obtain a position. The H-SLP does the calculation of the position and returns it to the device.
-
-
-
2
-
Mobile Station Based: The device obtains location-aiding data (almanac, ephemeris data, time and coarse initial position of the device) from the H-SLP server, and the device uses this information to help GPS obtain a fix. All position calculations are done in the device.
-
-
-
3
-
Mobile Station Standalone: The device obtains assistance as required from the Microsoft location services.
-
-
-
4
-
AFLT
-
-
-
-
-
+|Value|Description|
+|--- |--- |
+|0|None: The device uses the default positioning method. In this default mode, the GNSS obtains assistance (time injection, coarse position injection, and ephemeris data) from the Microsoft Positioning Service.|
+|1|Mobile Station Assisted: The device contacts the H-SLP server to obtain a position. The H-SLP does the calculation of the position and returns it to the device.|
+|2|Mobile Station Based: The device obtains location-aiding data (almanac, ephemeris data, time and coarse initial position of the device) from the H-SLP server, and the device uses this information to help GPS obtain a fix. All position calculations are done in the device.|
+|3|Mobile Station Standalone: The device obtains assistance as required from the Microsoft location services.|
+|4|AFLT|
The default is 0. The default method provides high-quality assisted GNSS positioning for mobile originated position requests without loading the mobile operator’s network or location services.
-> **Important** The Mobile Station Assisted and AFLT positioning methods must only be configured for test purposes.
+> [!IMPORTANT]
+> The Mobile Station Assisted and AFLT positioning methods must only be configured for test purposes.
@@ -359,44 +246,12 @@ Optional. Boolean. Specifies whether the location toggle on the **location** scr
This value manages the settings for both SUPL and v2 UPL. If a device is configured for both SUPL and V2 UPL and these values differ, the SUPL setting will always be used.
-
-
-
-
-
-
-
-
-
Location toggle setting
-
LocMasterSwitchDependencyNII setting
-
NI request processing allowed
-
-
-
-
-
On
-
0
-
Yes
-
-
-
On
-
1
-
Yes
-
-
-
Off
-
0
-
Yes
-
-
-
Off
-
1
-
No (unless privacyOverride is set)
-
-
-
-
-
+|Location toggle setting|LocMasterSwitchDependencyNII setting|NI request processing allowed|
+|--- |--- |--- |
+|On|0|Yes|
+|On|1|Yes|
+|Off|0|Yes|
+|Off|1|No (unless privacyOverride is set)|
When the location toggle is set to Off and this value is set to 1, the following application requests will fail:
@@ -584,32 +439,12 @@ Adding a SUPL account to a device. Values in italic must be replaced with correc
The following table shows the Microsoft custom elements that this configuration service provider supports for OMA Client Provisioning.
-
Top level query: No|
## Related topics
-[Configuration service provider reference](configuration-service-provider-reference.md)
\ No newline at end of file
+[Configuration service provider reference](configuration-service-provider-reference.md)
diff --git a/windows/client-management/mdm/surfacehub-csp.md b/windows/client-management/mdm/surfacehub-csp.md
index 147c460f3b..8c596e748e 100644
--- a/windows/client-management/mdm/surfacehub-csp.md
+++ b/windows/client-management/mdm/surfacehub-csp.md
@@ -206,63 +206,22 @@ SurfaceHub
The data type is boolean. Supported operation is Get and Replace.
**DeviceAccount/ErrorContext**
-
If there is an error calling ValidateAndCommit, there is additional context for that error in this node. Here are the possible error values:
-
-
-
-
-
-
-
-
-
ErrorContext value
-
Stage where error occurred
-
Description and suggestions
-
-
-
-
-
1
-
Unknown
-
-
-
-
2
-
Populating account
-
Unable to retrieve account details using the username and password you provided.
-
-
For Azure AD accounts, ensure that UserPrincipalName and Password are valid.
-
For AD accounts, ensure that DomainName, UserName, and Password are valid.
-
Ensure that the specified account has an Exchange server mailbox.
-
-
-
-
3
-
Populating Exchange server address
-
Unable to auto-discover your Exchange server address. Try to manually specify the Exchange server address using the ExchangeServer field.
-
-
-
4
-
Validating Exchange server address
-
Unable to validate the Exchange server address. Ensure that the ExchangeServer field is valid.
-
-
-
5
-
Saving account information
-
Unable to save account details to the system.
-
-
-
6
-
Validating EAS policies
-
The device account uses an unsupported EAS policy. Make sure the EAS policy is configured correctly according to the admin guide.
-
-
-
-
-
The data type is integer. Supported operation is Get.
+If there is an error calling ValidateAndCommit, there is additional context for that error in this node. Here are the possible error values:
+
+| ErrorContext value | Stage where error occurred | Description and suggestions |
+| --- | --- | --- |
+| 1 | Unknown | |
+| 2 | Populating account | Unable to retrieve account details using the username and password you provided.
-For Azure AD accounts, ensure that UserPrincipalName and Password are valid. -For AD accounts, ensure that DomainName, UserName, and Password are valid. -Ensure that the specified account has an Exchange server mailbox. |
+| 3 | Populating Exchange server address | Unable to auto-discover your Exchange server address. Try to manually specify the Exchange server address using the ExchangeServer field. |
+| 4 | Validating Exchange server address | Unable to validate the Exchange server address. Ensure that the ExchangeServer field is valid. |
+| 5 | Saving account information | Unable to save account details to the system. |
+| 6 | Validating EAS policies | The device account uses an unsupported EAS policy. Make sure the EAS policy is configured correctly according to the admin guide. |
+
+The data type is integer. Supported operation is Get.
**MaintenanceHoursSimple/Hours**
+
Wireless channel to use for Miracast operation. The supported channels are defined by the Wi-Fi Alliance Wi-Fi Direct specification.
-
-
-
-
-
-
-
-
Works with all Miracast senders in all regions
-
1, 3, 4, 5, 6, 7, 8, 9, 10, 11
-
-
-
Works with all 5ghz band Miracast senders in all regions
-
36, 40, 44, 48
-
-
-
Works with all 5ghz band Miracast senders in all regions except Japan
-
149, 153, 157, 161, 165
-
-
-
+|Compatibility|Values|
+|--- |--- |
+|Works with all Miracast senders in all regions|1, 3, 4, 5, 6, 7, 8, 9, 10, 11|
+|Works with all 5ghz band Miracast senders in all regions|36, 40, 44, 48|
+|Works with all 5ghz band Miracast senders in all regions except Japan|149, 153, 157, 161, 165|
The default value is 255. Outside of regulatory concerns, if the channel is configured incorrectly the driver will either not boot, or will broadcast on the wrong channel (which senders won't be looking for).
@@ -397,50 +341,19 @@ SurfaceHub
The data type is integer. Supported operation is Get and Replace.
diff --git a/windows/deployment/usmt/offline-migration-reference.md b/windows/deployment/usmt/offline-migration-reference.md
index 3406fdc071..25d44a98a8 100644
--- a/windows/deployment/usmt/offline-migration-reference.md
+++ b/windows/deployment/usmt/offline-migration-reference.md
@@ -16,7 +16,6 @@ ms.topic: article
# Offline Migration Reference
-
Offline migration enables the ScanState tool to run inside a different Windows® operating system than the Windows operating system from which ScanState is gathering files and settings. There are two primary offline scenarios:
- **Windows PE.** The ScanState tool can be run from within Windows PE, gathering files and settings from the offline Windows operating system on that machine.
@@ -33,7 +32,6 @@ When you use User State Migration Tool (USMT) 10.0 to gather and restore user s
## In This topic
-
- [What Will Migrate Offline?](#bkmk-whatwillmigrate)
- [What Offline Environments are Supported?](#bkmk-offlineenvironments)
@@ -48,7 +46,6 @@ When you use User State Migration Tool (USMT) 10.0 to gather and restore user s
## What Will Migrate Offline?
-
The following user data and settings migrate offline, similar to an online migration:
- Data and registry keys specified in MigXML
@@ -67,42 +64,18 @@ For exceptions to what you can migrate offline, see [What Does USMT Migrate?](us
## What Offline Environments are Supported?
-
The following table defines the supported combination of online and offline operating systems in USMT.
-
-
-
-
-
-
-
-
Running Operating System
-
Offline Operating System
-
-
-
-
-
WinPE 5.0 or greater, with the MSXML library
-
Windows Vista, Windows 7, Windows 8, Windows 10
-
-
-
Windows 7, Windows 8, Windows 10
-
Windows.old directory
-
-
-
-
-
+|Running Operating System|Offline Operating System|
+|--- |--- |
+|WinPE 5.0 or greater, with the MSXML library|Windows Vista, Windows 7, Windows 8, Windows 10|
+|Windows 7, Windows 8, Windows 10|Windows.old directory|
**Note**
It is possible to run the ScanState tool while the drive remains encrypted by suspending Windows BitLocker Drive Encryption before booting into WinPE. For more information, see [this Microsoft site](/previous-versions/windows/it-pro/windows-7/ee424315(v=ws.10)).
-
-
## User-Group Membership and Profile Control
-
User-group membership is not preserved during offline migrations. You must configure a **<ProfileControl>** section in the Config.xml file to specify the groups that the migrated users should be made members of. The following example places all migrated users into the Users group:
``` xml
@@ -125,84 +98,27 @@ For information about the format of a Config.xml file, see [Config.xml File](usm
## Command-Line Options
-
An offline migration can either be enabled by using a configuration file on the command line, or by using one of the following command line options:
-
-
-
-
-
-
-
-
-
Component
-
Option
-
Description
-
-
-
-
-
ScanState.exe
-
/offline:<path to offline.xml>
-
This command-line option enables the offline-migration mode and requires a path to an Offline.xml configuration file.
-
-
-
ScanState.exe
-
/offlineWinDir:<Windows directory>
-
This command-line option enables the offline-migration mode and starts the migration from the location specified. It is only for use in WinPE offline scenarios where the migration is occurring from a Windows directory.
-
-
-
ScanState.exe
-
/OfflineWinOld:<Windows.old directory>
-
This command-line option enables the offline migration mode and starts the migration from the location specified. It is only intended to be used in Windows.old migration scenarios, where the migration is occurring from a Windows.old directory.
-
-
-
+|Component|Option|Description|
+|--- |--- |--- |
+|ScanState.exe|**/offline:***<path to offline.xml>*|This command-line option enables the offline-migration mode and requires a path to an Offline.xml configuration file.|
+|ScanState.exe|**/offlineWinDir:***<Windows directory>*|This command-line option enables the offline-migration mode and starts the migration from the location specified. It is only for use in WinPE offline scenarios where the migration is occurring from a Windows directory.|
+|ScanState.exe|**/OfflineWinOld:***<Windows.old directory>*|This command-line option enables the offline migration mode and starts the migration from the location specified. It is only intended to be used in Windows.old migration scenarios, where the migration is occurring from a Windows.old directory.|
-
-
-You can use only one of the **/offline**,**/offlineWinDir** , or **/OfflineWinOld** command-line options at a time; USMT does not support using more than one together.
+You can use only one of the **/offline**, **/offlineWinDir**, or **/OfflineWinOld** command-line options at a time; USMT does not support using more than one together.
## Environment Variables
-
The following system environment variables are necessary in the scenarios outlined below.
-
-
-
-
-
-
-
-
-
Variable
-
Value
-
Scenario
-
-
-
-
-
USMT_WORKING_DIR
-
Full path to a working directory
-
Required when USMT binaries are located on read-only media, which does not support the creation of log files or temporary storage. To set the system environment variable, at a command prompt type the following:
-
Set USMT_WORKING_DIR=[path to working directory]
-
-
-
MIG_OFFLINE_PLATFORM_ARCH
-
32 or 64
-
While operating offline, this environment variable defines the architecture of the offline system, if the system does not match the WinPE and Scanstate.exe architecture. This environment variable enables the 32-bit ScanState application to gather data from a computer with 64-bit architecture, or the 64-bit ScanState application to gather data from a computer with 32-bit architecture. This is required when auto-detection of the offline architecture doesn't function properly, for example, when the source system is running a 64-bit version of Windows XP. For example, to set this system environment variable for a 32-bit architecture, at a command prompt type the following:
-
Set MIG_OFFLINE_PLATFORM_ARCH=32
-
-
-
-
-
+|Variable|Value|Scenario|
+|--- |--- |--- |
+|USMT_WORKING_DIR|Full path to a working directory|Required when USMT binaries are located on read-only media, which does not support the creation of log files or temporary storage. To set the system environment variable, at a command prompt type the following:
Set USMT_WORKING_DIR=[path to working directory]
|
+|MIG_OFFLINE_PLATFORM_ARCH|32 or 64|While operating offline, this environment variable defines the architecture of the offline system, if the system does not match the WinPE and Scanstate.exe architecture. This environment variable enables the 32-bit ScanState application to gather data from a computer with 64-bit architecture, or the 64-bit ScanState application to gather data from a computer with 32-bit architecture. This is required when auto-detection of the offline architecture doesn't function properly, for example, when the source system is running a 64-bit version of Windows XP. For example, to set this system environment variable for a 32-bit architecture, at a command prompt type the following:
Set MIG_OFFLINE_PLATFORM_ARCH=32
|
## Offline.xml Elements
-
Use an offline.xml file when running the ScanState tool on a computer that has multiple Windows directories. The offline.xml file specifies which directories to scan for windows files. An offline.xml file can be used with the /offline option as an alternative to specifying a single Windows directory path with the /offlineDir option.
### <offline>
@@ -256,8 +172,4 @@ The following XML example illustrates some of the elements discussed earlier in
## Related topics
-
[Plan Your Migration](usmt-plan-your-migration.md)
-
-
-
diff --git a/windows/deployment/usmt/understanding-migration-xml-files.md b/windows/deployment/usmt/understanding-migration-xml-files.md
index e59e727ee5..f6a8ab4221 100644
--- a/windows/deployment/usmt/understanding-migration-xml-files.md
+++ b/windows/deployment/usmt/understanding-migration-xml-files.md
@@ -16,14 +16,12 @@ ms.topic: article
# Understanding Migration XML Files
-
-You can modify the behavior of a basic User State Migration Tool (USMT)10.0 migration by using XML files; these files provide instructions on where and how the USMT tools should gather and apply files and settings. USMT includes three XML files that you can use to customize a basic migration: the MigDocs.xml and MigUser.xml files, which modify how files are discovered on the source computer, and the MigApps.xml file, which is required in order to migrate supported application settings. You can also create and edit custom XML files and a Config.xml file to further customize your migration.
+You can modify the behavior of a basic User State Migration Tool (USMT) 10.0 migration by using XML files; these files provide instructions on where and how the USMT tools should gather and apply files and settings. USMT includes three XML files that you can use to customize a basic migration: the MigDocs.xml and MigUser.xml files, which modify how files are discovered on the source computer, and the MigApps.xml file, which is required in order to migrate supported application settings. You can also create and edit custom XML files and a Config.xml file to further customize your migration.
This topic provides an overview of the default and custom migration XML files and includes guidelines for creating and editing a customized version of the MigDocs.xml file. The MigDocs.xml file uses the new **GenerateDocPatterns** function available in USMT to automatically find user documents on a source computer.
## In This topic
-
[Overview of the Config.xml file](#bkmk-config)
[Overview of the MigApp.xml file](#bkmk-migapp)
@@ -50,27 +48,20 @@ This topic provides an overview of the default and custom migration XML files an
## Overview of the Config.xml file
+The Config.xml file is the configuration file created by the `/genconfig` option of the ScanState tool; it can be used to modify which operating-system components are migrated by USMT. The Config.xml file can be used with other XML files, such as in the following example: `scanstate /i:migapps.xml /i:migdocs.xml /genconfig:c:\myFolder\config.xml`. When used this way, the Config.xml file tightly controls aspects of the migration, including user profiles, data, and settings, without modifying or creating other XML files. For more information about the Config.xml file, see [Customize USMT XML Files](usmt-customize-xml-files.md) and [Config.xml File](usmt-configxml-file.md).
-The Config.xml file is the configuration file created by the `/genconfig` option of the ScanState tool; it can be used to modify which operating-system components are migrated by USMT. The Config.xml file can be used in conjunction with other XML files, such as in the following example: `scanstate /i:migapps.xml /i:migdocs.xml /genconfig:c:\myFolder\config.xml`. When used this way, the Config.xml file tightly controls aspects of the migration, including user profiles, data, and settings, without modifying or creating other XML files. For more information about the Config.xml file, see [Customize USMT XML Files](usmt-customize-xml-files.md) and [Config.xml File](usmt-configxml-file.md).
-
-**Note**
-When modifying the XML elements in the Config.xml file, you should edit an element and set the **migrate** property to **no**, rather than deleting the element from the file. If you delete the element instead of setting the property, the component may still be migrated by rules in other XML files.
-
-
+> [!NOTE]
+> When modifying the XML elements in the Config.xml file, you should edit an element and set the **migrate** property to **no**, rather than deleting the element from the file. If you delete the element instead of setting the property, the component may still be migrated by rules in other XML files.
## Overview of the MigApp.xml file
-
The MigApp.xml file installed with USMT includes instructions to migrate the settings for the applications listed in [What Does USMT Migrate?](usmt-what-does-usmt-migrate.md). You must include the MigApp.xml file when using the ScanState and LoadState tools, by using the `/i` option in order to migrate application settings. The MigDocs.xml and MigUser.xml files do not migrate application settings. You can create a custom XML file to include additional applications. For more information, see [Customize USMT XML Files](usmt-customize-xml-files.md).
-**Important**
-The MigApps.xml file will only detect and migrate .pst files that are linked to Microsoft Office Outlook. See the [Sample migration rules for customized versions of XML files](#bkmk-samples) section of this document for more information about migrating .pst files that are not linked to Outlook.
-
-
+> [!Important]
+> The MigApps.xml file will only detect and migrate .pst files that are linked to Microsoft Office Outlook. For more information about migrating .pst files that are not linked to Outlook, see the [Sample migration rules for customized versions of XML files](#bkmk-samples).
## Overview of the MigDocs.xml file
-
The MigDocs.xml file uses the new **GenerateDocPatterns** helper function to create instructions for USMT to migrate files from the source computer, based on the location of the files. You can use the MigDocs.xml file with the ScanState and LoadState tools to perform a more targeted migration than using USMT without XML instructions.
The default MigDocs.xml file migrates the following:
@@ -141,12 +132,11 @@ You can also use the **/genmigxml** option with the ScanState tool to review and
## Overview of the MigUser.xml file
-
-The MigUser.xml file includes instructions for USMT to migrate user files based on file name extensions. You can use the MigUser.xml file with the ScanState and LoadState tools to perform a more targeted migration than using USMT without XML instructions. The MigUser.xml file will gather all files from the standard user-profile folders, as well as any files on the computer with the specified file name extensions.
+The MigUser.xml file includes instructions for USMT to migrate user files based on file name extensions. You can use the MigUser.xml file with the ScanState and LoadState tools to perform a more targeted migration than using USMT without XML instructions. The MigUser.xml file will gather all files from the standard user-profile folders, and any files on the computer with the specified file name extensions.
The default MigUser.xml file migrates the following:
-- All files from the standard user-profile folders which are described as:
+- All files from the standard user-profile folders, which are described as:
- CSIDL\_MYVIDEO
@@ -166,7 +156,7 @@ The default MigUser.xml file migrates the following:
- Files with the following extensions:
- .qdf, .qsd, .qel, .qph, .doc\*, .dot\*, .rtf, .mcw, .wps, .scd, .wri, .wpd, .xl\*, .csv, .iqy, .dqy, .oqy, .rqy, .wk\*, .wq1, .slk, .dif, .ppt\*, .pps\*, .pot\*, .sh3, .ch3, .pre, .ppa, .txt, .pst, .one\*, .vl\*, .vsd, .mpp, .or6, .accdb, .mdb, .pub
+ `.qdf`, `.qsd`, `.qel`, `.qph`, `.doc\*`, `.dot\*`, `.rtf`, `.mcw`, `.wps`, `.scd`, `.wri`, `.wpd`, `.xl\*`, `.csv`, `.iqy`, `.dqy`, `.oqy`, `.rqy`, `.wk\*`, `.wq1`, `.slk`, `.dif`, `.ppt\*`, `.pps\*`, `.pot\*`, `.sh3`, `.ch3`, `.pre`, `.ppa`, `.txt`, `.pst`, `.one\*`, `.vl\*`, `.vsd`, `.mpp`, `.or6`, `.accdb`, `.mdb`, `.pub`
The default MigUser.xml file does not migrate the following:
@@ -180,62 +170,30 @@ The default MigUser.xml file does not migrate the following:
You can make a copy of the MigUser.xml file and modify it to include or exclude standard user-profile folders and file name extensions. If you know all of the extensions for the files you want to migrate from the source computer, use the MigUser.xml file to move all of your relevant data, regardless of the location of the files. However, this may result in a migration that contains more files than intended. For example, if you choose to migrate all .jpg files, you may migrate image files such as thumbnails and logos from legacy applications that are installed on the source computer.
-**Note**
-Each file name extension you include in the rules within the MigUser.xml file increases the amount of time needed for the ScanState tool to gather the files for the migration. If you are migrating more than three hundred file types, you may experience a slow migration. For more information about other ways to organize the migration of your data, see the [Using multiple XML files](#bkmk-multiple) section of this document.
-
-
+> [!NOTE]
+> Each file name extension you include in the rules within the MigUser.xml file increases the amount of time needed for the ScanState tool to gather the files for the migration. If you are migrating more than 300 file types, you may experience a slow migration. For more information about other ways to organize the migration of your data, see the [Using multiple XML files](#bkmk-multiple) section of this document.
## Using multiple XML files
-
You can use multiple XML files with the ScanState and LoadState tools. Each of the default XML files included with or generated by USMT is configured for a specific component of the migration. You can also use custom XML files to supplement these default files with additional migration rules.
-
-
-
-
-
-
-
-
XML migration file
-
Modifies the following components:
-
-
-
-
-
Config.xml file
-
Operating-system components such as desktop wallpaper and background theme.
-
You can also overload config.xml to include some application and document settings by generating the config.xml file with the other default XML files. For more information, see Customize USMT XML Files and Config.xml File.
-
-
-
MigApps.xml file
-
Applications settings.
-
-
-
MigUser.xml or MigDocs.xml files
-
User files and profile settings.
-
-
-
Custom XML files
-
Application settings, user profile settings, or user files, beyond the rules contained in the other XML files.
-
-
-
-
-
+|XML migration file|Modifies the following components:|
+|--- |--- |
+|Config.xml file|Operating-system components such as desktop wallpaper and background theme. You can also overload config.xml to include some application and document settings by generating the config.xml file with the other default XML files. For more information, see [Customize USMT XML Files](usmt-customize-xml-files.md) and [Config.xml File](usmt-configxml-file.md).|
+|MigApps.xml file|Applications settings.|
+|MigUser.xml or MigDocs.xml files|User files and profile settings.|
+|Custom XML files|Application settings, user profile settings, or user files, beyond the rules contained in the other XML files.|
For example, you can use all of the XML migration file types for a single migration, as in the following example:
-```
+```console
Scanstate /config:c:\myFolder\config.xml /i:migapps.xml /i:migdocs.xml /i:customrules.xml
```
### XML rules for migrating user files
-**Important**
-You should not use the MigUser.xml and MigDocs.xml files together in the same command. Using both XML files can result in duplication of some migrated files. This occurs when conflicting target-location instructions are given in each XML file. The target file will be stored once during the migration, but will be applied by each XML file to a different location on the destination computer.
-
-
+> [!IMPORTANT]
+> You should not use the MigUser.xml and MigDocs.xml files together in the same command. Using both XML files can result in duplication of some migrated files. This occurs when conflicting target-location instructions are given in each XML file. The target file will be stored once during the migration, but will be applied by each XML file to a different location on the destination computer.
If your data set is unknown or if many files are stored outside of the standard user-profile folders, the MigDocs.xml is a better choice than the MigUser.xml file, because the MigDocs.xml file will gather a broader scope of data. The MigDocs.xml file migrates folders of data based on location. The MigUser.xml file migrates only the files with the specified file name extensions.
@@ -243,13 +201,10 @@ If you want more control over the migration, you can create custom XML files. Se
## Creating and editing a custom XML file
-
You can use the **/genmigxml** command-line option to determine which files will be included in your migration. The **/genmigxml** option creates a file in a location you specify, so that you can review the XML rules and make modifications as necessary.
-**Note**
-If you reinstall USMT, the default migration XML files will be overwritten and any customizations you make directly to these files will be lost. Consider creating separate XML files for your custom migration rules and saving them in a secure location.
-
-
+> [!NOTE]
+> If you reinstall USMT, the default migration XML files will be overwritten and any customizations you make directly to these files will be lost. Consider creating separate XML files for your custom migration rules and saving them in a secure location.
To generate the XML migration rules file for a source computer:
@@ -259,14 +214,14 @@ To generate the XML migration rules file for a source computer:
3. At the command prompt, type:
- ```
+ ```console
cd /d
scanstate.exe /genmigxml:
```
Where *<USMTpath>* is the location on your source computer where you have saved the USMT files and tools, and *<filepath.xml>* is the full path to a file where you can save the report. For example, type:
- ```
+ ```console
cd /d c:\USMT
scanstate.exe /genmigxml:"C:\Documents and Settings\USMT Tester\Desktop\genMig.xml"
```
@@ -275,46 +230,27 @@ To generate the XML migration rules file for a source computer:
The MigDocs.xml file calls the **GenerateDocPatterns** function, which takes three Boolean values. You can change the settings to modify the way the MigDocs.xml file generates the XML rules for migration.
-
-
-
-
-
-
-
-
-
Setting
-
Value
-
Default Value
-
-
-
-
-
ScanProgramFiles
-
The ScanProgramFiles argument is valid only when the GenerateDocPatterns function is called in a system context. This argument determines whether or not to scan the Program Files directory to gather registered file name extensions for known applications.
-
For example, when set to TRUE, the function discovers and migrates .doc files under the Microsoft Office directory, because .doc is a file name extension registered to a Microsoft Office application. The GenerateDocPatterns function generates this inclusion pattern for .doc files:
If a child folder of an included folder contains an installed application, ScanProgramFiles will also create an exclusion rule for the child folder. All folders under the application folder will be scanned recursively for registered file name extensions.
-
False
-
-
-
IncludePatterns
-
The IncludePatterns argument determines whether to generate exclude or include patterns in the XML. When this argument is set to TRUE, the GenerateDocPatterns function generates include patterns and the function must be added under the <include> element. Changing this argument to FALSE generates exclude patterns and the function must be added under the <exclude> element.
-
True
-
-
-
SystemDrive
-
The SystemDrive argument determines whether to generate patterns for all fixed drives or only for the system drive. Changing this argument to TRUE restricts all patterns to the system drive.
-
False
-
-
-
+- `ScanProgramFiles`: This argument is valid only when the **GenerateDocPatterns** function is called in a system context. This argument determines whether or not to scan the Program Files directory to gather registered file name extensions for known applications.
-
+ **Default value**: False
+
+ For example, when set to **TRUE**, the function discovers and migrates .doc files under the Microsoft Office directory, because .doc is a file name extension registered to a Microsoft Office application. The **GenerateDocPatterns** function generates this inclusion pattern for `.doc` files:
+
+ `C:\Program Files\Microsoft Office[.doc]`
+
+ If a child folder of an included folder contains an installed application, ScanProgramFiles will also create an exclusion rule for the child folder. All folders under the application folder will be scanned recursively for registered file name extensions.
+
+- `IncludePatterns`: This argument determines whether to generate exclude or include patterns in the XML. When this argument is set to **TRUE**, the **GenerateDocPatterns** function generates include patterns and the function must be added under the `` element. Changing this argument to **FALSE** generates exclude patterns and the function must be added under the `` element.
+
+ **Default value**: True
+
+- `SystemDrive`: This argument determines whether to generate patterns for all fixed drives or only for the system drive. Changing this argument to **TRUE** restricts all patterns to the system drive.
+
+ **Default value**: False
**Usage:**
-```
+```console
MigXmlHelper.GenerateDocPatterns ("", "", "")
```
@@ -400,42 +336,24 @@ The user context includes rules for data in the User Profiles directory. When ca
- FOLDERID\_RecordedTV
-**Note**
-Rules contained in a component that is assigned the user context will be run for each user profile on the computer. Files that are scanned multiple times by the MigDocs.xml files will only be copied to the migration store once; however, a large number of rules in the user context can slow down the migration. Use the system context when it is applicable.
+> [!NOTE]
+> Rules contained in a component that is assigned the user context will be run for each user profile on the computer. Files that are scanned multiple times by the MigDocs.xml files will only be copied to the migration store once; however, a large number of rules in the user context can slow down the migration. Use the system context when it is applicable.
-
+ ### Sample migration rules for customized versions of XML files
-### Sample migration rules for customized versions of XML files
-
-**Note**
-For best practices and requirements for customized XML files in USMT, see [Customize USMT XML Files](usmt-customize-xml-files.md) and [General Conventions](usmt-general-conventions.md).
-
-
+> [!NOTE]
+> For best practices and requirements for customized XML files in USMT, see [Customize USMT XML Files](usmt-customize-xml-files.md) and [General Conventions](usmt-general-conventions.md).
### Exclude rules usage examples
In the examples below, the source computer has a .txt file called "new text document" in a directory called "new folder". The default MigDocs.xml behavior migrates the new text document.txt file and all files contained in the "new folder" directory. The rules generated by the function are:
-
-
-
-
-
-
-
-
Rule 1
-
<pattern type="File">d:\new folder[new text document.txt]</pattern>
-
-
-
Rule 2
-
<pattern type="File">d:\new folder[]</pattern>
-
-
-
+| Rule | Syntax |
+|--- |--- |
+|Rule 1|`d:\new folder[new text document.txt]`|
+|Rule 2|`d:\new folder[]`|
-
-
-To exclude the new text document.txt file as well as any .txt files in "new folder", you can do the following:
+To exclude the new text document.txt file and any .txt files in "new folder", you can do the following:
**Example 1: Exclude all .txt files in a folder**
@@ -513,30 +431,17 @@ For locations outside the user profile, such as the Program Files folder, you ca
For more examples of include rules that you can use in custom migration XML files, see [Include Files and Settings](usmt-include-files-and-settings.md).
-**Note**
-For more information about the order of precedence for XML migration rules, see [Conflicts and Precedence](usmt-conflicts-and-precedence.md).
-
-
+> [!NOTE]
+> For more information about the order of precedence for XML migration rules, see [Conflicts and Precedence](usmt-conflicts-and-precedence.md).
## Next steps
-
-You can include additional rules for the migration in the MigDocs.xml file or other XML migration files. For example, you can use the <locationModify> element to move files from the folder where they were gathered to a different folder, when they are applied to the destination computer.
+You can include additional rules for the migration in the MigDocs.xml file or other XML migration files. For example, you can use the `` element to move files from the folder where they were gathered to a different folder, when they are applied to the destination computer.
You can use an XML schema (MigXML.xsd) file to validate the syntax of your customized XML files. For more information, see [USMT Resources](usmt-resources.md).
## Related topics
-
[Exclude Files and Settings](usmt-exclude-files-and-settings.md)
[Include Files and Settings](usmt-include-files-and-settings.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-choose-migration-store-type.md b/windows/deployment/usmt/usmt-choose-migration-store-type.md
index 6985683c08..871da5bf3b 100644
--- a/windows/deployment/usmt/usmt-choose-migration-store-type.md
+++ b/windows/deployment/usmt/usmt-choose-migration-store-type.md
@@ -16,51 +16,19 @@ ms.topic: article
# Choose a Migration Store Type
-
One of the main considerations for planning your migration is to determine which migration store type best meets your needs. As part of these considerations, determine how much space is required to run the User State Migration Tool (USMT) 10.0 components on your source and destination computers, and how much space is needed to create and host the migration store, whether you are using a local share, network share, or storage device. The final consideration is ensuring that user date integrity is maintained by encrypting the migration store.
## In This Section
-
-
Learn about the using migration store encryption to protect user data integrity during a migration.
-
-
-
-
-
+| Link | Description |
+|--- |--- |
+|[Migration Store Types Overview](migration-store-types-overview.md)|Choose the migration store type that works best for your needs and migration scenario.|
+|[Estimate Migration Store Size](usmt-estimate-migration-store-size.md)|Estimate the amount of disk space needed for computers in your organization based on information about your organization's infrastructure.|
+|[Hard-Link Migration Store](usmt-hard-link-migration-store.md)|Learn about hard-link migration stores and the scenarios in which they are used.|
+|[Migration Store Encryption](usmt-migration-store-encryption.md)|Learn about the using migration store encryption to protect user data integrity during a migration.|
## Related topics
-
[Plan Your Migration](usmt-plan-your-migration.md)
[User State Migration Tool (USMT) How-to topics](usmt-how-to.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-command-line-syntax.md b/windows/deployment/usmt/usmt-command-line-syntax.md
index 85adbc467d..0631a98022 100644
--- a/windows/deployment/usmt/usmt-command-line-syntax.md
+++ b/windows/deployment/usmt/usmt-command-line-syntax.md
@@ -16,40 +16,12 @@ ms.topic: article
# User State Migration Tool (USMT) Command-line Syntax
-
The User State Migration Tool (USMT) 10.0 migrates user files and settings during large deployments of Windows. To improve and simplify the migration process, USMT captures desktop, network, and application settings in addition to a user's files. USMT then migrates these items to a new Windows installation.
## In This Section
-
-
Lists the command-line options for using the UsmtUtils tool.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+| Link | Description |
+|--- |--- |
+|[ScanState Syntax](usmt-scanstate-syntax.md)|Lists the command-line options for using the ScanState tool.|
+|[LoadState Syntax](usmt-loadstate-syntax.md)|Lists the command-line options for using the LoadState tool.|
+|[UsmtUtils Syntax](usmt-utilities.md)|Lists the command-line options for using the UsmtUtils tool.|
diff --git a/windows/deployment/usmt/usmt-configxml-file.md b/windows/deployment/usmt/usmt-configxml-file.md
index 084c869c9a..ed444aa11e 100644
--- a/windows/deployment/usmt/usmt-configxml-file.md
+++ b/windows/deployment/usmt/usmt-configxml-file.md
@@ -16,10 +16,8 @@ ms.topic: article
# Config.xml File
-
## Config.xml File
-
The Config.xml file is an optional User State Migration Tool (USMT) 10.0 file that you can create using the **/genconfig** option with the ScanState.exe tool. If you want to include all of the default components, and do not want to change the default store-creation or profile-migration behavior, you do not need to create a Config.xml file.
However, if you are satisfied with the default migration behavior defined in the MigApp.xml, MigUser.xml and MigDocs.xml files, but you want to exclude certain components, you can create and modify a Config.xml file and leave the other .xml files unchanged. For example, you must create and modify the Config.xml file if you want to exclude any of the operating-system settings that are migrated. It is necessary to create and modify this file if you want to change any of the default store-creation or profile-migration behavior.
@@ -31,11 +29,8 @@ For more information about using the Config.xml file with other migration files,
**Note**
To exclude a component from the Config.xml file, set the **migrate** value to **"no"**. Deleting the XML tag for the component from the Config.xml file will not exclude the component from your migration.
-
-
## In this topic
-
In USMT there are new migration policies that can be configured in the Config.xml file. For example, you can configure additional **<ErrorControl>**, **<ProfileControl>**, and **<HardLinkStoreControl>** options. The following elements and parameters are for use in the Config.xml file only.
[<Policies>](#bkmk-policies)
@@ -74,14 +69,12 @@ In USMT there are new migration policies that can be configured in the Config.xm
## <Policies>
-
The **<Policies>** element contains elements that describe the policies that USMT follows while creating a migration store. Valid children of the **<Policies>** element are **<ErrorControl>** and **<HardLinkStoreControl>**. The **<Policies>** element is a child of **<Configuration>**.
Syntax: ``
## <ErrorControl>
-
The **<ErrorControl>** element is an optional element you can configure in the Config.xml file. The configurable **<ErrorControl>** rules support only the environment variables for the operating system that is running and the currently logged-on user. As a workaround, you can specify a path using the (\*) wildcard character.
- **Number of occurrences**: Once for each component
@@ -108,10 +101,8 @@ Additionally, the order in the **<ErrorControl>** section implies priority
```
-**Important**
-The configurable **<ErrorControl>** rules support only the environment variables for the operating system that is running and the currently logged-on user. As a workaround, you can specify a path using the (\*) wildcard character.
-
-
+> [!IMPORTANT]
+> The configurable **<ErrorControl>** rules support only the environment variables for the operating system that is running and the currently logged-on user. As a workaround, you can specify a path using the (\*) wildcard character.
### <fatal>
@@ -125,35 +116,14 @@ The **<fatal>** element is not required.
Syntax: ``*<pattern>*``
-
-
-
-
-
-
-
-
-
Parameter
-
Required
-
Value
-
-
-
-
-
errorCode
-
No
-
"any" or "specify system error message here"
-
-
-
-
-
+|Parameter|Required|Value|
+|--- |--- |--- |
+|errorCode|No|"any" or "*specify system error message here*"|
You use the **<fatal>** element to specify that errors matching a specific pattern should cause USMT to halt the migration.
## <fileError>
-
The **<fileError>** element is not required.
- **Number of occurrences**: Once for each component
@@ -168,7 +138,6 @@ You use the **<fileError>** element to represent the behavior associated w
## <nonFatal>
-
The **<nonFatal>** element is not required.
- **Number of occurrences**: Once for each component
@@ -179,35 +148,14 @@ The **<nonFatal>** element is not required.
Syntax: ``*<pattern>*``
-
-
-
-
-
-
-
-
-
Parameter
-
Required
-
Value
-
-
-
-
-
<errorCode>
-
No
-
"any" or "specify system error message here". If system error messages are not specified, the default behavior applies the parameter to all system error messages.
-
-
-
-
-
+|Parameter|Required|Value|
+|--- |--- |--- |
+|**<errorCode>**|No|"any" or "*specify system error message here*". If system error messages are not specified, the default behavior applies the parameter to all system error messages.|
You use the **<nonFatal>** element to specify that errors matching a specific pattern should not cause USMT to halt the migration.
## <registryError>
-
The <registryError>element is not required.
- **Number of occurrences**: Once for each component
@@ -218,35 +166,14 @@ The <registryError>element is not required.
Syntax: ``
-
-
-
-
-
-
-
-
-
Parameter
-
Required
-
Value
-
-
-
-
-
<errorCode>
-
No
-
"any" or "specify system error message here". If system error messages are not specified, the default behavior applies the parameter to all system error messages.
-
-
-
-
-
+|Parameter|Required|Value|
+|--- |--- |--- |
+|**<errorCode>**|No|"any" or "*specify system error message here*". If system error messages are not specified, the default behavior applies the parameter to all system error messages.|
You use the **<registryError>** element to specify that errors matching a specific pattern should not cause USMT to halt the migration.
## <HardLinkStoreControl>
-
The **<HardLinkStoreControl>** element contains elements that describe how to handle files during the creation of a hard-link migration store. Its only valid child is **<fileLocked>**.
Syntax: ``
@@ -261,10 +188,8 @@ Syntax: ``
The **<HardLinkStoreControl>** sample code below specifies that hard links can be created to locked files only if the locked file resides somewhere under C:\\Users\\. Otherwise, a file-access error occurs when a locked file is encountered that cannot be copied, even though is technically possible for the link to be created.
-**Important**
-The **<ErrorControl>** section can be configured to conditionally ignore file access errors, based on the file’s location.
-
-
+> [!IMPORTANT]
+> The **<ErrorControl>** section can be configured to conditionally ignore file access errors, based on the file’s location.
``` xml
@@ -282,84 +207,49 @@ The **<ErrorControl>** section can be configured to conditionally ignore f
## <fileLocked>
-
The **<fileLocked>** element contains elements that describe how to handle files that are locked for editing. The rules defined by the **<fileLocked>** element are processed in the order in which they appear in the XML file.
Syntax: ``
## <createHardLink>
-
The **<createHardLink>** element defines a standard MigXML pattern that describes file paths where hard links should be created, even if the file is locked for editing by another application.
Syntax: ``*<pattern>*``
## <errorHardLink>
-
The **<errorHardLink>** element defines a standard MigXML pattern that describes file paths where hard links should not be created if the file is locked for editing by another application. USMT will attempt to copy files under these paths into the migration store. However, if that is not possible, **Error\_Locked** is thrown. This is a standard Windows application programming interface (API) error that can be captured by the **<ErrorControl>** section to either cause USMT to skip the file or abort the migration.
Syntax: ``*<pattern>*``
## <ProfileControl>
-
This element is used to contain other elements that establish rules for migrating profiles, users, and policies around local group membership during the migration. **<ProfileMigration>** is a child of **<Configuration>**.
Syntax: <`ProfileControl> `
## <localGroups>
-
This element is used to contain other elements that establish rules for how to migrate local groups. **<localGroups>** is a child of **<ProfileControl>**.
Syntax: ``
## <mappings>
-
This element is used to contain other elements that establish mappings between groups.
Syntax: ``
## <changeGroup>
-
This element describes the source and destination groups for a local group membership change during the migration. It is a child of **<localGroups>**. The following parameters are defined:
-
-
-
-
-
-
-
-
-
Parameter
-
Required
-
Value
-
-
-
-
-
From
-
Yes
-
A valid local group on the source machine that contains users selected for migration on the command line.
-
-
-
To
-
Yes
-
A local group that the users are to be moved to during the migration.
-
-
-
appliesTo
-
Yes
-
nonmigratedUsers, migratedUsers, AllUsers. This value defines which users the change group operation should apply to.
-
-
-
-
-
+|Parameter|Required|Value|
+|--- |--- |--- |
+|From|Yes|A valid local group on the source machine that contains users selected for migration on the command line.|
+|To|Yes|A local group that the users are to be moved to during the migration.|
+|appliesTo|Yes|nonmigratedUsers, migratedUsers, AllUsers. This value defines which users the change group operation should apply to.|
The valid and required children of **<changeGroup>** are **<include>** and **<exclude>**. Although both can be children at the same time, only one is required.
@@ -367,21 +257,18 @@ Syntax: ``
## <include>
-
This element specifies that its required child, *<pattern>*, should be included in the migration.
Syntax: ````
## <exclude>
-
This element specifies that its required child, *<pattern>*, should be excluded from the migration.
Syntax: ``` `
## Sample Config.xml File
-
Refer to the following sample Config.xml file for additional details about items you can choose to exclude from a migration.
```xml
@@ -577,14 +464,4 @@ Refer to the following sample Config.xml file for additional details about items
## Related topics
-
[USMT XML Reference](usmt-xml-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-conflicts-and-precedence.md b/windows/deployment/usmt/usmt-conflicts-and-precedence.md
index c7dc4a18ce..1236299462 100644
--- a/windows/deployment/usmt/usmt-conflicts-and-precedence.md
+++ b/windows/deployment/usmt/usmt-conflicts-and-precedence.md
@@ -16,7 +16,6 @@ ms.topic: article
# Conflicts and Precedence
-
When you include, exclude, and reroute files and settings, it is important to know how User State Migration Tool (USMT) 10.0 deals with conflicts and precedence. When working with USMT, the following are the most important conflicts and precedence guidelines to keep in mind.
- **If there are conflicting rules within a component, the most specific rule is applied.** However, the <unconditionalExclude> rule is an exception because it takes precedence over all others. Directory names take precedence over file extensions. For examples, see [What happens when there are conflicting include and exclude rules?](#bkmk1) and the first example in [Include and exclude precedence examples](#precexamples)****later in this topic.
@@ -33,7 +32,6 @@ When you include, exclude, and reroute files and settings, it is important to kn
## In this topic
-
**General**
- [What is the relationship between rules that are located within different components?](#bkmk2)
@@ -60,7 +58,6 @@ When you include, exclude, and reroute files and settings, it is important to kn
## General
-
### What is the relationship between rules that are located within different components?
Only rules inside the same component can affect each other, depending on specificity, except for the <unconditionalExclude> rule. Rules that are in different components do not affect each other. If there is an <include> rule in one component and an identical <exclude> rule in another component, the data will be migrated because the two rules are independent of each other.
@@ -129,7 +126,6 @@ USMT does not distinguish the .xml files based on their name or content. It proc
## The <include> and <exclude> rules
-
### What happens when there are conflicting <include> and <exclude> rules?
If there are conflicting rules within a component, the most specific rule is applied, except with the <unconditionalExclude> rule, which takes precedence over all other rules. If the rules are equally specific, then the data will be not be migrated. For example if you exclude a file, and include the same file, the file will not be migrated. If there are conflicting rules within different components, the rules do not affect each other because each component is processed independently.
@@ -159,212 +155,35 @@ These examples explain how USMT deals with <include> and <exclude> r
### Including and excluding files
-
-
-
-
-
-
-
-
-
If you have the following code in the same component
-
Resulting behavior
-
Explanation
-
-
-
-
-
-
Include rule: <pattern type="File">C:\Dir1* []</pattern>
| Migrates all files and subfolders in Dir1 (including all .txt files in C:). | The <exclude> rule does not affect the migration because the <include> rule is more specific. |
+|
Include rule: <pattern type="File">C:\Dir1* []</pattern>
| Nothing will be migrated. | The rules are equally specific, so the <exclude> rule takes precedence over the <include> rule. |
+|
Include rule: C:\Dir1* [.txt]
Exclude rule: C:\Dir1\Dir2* []
| Migrates the .txt files in Dir1 and the .txt files from subfolders other than Dir2. No files are migrated from Dir2 or its subfolders. | Both rules are processed as intended. |
+|
Include rule: C:\Dir1\Dir2* []
Exclude rule: C:\Dir1* [.txt]
| Migrates all files and subfolders of Dir2, except the .txt files from Dir1 and any subfolders of Dir1 (including Dir2). | Both rules are processed as intended. |
-
-
-
-
-
-
-
-
-
-
-
If you have the following code in different components
-
Resulting behavior
-
Explanation
-
-
-
-
-
Component 1:
-
-
Include rule: <pattern type="File">C:\Dir1* []</pattern>
Migrates all files and subfolders of C:\Dir1\ (including C:\Dir1\Dir2).
-
Rules that are in different components do not affect each other, except for the <unconditionalExclude> rule. Therefore, in this example, although some .txt files were excluded when Component 1 was processed, they were included when Component 2 was processed.
-
-
-
Component 1:
-
-
Include rule: C:\Dir1\Dir2* []
-
-
Component 2:
-
-
Exclude rule: C:\Dir1* [.txt]
-
-
Migrates all files and subfolders from Dir2 except the .txt files in C:\Dir1 and its subfolders.
-
Both rules are processed as intended.
-
-
-
Component 1:
-
-
Exclude rule: C:\Dir1\Dir2* []
-
-
Component 2:
-
-
Include rule: C:\Dir1* [.txt]
-
-
Migrates all .txt files in Dir1 and any subfolders.
-
Component 1 does not contain an <include> rule, so the <exclude> rule is not processed.
-
-
-
-
-
+| If you have the following code in different components | Resulting behavior | Explanation |
+|-----|----|----|
+| Component 1:
Include rule: <pattern type="File">C:\Dir1* []</pattern>
| Migrates all files and subfolders of C:\Dir1\ (including C:\Dir1\Dir2). | Rules that are in different components do not affect each other, except for the <unconditionalExclude> rule. Therefore, in this example, although some .txt files were excluded when Component 1 was processed, they were included when Component 2 was processed. |
+| Component 1:
Include rule: C:\Dir1\Dir2* []
Component 2:
Exclude rule: C:\Dir1* [.txt]
| Migrates all files and subfolders from Dir2 except the .txt files in C:\Dir1 and its subfolders. | Both rules are processed as intended. |
+| Component 1:
Exclude rule: C:\Dir1\Dir2* []
Component 2:
Include rule: C:\Dir1* [.txt]
| Migrates all .txt files in Dir1 and any subfolders. | Component 1 does not contain an <include> rule, so the <exclude> rule is not processed. |
### Including and excluding registry objects
-
-
-
-
-
-
-
-
-
If you have the following code in the same component
-
Resulting behavior
-
Explanation
-
-
-
-
-
-
Include rule: HKLM\Software\Microsoft\Command Processor* []
| Migrates only DefaultColor in HKLM\Software\Microsoft\Command Processor. | DefaultColor is migrated because the <include> rule is more specific than the <exclude> rule. |
+|
Include rule: HKLM\Software\Microsoft\Command Processor [DefaultColor]
Migrates all the keys/values under HKLM\Software\Microsoft\Command Processor.
-
Rules that are in different components do not affect each other, except for the <unconditionalExclude> rule. Therefore, in this example, the objects that were excluded when Component 1 was processed were included when Component 2 was processed.
-
-
-
-
-
+| If you have the following code in different components | Resulting behavior | Explanation |
+|-----|-----|-----|
+| Component 1:
Include rule: HKLM\Software\Microsoft\Command Processor [DefaultColor]
| Migrates all the keys/values under HKLM\Software\Microsoft\Command Processor. | Rules that are in different components do not affect each other, except for the <unconditionalExclude> rule. Therefore, in this example, the objects that were excluded when Component 1 was processed were included when Component 2 was processed. |
## File collisions
-
### What is the default behavior when there are file collisions?
If there is not a <merge> rule, the default behavior for the registry is for the source to overwrite the destination. The default behavior for files is for the source to be renamed incrementally: for example, OriginalFileName(1).OriginalExtension, OriginalFileName(2).OriginalExtension, and so on.
@@ -399,67 +218,49 @@ You have a custom .xml file that contains the following code:
```
-For this example, the following table describes the resulting behavior if you add the code in the first column to your custom .xml file.
+For this example, the following information describes the resulting behavior if you add the code to your custom .xml file.
-
During ScanState, all the files will be added to the store.
-
During LoadState, the following will occur:
-
-
C:\Data\SampleA.txt will be restored.
-
C:\Data\SampleB.txt will be restored, overwriting the existing file on the destination computer.
-
C:\Data\Folder\SampleB.txt will not be restored.
-
-
-
-
+**Example 1**
-
+```xml
+
+
+ c:\data* []
+
+
+```
+
+**Result**: During ScanState, all the files will be added to the store. During LoadState, only C:\Data\SampleA.txt will be restored.
+
+**Example 2**
+
+```xml
+
+
+ c:\data* []
+
+
+```
+
+**Result**: During ScanState, all the files will be added to the store.
+During LoadState, all the files will be restored, overwriting the existing files on the destination computer.
+
+**Example 3**
+
+```xml
+
+
+ c:\data\ [*]
+
+
+```
+
+**Result**: During ScanState, all the files will be added to the store. During LoadState, the following will occur:
+
+- C:\Data\SampleA.txt will be restored.
+- C:\Data\SampleB.txt will be restored, overwriting the existing file on the destination computer.
+- C:\Data\Folder\SampleB.txt will not be restored.
## Related topics
-
[USMT XML Reference](usmt-xml-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-custom-xml-examples.md b/windows/deployment/usmt/usmt-custom-xml-examples.md
index 5096af5a77..7d31c9bdbb 100644
--- a/windows/deployment/usmt/usmt-custom-xml-examples.md
+++ b/windows/deployment/usmt/usmt-custom-xml-examples.md
@@ -15,26 +15,8 @@ ms.topic: article
# Custom XML Examples
-
-**Note**
-Because the tables in this topic are wide, you may need to adjust the width of its window.
-
-
-
-## In This Topic:
-
-
-- [Example 1: Migrating an Unsupported Application](#example)
-
-- [Example 2: Migrating the My Videos Folder](#example2)
-
-- [Example 3: Migrating Files and Registry Keys](#example3)
-
-- [Example 4: Migrating Specific Folders from Various Locations](#example4)
-
## Example 1: Migrating an Unsupported Application
-
The following is a template for the sections that you need to migrate your application. The template is not functional on its own, but you can use it to write your own .xml file.
``` xml
@@ -103,37 +85,23 @@ The following is a template for the sections that you need to migrate your appli
## Example 2: Migrating the My Videos Folder
+The following sample is a custom .xml file named CustomFile.xml that migrates My Videos for all users, if the folder exists on the source computer.
-The following is a custom .xml file named CustomFile.xml that migrates My Videos for all users, if the folder exists on the source computer.
+- **Sample condition**: Verifies that My Videos exists on the source computer:
-
Filters out the shortcuts in My Videos that do not resolve on the destination computer. This has no effect on files that are not shortcuts. For example, if there is a shortcut in My Videos on the source computer that points to C:\Folder1, that shortcut will be migrated only if C:\Folder1 exists on the destination computer. However, all other files, such as .mp3 files, migrate without any filtering.
+ `MigXmlHelper.DoesObjectExist("File","%CSIDL_MYVIDEO%")`
-
+- **Sample filter**: Filters out the shortcuts in My Videos that do not resolve on the destination computer:
+
+ ``
+
+ This has no effect on files that are not shortcuts. For example, if there is a shortcut in My Videos on the source computer that points to C:\Folder1, that shortcut will be migrated only if C:\Folder1 exists on the destination computer. However, all other files, such as .mp3 files, migrate without any filtering.
+
+- **Sample pattern**: Migrates My Videos for all users:
+
+ `%CSIDL_MYVIDEO%* [*]`
+
+**XML file**
```xml
@@ -160,41 +128,25 @@ The following is a custom .xml file named CustomFile.xml that migrates My Videos
## Example 3: Migrating Files and Registry Keys
+The sample patterns describe the behavior in the following example .xml file.
-This table describes the behavior in the following example .xml file.
+- **Sample pattern**: Migrates all instances of the file Usmttestfile.txt from all sub-directories under `%ProgramFiles%\USMTTestFolder`:
-
Migrates the entire registry hive under HKLM\Software\USMTTESTKEY.
-
-
-
+ `%ProgramFiles%\USMTTestFolder* [USMTTestFile.txt]`
-
+- **Sample pattern**: Migrates the whole directory under `%ProgramFiles%\USMTDIRTestFolder`:
+
+ `%ProgramFiles%\USMTDIRTestFolder* []`
+
+- **Sample pattern**: Migrates all instances of MyKey under `HKCU\Software\USMTTESTKEY`:
+
+ `HKCU\Software\USMTTESTKEY* [MyKey]`
+
+- **Sample pattern**: Migrates the entire registry hive under `HKLM\Software\USMTTESTKEY`:
+
+ `HKLM\Software\USMTTESTKEY* []`
+
+**XML file**
``` xml
@@ -230,7 +182,7 @@ This table describes the behavior in the following example .xml file.
## Example 4: Migrating Specific Folders from Various Locations
-The behavior for this custom .xml file is described within the <`displayName`> tags in the code.
+The behavior for this custom .xml file is described within the `` tags in the code.
``` xml
@@ -257,12 +209,12 @@ The behavior for this custom .xml file is described within the <`displayName`
Component to migrate all user documents except Sample.doc
-
+ C:\UserDocuments\* [*]
-
+ C:\UserDocuments\ [Sample.doc]
@@ -277,9 +229,9 @@ The behavior for this custom .xml file is described within the <`displayName`
-
-
-
+
+
+
@@ -291,8 +243,8 @@ The behavior for this custom .xml file is described within the <`displayName`
- C:\*\Presentations\* [*]
- C:\Presentations\* [*]
+ C:\*\Presentations\* [*]
+ C:\Presentations\* [*]
@@ -303,16 +255,6 @@ The behavior for this custom .xml file is described within the <`displayName`
## Related topics
-
[USMT XML Reference](usmt-xml-reference.md)
[Customize USMT XML Files](usmt-customize-xml-files.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-determine-what-to-migrate.md b/windows/deployment/usmt/usmt-determine-what-to-migrate.md
index 418f73f68c..608624844a 100644
--- a/windows/deployment/usmt/usmt-determine-what-to-migrate.md
+++ b/windows/deployment/usmt/usmt-determine-what-to-migrate.md
@@ -24,30 +24,12 @@ To reduce complexity and increase standardization, your organization should cons
## In This Section
-
Determine and locate the standard, company-specified, and non-standard locations of the file types, files, folders, and settings that you want to migrate.
-
-
-
+| Link | Description |
+|--- |--- |
+|[Identify Users](usmt-identify-users.md)|Use command-line options to specify which users to migrate and how they should be migrated.|
+|[Identify Applications Settings](usmt-identify-application-settings.md)|Determine which applications you want to migrate and prepare a list of application settings to be migrated.|
+|[Identify Operating System Settings](usmt-identify-operating-system-settings.md)|Use migration to create a new standard environment on each of the destination computers.|
+|[Identify File Types, Files, and Folders](usmt-identify-file-types-files-and-folders.md)|Determine and locate the standard, company-specified, and non-standard locations of the file types, files, folders, and settings that you want to migrate.|
## Related topics
diff --git a/windows/deployment/usmt/usmt-hard-link-migration-store.md b/windows/deployment/usmt/usmt-hard-link-migration-store.md
index 45c699be37..02c53344c8 100644
--- a/windows/deployment/usmt/usmt-hard-link-migration-store.md
+++ b/windows/deployment/usmt/usmt-hard-link-migration-store.md
@@ -16,12 +16,10 @@ ms.topic: article
# Hard-Link Migration Store
-
-A *hard-link migration store* enables you to perform an in-place migration where all user state is maintained on the computer while the old operating system is removed and the new operating system is installed; this is why it is best suited for the computer-refresh scenario. Use of a hard-link migration store for a computer-refresh scenario drastically improves migration performance and significantly reduces hard-disk utilization, reduces deployment costs and enables entirely new migration scenarios.
+A *hard-link migration store* enables you to perform an in-place migration where all user state is maintained on the computer while the old operating system is removed and the new operating system is installed; this is why it is best suited for the computer-refresh scenario. Use of a hard-link migration store for a computer-refresh scenario drastically improves migration performance and significantly reduces hard-disk utilization, reduces deployment costs, and enables entirely new migration scenarios.
## In this topic
-
[When to Use a Hard-Link Migration](#bkmk-when)
[Understanding a Hard-Link Migration](#bkmk-understandhardlinkmig)
@@ -46,7 +44,6 @@ A *hard-link migration store* enables you to perform an in-place migration where
## When to Use a Hard-Link Migration
-
You can use a hard-link migration store when your planned migration meets both of the following criteria:
- You are upgrading the operating system on existing hardware rather than migrating to new computers.
@@ -57,32 +54,27 @@ You cannot use a hard-link migration store if your planned migration includes an
- You are migrating data from one computer to a second computer.
-- You are migrating data from one volume on a computer to another volume, for example from C: to D:.
+- You are migrating data from one volume on a computer to another volume, for example from `C:` to `D:`.
- You are formatting or repartitioning the disk outside of Windows Setup, or specifying a disk format or repartition during Windows Setup that will remove the migration store.
## Understanding a Hard-Link Migration
-
The hard-link migration store is created using the command-line option, **/hardlink**, and is equivalent to other migration-store types. However, it differs in that hard links are utilized to keep files stored on the source computer during the migration. Keeping the files in place on the source computer eliminates the redundant work of duplicating files. It also enables the performance benefits and reduction in disk utilization that define this scenario.
When you create a hard link, you give an existing file an additional path. For instance, you could create a hard link to c:\\file1.txt called c:\\hard link\\myFile.txt. These are two paths to the same file. If you open c:\\file1.txt, make changes, and save the file, you will see those changes when you open c:\\hard link\\myFile.txt. If you delete c:\\file1.txt, the file still exists on your computer as c:\\hardlink\\myFile.txt. You must delete both references to the file in order to delete the file.
-**Note**
-A hard link can only be created for a file on the same volume. If you copy a hard-link migration store to another drive or external device, the files, and not the links, are copied, as in a non-compressed migration-store scenario.
+> [!NOTE]
+> A hard link can only be created for a file on the same volume. If you copy a hard-link migration store to another drive or external device, the files, and not the links, are copied, as in a non-compressed migration-store scenario.
-
-
-For more information about hard links, please see [Hard Links and Junctions](/windows/win32/fileio/hard-links-and-junctions)
+For more information about hard links, see [Hard Links and Junctions](/windows/win32/fileio/hard-links-and-junctions)
In most aspects, a hard-link migration store is identical to an uncompressed migration store. It is located where specified by the Scanstate command-line tool and you can view the contents of the store by using Windows® Explorer. Once created, it can be deleted or copied to another location without changing user state. Restoring a hard-link migration store is similar to restoring any other migration store; however, as with creating the store, the same hard-link functionality is used to keep files in-place.
As a best practice, we recommend that you delete the hard-link migration store after you confirm that the Loadstate tool has successfully migrated the files. Since Loadstate has created new paths to the files on your new installation of a Windows operating system, deleting the hard links in the migration store will only delete one path to the files and will not delete the actual files or the paths to them from your new operating system.
-**Important**
-Using the **/c** option will force the Loadstate tool to continue applying files when non-fatal errors occur. If you use the **/c** option, you should verify that no errors are reported in the logs before deleting the hard-link migration store in order to avoid data loss.
-
-
+> [!IMPORTANT]
+> Using the **/c** option will force the Loadstate tool to continue applying files when non-fatal errors occur. If you use the **/c** option, you should verify that no errors are reported in the logs before deleting the hard-link migration store in order to avoid data loss.
Keeping the hard-link migration store can result in additional disk space being consumed or problems with some applications for the following reasons:
@@ -92,22 +84,17 @@ Keeping the hard-link migration store can result in additional disk space being
- Editing the file by using different paths simultaneously may result in data corruption.
-**Important**
-The read-only file attribute on migrated files is lost when the hard-link migration store is deleted. This is due to a limitation in NTFS file system hard links.
-
-
+> [!IMPORTANT]
+> The read-only file attribute on migrated files is lost when the hard-link migration store is deleted. This is due to a limitation in NTFS file system hard links.
## Hard-Link Migration Scenario
-
For example, a company has decided to deploy Windows 10 on all of their computers. Each employee will keep the same computer, but the operating system on each computer will be updated.
1. An administrator runs the ScanState command-line tool on each computer, specifying the **/hardlink** command-line option. The ScanState tool saves the user state to a hard-link migration store on each computer, improving performance by reducing file duplication, except in certain specific instances.
- **Note**
- As a best practice, we recommend that you do not create your hard-link migration store until just before you perform the migration in order to migrate the latest versions of your files. You should not use your software applications on the computer after creating the migration store until you have finished migrating your files with Loadstate.
-
-
+ > [!NOTE]
+ > As a best practice, we recommend that you do not create your hard-link migration store until just before you perform the migration in order to migrate the latest versions of your files. You should not use your software applications on the computer after creating the migration store until you have finished migrating your files with Loadstate.
2. On each computer, an administrator installs the company's standard operating environment (SOE), which includes Windows 7 and other applications the company currently uses.
@@ -115,19 +102,18 @@ For example, a company has decided to deploy Windows 10 on all of their compute
> [!NOTE]
> During the update of a domain-joined computer, the profiles of users whose SID cannot be resolved will not be migrated. When using a hard-link migration store, it could cause a data loss.
-
-## Hard-Link Migration Store Details
+## Hard-Link Migration Store Details
This section provides details about hard-link migration stores.
### Hard Disk Space
-The **/hardlink** command-line option proceeds with creating the migration store only if there is 250 megabytes (MB) of free space on the hard disk. Provided that every volume involved in the migration is formatted as NTFS, 250 MB should be enough space to ensure success for almost every hard-link migration, regardless on the size of the migration.
+The **/hardlink** command-line option proceeds with creating the migration store only if there are 250 megabytes (MB) of free space on the hard disk. If every volume involved in the migration is formatted as NTFS, 250 MB should be enough space to ensure success for almost every hard-link migration, regardless on the size of the migration.
### Hard-Link Store Size Estimation
-It is not necessary to estimate the size of a hard-link migration store. Estimating the size of a migration store is only useful in scenarios where the migration store is very large, and on NTFS volumes the hard-link migration store will require much less incremental space than other store options. The only case where the local store can be quite large is when non-NTFS file systems exist on the system and contain data being migrated. Since NTFS has been the default file system format for Windows XP and newer operating systems, this situation is unusual.
+It is not necessary to estimate the size of a hard-link migration store. Estimating the size of a migration store is only useful in scenarios where the migration store is large, and on NTFS volumes the hard-link migration store will require much less incremental space than other store options. The only case where the local store can be large is when non-NTFS file systems exist on the system and contain data being migrated. Since NTFS has been the default file system format for Windows XP and newer operating systems, this situation is unusual.
### Migration Store Path on Multiple Volumes
@@ -161,57 +147,27 @@ Files that are locked by an application or the operating system are handled diff
Files that are locked by the operating system cannot remain in place and must be copied into the hard-link migration store. As a result, selecting many operating-system files for migration significantly reduces performance during a hard-link migration. As a best practice, we recommend that you do not migrate any files out of the \\Windows directory, which minimizes performance-related issues.
-Files that are locked by an application are treated the same in hard-link migrations as in other scenarios when the volume shadow-copy service is not being utilized. The volume shadow-copy service cannot be used in conjunction with hard-link migrations. However, by modifying the new **<HardLinkStoreControl>** section in the Config.xml file, it is possible to enable the migration of files locked by an application.
+Files that are locked by an application are treated the same in hard-link migrations as in other scenarios when the volume shadow-copy service is not being utilized. The volume shadow-copy service cannot be used with hard-link migrations. However, by modifying the new `` section in the Config.xml file, it is possible to enable the migration of files locked by an application.
-**Important**
-There are some scenarios in which modifying the **<HardLinkStoreControl>** section in the Config.xml file makes it more difficult to delete a hard-link migration store. In these scenarios, you must use USMTutils.exe to schedule the migration store for deletion on the next restart.
-
-
+> [!IMPORTANT]
+> There are some scenarios in which modifying the `` section in the Config.xml file makes it more difficult to delete a hard-link migration store. In these scenarios, you must use USMTutils.exe to schedule the migration store for deletion on the next restart.
## XML Elements in the Config.xml File
-
A new section in the Config.xml file allows optional configuration of some of the hard-link migration behavior introduced with the **/HardLink** option.
-
-
-
-
-
-
-
-
<Policies>
-
This element contains elements that describe the policies that USMT follows while creating a migration store.
-
-
-
<HardLinkStoreControl>
-
This element contains elements that describe how to handle files during the creation of a hard link migration store.
-
-
-
<fileLocked>
-
This element contains elements that describe how to handle files that are locked for editing.
-
-
-
<createHardLink>
-
This element defines a standard MigXML pattern that describes file paths where hard links should be created, even if the file is locked for editing by another application.
This element defines a standard MigXML pattern that describes file paths where hard links should not be created, if the file is locked for editing by another application.
-
<errorHardLink> [pattern] </errorHardLink>
-
-
-
+| Element | Description |
+|--- |--- |
+| `` | This element contains elements that describe the policies that USMT follows while creating a migration store. |
+| `` | This element contains elements that describe how to handle files during the creation of a hard link migration store. |
+| `` | This element contains elements that describe how to handle files that are locked for editing. |
+| `` | This element defines a standard MigXML pattern that describes file paths where hard links should be created, even if the file is locked for editing by another application.
Syntax: `` [pattern] `` |
+| `` | This element defines a standard MigXML pattern that describes file paths where hard links should not be created, if the file is locked for editing by another application.
`` [pattern] `` |
-
+> [!IMPORTANT]
+> You must use the **/nocompress** option with the **/HardLink** option.
-**Important**
-You must use the **/nocompress** option with the **/HardLink** option.
-
-
-
-The following XML sample specifies that files locked by an application under the \\Users directory can remain in place during the migration. It also specifies that locked files that are not located in the \\Users directory should result in the **File in Use** error. It is important to exercise caution when specifying the paths using the **File in Use<createhardlink>** tag in order to minimize scenarios that make the hard-link migration store more difficult to delete.
+The following XML sample specifies that files locked by an application under the \\Users directory can remain in place during the migration. It also specifies that locked files that are not located in the \\Users directory should result in the **File in Use** error. It is important to exercise caution when specifying the paths using the **File in Use``** tag in order to minimize scenarios that make the hard-link migration store more difficult to delete.
``` xml
@@ -226,8 +182,4 @@ The following XML sample specifies that files locked by an application under the
## Related topics
-
[Plan Your Migration](usmt-plan-your-migration.md)
-
-
-
diff --git a/windows/deployment/usmt/usmt-loadstate-syntax.md b/windows/deployment/usmt/usmt-loadstate-syntax.md
index 77e214976c..42f918560d 100644
--- a/windows/deployment/usmt/usmt-loadstate-syntax.md
+++ b/windows/deployment/usmt/usmt-loadstate-syntax.md
@@ -16,29 +16,10 @@ ms.topic: article
# LoadState Syntax
-
This topic discusses the **LoadState** command syntax and options available with it.
-## In this topic
-
-
-[Before You Begin](#before)
-
-[Syntax](#bkmk-s)
-
-[Storage Options](#bkmk-st)
-
-[Migration Rule Options](#bkmk-mig)
-
-[Monitoring Options](#bkmk-mon)
-
-[User Options](#bkmk-user)
-
-[Incompatible Command-Line Options](#bkmk-cloi)
-
## Before You Begin
-
Before you run the **LoadState** command, note the following:
- To ensure that all operating system settings migrate, we recommend that you run the **LoadState** commands in administrator mode from an account with administrative credentials.
@@ -55,7 +36,6 @@ Before you run the **LoadState** command, note the following:
## Syntax
-
This section explains the syntax and usage of the command-line options available when you use the **LoadState** command. The options can be specified in any order. If the option contains a parameter, you can specify either a colon or space separator.
The **LoadState** command's syntax is:
@@ -71,390 +51,66 @@ For example, to decrypt the store and migrate the files and settings to a comput
USMT provides the following options that you can use to specify how and where the migrated data is stored.
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
StorePath
-
Indicates the folder where the files and settings data are stored. You must specify StorePath when using the LoadState command. You cannot specify more than one StorePath.
-
-
-
/decrypt/key:KeyString
-
or
-
/decrypt/key:"Key String"
-
or
-
/decrypt/keyfile:[Path</em>]FileName
-
Decrypts the store with the specified key. With this option, you will need to specify the encryption key in one of the following ways:
-
-
/key:KeyString specifies the encryption key. If there is a space in KeyString, you must surround the argument with quotation marks.
-
/keyfile:FilePathAndName specifies a text (.txt) file that contains the encryption key
-
-
KeyString cannot exceed 256 characters.
-
The /key and /keyfile options cannot be used on the same command line.
-
The /decrypt and /nocompress options cannot be used on the same command line.
-
-Important
Use caution with this option, because anyone who has access to the LoadState command-line script will also have access to the encryption key.
The /decrypt option accepts a command-line parameter to define the encryption strength specified for the migration store encryption. For more information about supported encryption algorithms, see Migration Store Encryption.
-
-
-
/hardlink
-
Enables user-state data to be restored from a hard-link migration store. The /nocompress parameter must be specified with /hardlink option.
-
-
-
/nocompress
-
Specifies that the store is not compressed. You should only use this option in testing environments. We recommend that you use a compressed store during your actual migration. This option cannot be used with the /decrypt option.
-
-
+| Command-Line Option | Description |
+|--- |--- |
+| `StorePath` | Indicates the folder where the files and settings data are stored. You must specify *StorePath* when using the **LoadState** command. You cannot specify more than one *StorePath*. |
+| `/decrypt /key`:*KeyString* or `/decrypt /key`:"*Key String*" or `/decrypt /keyfile`:[*Path*]*FileName* | Decrypts the store with the specified key. With this option, you will need to specify the encryption key in one of the following ways:
`/key:`*KeyString* specifies the encryption key. If there is a space in *KeyString*, you must surround the argument with quotation marks.
`/keyfile:`*FilePathAndName* specifies a text (.txt) file that contains the encryption key
*KeyString* cannot exceed 256 characters. The `/key` and `/keyfile` options cannot be used on the same command line. The `/decrypt` and `/nocompress` options cannot be used on the same command line.
**Important** Use caution with this option, because anyone who has access to the **LoadState** command-line script will also have access to the encryption key.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /decrypt /key:mykey` |
+| `/decrypt:`*"encryption strength"* | The `/decrypt` option accepts a command-line parameter to define the encryption strength specified for the migration store encryption. For more information about supported encryption algorithms, see [Migration Store Encryption](usmt-migration-store-encryption.md). |
+| `/hardlink` | Enables user-state data to be restored from a hard-link migration store. The `/nocompress` parameter must be specified with `/hardlink` option. |
+| `/nocompress` | Specifies that the store is not compressed. You should only use this option in testing environments. We recommend that you use a compressed store during your actual migration. This option cannot be used with the `/decrypt` option. For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /nocompress` |
## Migration Rule Options
-
USMT provides the following options to specify what files you want to migrate.
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/i:[Path]FileName
-
(include)
-
Specifies an .xml file that contains rules that define what state to migrate. You can specify this option multiple times to include all of your .xml files (MigApp.xml, MigSys.xml, MigDocs.xml and any custom .xml files that you create). Path can be either a relative or full path. If you do not specify the Path variable, then FileName must be located in the current directory.
-
For more information about which files to specify, see the "XML files" section of the Frequently Asked Questions topic.
-
-
-
/config:[Path]FileName
-
Specifies the Config.xml file that the LoadState command should use. You cannot specify this option more than once on the command line. Path can be either a relative or full path. If you do not specify the Path variable, then the FileName must be located in the current directory.
-
This example migrates the files and settings based on the rules in the Config.xml, MigDocs.xml, and MigApp.xml files:
This option enables you to specify the location of the default .xml files and then launch your migration. If no path is specified, USMT will use the directory where the USMT binaries are located. The /auto option has the same effect as using the following options: /i:MigDocs.xml/i:MigApp.xml /v:5.
-
-
-
-
-
+| Command-Line Option | Description |
+|--- |--- |
+| `/i`:[*Path*]*FileName* | **(include)** Specifies an .xml file that contains rules that define what state to migrate. You can specify this option multiple times to include all of your .xml files (MigApp.xml, MigSys.xml, MigDocs.xml and any custom .xml files that you create). *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* must be located in the current directory.
For more information about which files to specify, see the "XML files" section of the [Frequently Asked Questions](usmt-faq.yml) topic. |
+| `/config:`[*Path*]*FileName* | Specifies the Config.xml file that the **LoadState** command should use. You cannot specify this option more than once on the command line. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then the *FileName* must be located in the current directory.
This example migrates the files and settings based on the rules in the Config.xml, MigDocs.xml, and MigApp.xml files:
`loadstate \server\share\migration\mystore /config:config.xml /i:migdocs.xml /i:migapp.xml /v:5 /l:loadstate.log` |
+| `/auto:`*"path to script files"* | This option enables you to specify the location of the default .xml files and then launch your migration. If no path is specified, USMT will use the directory where the USMT binaries are located. The `/auto` option has the same effect as using the following options: `/i:MigDocs.xml` `/i:MigApp.xml /v:5`. |
## Monitoring Options
-
USMT provides several command-line options that you can use to analyze problems that occur during migration.
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/l:[Path]FileName
-
Specifies the location and name of the LoadState log. You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then the log will be created in the current directory. You can specify the /v option to adjust the amount of output.
-
If you run the LoadState command from a shared network resource, you must specify this option or USMT will fail with the error: "USMT was unable to create the log file(s)". To fix this issue, use the /l:load.log option.
-
-
-
/v:<VerbosityLevel>
-
(Verbosity)
-
Enables verbose output in the LoadState log file. The default value is 0.
-
You can set the VerbosityLevel to one of the following levels:
Creates the optional progress log. You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then FileName will be created in the current directory.
When this option is specified, the LoadState command will continue to run, even if non-fatal errors occur. Any files or settings that cause an error are logged in the progress log. For example, if there is a large file that will not fit on the computer, the LoadState command will log an error and continue with the migration. Without the /c option, the LoadState command will exit on the first error. You can use the new <ErrorControl> section in the Config.xml file to specify which file or registry read/write errors can be safely ignored and which might cause the migration to fail. This enables the /c command-line option to safely skip all input/output (I/O) errors in your environment. In addition, the /genconfig option now generates a sample <ErrorControl> section that is enabled by specifying error messages and desired behaviors in the Config.xml file.
-
-
-
/r:<TimesToRetry>
-
(Retry)
-
Specifies the number of times to retry when an error occurs while migrating the user state from a server. The default is three times. This option is useful in environments where network connectivity is not reliable.
-
While restoring the user state, the /r option will not recover data that is lost due to a network-hardware failure, such as a faulty or disconnected network cable, or when a virtual private network (VPN) connection fails. The retry option is intended for large, busy networks where connectivity is satisfactory, but communication latency is a problem.
-
-
-
/w:<SecondsBeforeRetry>
-
(Wait)
-
Specifies the time to wait, in seconds, before retrying a network file operation. The default is 1 second.
-
-
-
/? or /help
-
Displays Help on the command line.
-
-
-
-
-
+| Command-Line Option | Description |
+|--- |--- |
+| `/l:`[*Path*]*FileName* | Specifies the location and name of the **LoadState** log. You cannot store any of the log files in *StorePath*. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then the log will be created in the current directory. You can specify the **/v** option to adjust the amount of output.
If you run the **LoadState** command from a shared network resource, you must specify this option or USMT will fail with the error: "USMT was unable to create the log file(s)". To fix this issue, use the **/l:load.log** option. |
+| `/v:`*``* | **(Verbosity)**
Enables verbose output in the LoadState log file. The default value is 0. You can set the *VerbosityLevel* to one of the following levels:
**0** - Only the default errors and warnings are enabled.
**1** - Enables verbose output.
**4** - Enables error and status output.
**5** - Enables verbose and status output.
**8** - Enables error output to a debugger.
**9** - Enables verbose output to a debugger.
**12** - Enables error and status output to a debugger.
**13** - Enables verbose, status, and debugger output.
For example: `loadstate \server\share\migration\mystore /v:5 /i:migdocs.xml /i:migapp.xml` |
+| `/progress:`[*Path*]*FileName* | Creates the optional progress log. You cannot store any of the log files in *StorePath*. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* will be created in the current directory.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /progress:prog.log /l:loadlog.log` |
+| `/c` | When this option is specified, the **LoadState** command will continue to run, even if non-fatal errors occur. Any files or settings that cause an error are logged in the progress log. For example, if there is a large file that will not fit on the computer, the **LoadState** command will log an error and continue with the migration. Without the **/c** option, the **LoadState** command will exit on the first error. You can use the new <**ErrorControl**> section in the Config.xml file to specify which file or registry read/write errors can be safely ignored and which might cause the migration to fail. This enables the **/c** command-line option to safely skip all input/output (I/O) errors in your environment. In addition, the **/genconfig** option now generates a sample <**ErrorControl**> section that is enabled by specifying error messages and desired behaviors in the Config.xml file. |
+| `/r:`*``* | **(Retry)**
Specifies the number of times to retry when an error occurs while migrating the user state from a server. The default is three times. This option is useful in environments where network connectivity is not reliable.
While restoring the user state, the **/r** option will not recover data that is lost due to a network-hardware failure, such as a faulty or disconnected network cable, or when a virtual private network (VPN) connection fails. The retry option is intended for large, busy networks where connectivity is satisfactory, but communication latency is a problem. |
+| `/w:`*``* | **(Wait)**
Specifies the time to wait, in seconds, before retrying a network file operation. The default is 1 second. |
+| `/?` or `/help` | Displays Help on the command line. |
## User Options
-
By default, all users are migrated. The only way to specify which users to include and exclude is by using the following options. You cannot exclude users in the migration .xml files or by using the Config.xml file. For more information, see [Identify Users](usmt-identify-users.md).
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/all
-
Migrates all of the users on the computer.
-
USMT migrates all user accounts on the computer, unless you specifically exclude an account with the /ue or /uel options. For this reason, you do not need to specify this option on the command line. However, if you choose to use the /all option, you cannot also use the /ui, /ue or /uel options.
-
-
-
/ui:DomainName<em>UserName
-
or
-
/ui:"DomainName<em>User Name"
-
or
-
/ui:ComputerName<em>LocalUserName
-
(User include)
-
Migrates the specified user. By default, all users are included in the migration. Therefore, this option is helpful only when used with the /ue option. You can specify multiple /ui options, but you cannot use the /ui option with the /all option. DomainName and UserName can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotations marks.
-
For example:
-
-
To include only User2 from the Corporate domain, type:
-
/ue:* /ui:corporate\user2
-
-
-Note
If a user is specified for inclusion with the /ui option, and also is specified to be excluded with either the /ue or /uel options, the user will be included in the migration.
-
-
-
-
-
For more examples, see the descriptions of the /uel, /ue, and /ui options in this table.
-
-
-
/uel:<NumberOfDays>
-
or
-
/uel:<YYYY/MM/DD>
-
or
-
/uel:0
-
(User exclude based on last logon)
-
Migrates only the users that logged onto the source computer within the specified time period, based on the Last Modified date of the Ntuser.dat file on the source computer. The /uel option acts as an include rule. For example, the /uel:30 option migrates users who logged on, or whose user account was modified, within the last 30 days from the date when the ScanState command is run. You can specify a number of days or you can specify a date. You cannot use this option with the /all option. USMT retrieves the last logon information from the local computer, so the computer does not need to be connected to the network when you run this option. In addition, if a domain user has logged onto another computer, that logon instance is not considered by USMT.
-
-Note
The /uel option is not valid in offline migrations.
-
-
-
-
-
Examples:
-
-
/uel:0 migrates accounts that were logged on to the source computer when the ScanState command was run.
-
/uel:90 migrates users who have logged on, or whose accounts have been otherwise modified, within the last 90 days.
-
/uel:1 migrates users whose accounts have been modified within the last 24 hours.
-
/uel:2002/1/15 migrates users who have logged on or whose accounts have been modified since January 15, 2002.
Excludes the specified users from the migration. You can specify multiple /ue options but you cannot use the /ue option with the /all option. DomainName and UserName can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotation marks.
For more examples, see the descriptions of the /uel, /ue, and /ui options in this table.
-
-
-
/md:OldDomain:NewDomain
-
or
-
/md:LocalComputerName:NewDomain
-
(move domain)
-
Specifies a new domain for the user. Use this option to change the domain for users on a computer or to migrate a local user to a domain account. OldDomain may contain the asterisk () wildcard character.
-
You can specify this option more than once. You may want to specify multiple /md options if you are consolidating users across multiple domains to a single domain. For example, you could specify the following to consolidate the users from the Corporate and FarNorth domains into the Fabrikam domain: /md:corporate:fabrikam and /md:farnorth:fabrikam.
-
If there are conflicts between two /md commands, the first rule that you specify is applied. For example, if you specify the /md:corporate:fabrikam and /md:corporate:farnorth commands, then Corporate users would be mapped to the Fabrikam domain.
-
-Note
If you specify an OldDomain that did not exist on the source computer, the LoadState command will appear to complete successfully, without an error or warning. However, in this case, users will not be moved to NewDomain but will remain in their original domain. For example, if you misspell "contoso" and you specify "/md:contso:fabrikam", the users will remain in contoso on the destination computer.
Specifies a new user name for the specified user. If the store contains more than one user, you can specify multiple /mu options. You cannot use wildcard characters with this option.
Specifies that if a user account is a local (non-domain) account, and it does not exist on the destination computer, USMT will create the account on the destination computer but it will be disabled. To enable the account, you must also use the /lae option.
-
If the /lac option is not specified, any local user accounts that do not already exist on the destination computer will not be migrated.
-
Password is the password for the newly created account. An empty password is used by default.
-
-Caution
Use the Password variable with caution because it is provided in plain text and can be obtained by anyone with access to the computer that is running the LoadState command.
-
Also, if the computer has multiple users, all migrated users will have the same password.
-
+| Command-Line Option | Description |
+|--- |--- |
+| `/all` | Migrates all of the users on the computer.
USMT migrates all user accounts on the computer, unless you specifically exclude an account with the **/ue** or **/uel** options. For this reason, you do not need to specify this option on the command line. However, if you choose to use the **/all** option, you cannot also use the **/ui**, **/ue** or **/uel** options. |
+| `/ui:`*DomainName UserName* or `/ui:`*"DomainName User Name"* or `/ui:`*ComputerName LocalUserName* | **(User include)**
Migrates the specified user. By default, all users are included in the migration. Therefore, this option is helpful only when used with the **/ue** option. You can specify multiple **/ui** options, but you cannot use the **/ui** option with the **/all** option. *DomainName* and *UserName* can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotations marks. For example:
To include only User2 from the Corporate domain, type: `/ue:* /ui:corporate\user2`
**Note** If a user is specified for inclusion with the **/ui** option, and also is specified to be excluded with either the **/ue** or **/uel** options, the user will be included in the migration.
For more examples, see the descriptions of the **/uel**, **/ue**, and **/ui** options in this table. |
+| `/uel:`*``* or `/uel:`*``* or `/uel:0` | **(User exclude based on last logon)**
Migrates only the users that logged onto the source computer within the specified time period, based on the **Last Modified** date of the Ntuser.dat file on the source computer. The **/uel** option acts as an include rule. For example, the **/uel:30** option migrates users who logged on, or whose user account was modified, within the last 30 days from the date when the ScanState command is run. You can specify a number of days or you can specify a date. You cannot use this option with the **/all** option. USMT retrieves the last logon information from the local computer, so the computer does not need to be connected to the network when you run this option. In addition, if a domain user has logged onto another computer, that logon instance is not considered by USMT.
**Note** The **/uel** option is not valid in offline migrations.
Examples:
`/uel:0` migrates accounts that were logged on to the source computer when the **ScanState** command was run.
`/uel:90` migrates users who have logged on, or whose accounts have been otherwise modified, within the last 90 days.
`/uel:1` migrates users whose accounts have been modified within the last 24 hours.
`/uel:2002/1/15` migrates users who have logged on or whose accounts have been modified since January 15, 2002.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /uel:0` |
+| `/ue`:*DomainName UserName* or `/ue`*"DomainName User Name"* or `/ue`:*ComputerName LocalUserName* | **(User exclude)**
Excludes the specified users from the migration. You can specify multiple **/ue** options but you cannot use the **/ue** option with the **/all** option. *DomainName* and *UserName* can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotation marks.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /ue:contoso\user1` For more examples, see the descriptions of the **/uel**, **/ue**, and **/ui** options in this table. |
+| `/md:`*OldDomain*:*NewDomain* or `/md:`*LocalComputerName:NewDomain* | **(move domain)** Specifies a new domain for the user. Use this option to change the domain for users on a computer or to migrate a local user to a domain account. *OldDomain* may contain the asterisk () wildcard character.
You can specify this option more than once. You may want to specify multiple **/md** options if you are consolidating users across multiple domains to a single domain. For example, you could specify the following to consolidate the users from the Corporate and FarNorth domains into the Fabrikam domain: `/md:corporate:fabrikam` and `/md:farnorth:fabrikam`.
If there are conflicts between two **/md** commands, the first rule that you specify is applied. For example, if you specify the `/md:corporate:fabrikam` and `/md:corporate:farnorth` commands, then Corporate users would be mapped to the Fabrikam domain.
**Note** If you specify an *OldDomain* that did not exist on the source computer, the **LoadState** command will appear to complete successfully, without an error or warning. However, in this case, users will not be moved to *NewDomain* but will remain in their original domain. For example, if you misspell "contoso" and you specify "/md:contso:fabrikam", the users will remain in contoso on the destination computer.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore` ` /progress:prog.log /l:load.log /md:contoso:fabrikam` |
+| `/mu:`*OldDomain OldUserName*:[*NewDomain*]*NewUserName* or `/mu:`*OldLocalUserName*:*NewDomain NewUserName* | Specifies a new user name for the specified user. If the store contains more than one user, you can specify multiple **/mu** options. You cannot use wildcard characters with this option.
Specifies that if a user account is a local (non-domain) account, and it does not exist on the destination computer, USMT will create the account on the destination computer but it will be disabled. To enable the account, you must also use the **/lae** option.
If the **/lac** option is not specified, any local user accounts that do not already exist on the destination computer will not be migrated.
*Password* is the password for the newly created account. An empty password is used by default.
**Caution** Use the *Password* variable with caution because it is provided in plain text and can be obtained by anyone with access to the computer that is running the **LoadState** command. Also, if the computer has multiple users, all migrated users will have the same password.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore` For instructions, see [Migrate User Accounts](usmt-migrate-user-accounts.md). |
+| `/lae` | **(local account enable)**
Enables the account that was created with the **/lac** option. You must specify the **/lac** option with this option.
For example: `loadstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore` `/progress:prog.log /l:load.log /lac:password /lae`
For instructions, see [Migrate User Accounts](usmt-migrate-user-accounts.md). |
### Examples for the /ui and /ue options
The following examples apply to both the **/ui** and **/ue** options. You can replace the **/ue** option with the **/ui** option to include, rather than exclude, the specified users.
-
-
-
-
-
-
-
-
Behavior
-
Command
-
-
-
-
-
Exclude the user named User One in the Corporate domain.
-
/ue:"corporate\user one"
-
-
-
Exclude the user named User1 in the Corporate domain.
-
/ue:corporate\user1
-
-
-
Exclude the local user named User1.
-
/ue:%computername%\user1
-
-
-
Exclude all domain users.
-
/ue:Domain
-
-
-
Exclude all local users.
-
/ue:%computername%
-
-
-
Exclude users in all domains named User1, User2, and so on.
-
/ue:\user
-
-
-
-
-
+| Behavior | Command |
+|--- |--- |
+| Exclude the user named User One in the Corporate domain. | `/ue:"corporate\user one"` |
+| Exclude the user named User1 in the Corporate domain. | `/ue:corporate\user1` |
+| Exclude the local user named User1. | `/ue:%computername%\user1` |
+| Exclude all domain users. | `/ue:Domain` |
+| Exclude all local users. | `/ue:%computername%` |
+| Exclude users in all domains named User1, User2, and so on. | `/ue:\user` |
### Using the Options Together
@@ -464,247 +120,46 @@ You can use the **/uel**, **/ue** and **/ui** options together to migrate only t
**The /uel option takes precedence over the /ue option.** If a user has logged on within the specified time period set by the **/uel** option, that user's profile will be migrated even if they are excluded by using the **/ue** option. For example, if you specify `/ue:contoso\user1 /uel:14`, the User1 will be migrated if they have logged on to the computer within the last 14 days.
-
-
-
-
-
-
-
-
Behavior
-
Command
-
-
-
-
-
Include only User2 from the Fabrikam domain and exclude all other users.
-
/ue:* /ui:fabrikam\user2
-
-
-
Include only the local user named User1 and exclude all other users.
-
/ue:* /ui:user1
-
-
-
Include only the domain users from Contoso, except Contoso\User1.
-
This behavior cannot be completed using a single command. Instead, to migrate this set of users, you will need to specify the following:
-
-
Using the ScanState command-line tool, type: /ue:* /ui:contoso
-
Using the LoadState command-line tool, type: /ue:contoso\user1
-
-
-
-
Include only local (non-domain) users.
-
/ue: /ui:%computername%*
-
-
-
-
-
+| Behavior | Command |
+|--- |--- |
+| Include only User2 from the Fabrikam domain and exclude all other users. | `/ue:* /ui:fabrikam\user2` |
+| Include only the local user named User1 and exclude all other users. | `/ue:* /ui:user1` |
+| Include only the domain users from Contoso, except Contoso\User1. | This behavior cannot be completed using a single command. Instead, to migrate this set of users, you will need to specify the following:
Using the **ScanState** command-line tool, type: `/ue:* /ui:contoso`
Using the **LoadState** command-line tool, type: `/ue:contoso\user1`
|
+| Include only local (non-domain) users. | `/ue: /ui:%computername%*` |
## Incompatible Command-Line Options
-
The following table indicates which command-line options are not compatible with the **LoadState** command. If the table entry for a particular combination is blank, the options are compatible and you can use them together. The X symbol means that the options are not compatible. For example, you cannot use the **/nocompress** option with the **/encrypt** option.
-
-
-
-
-
-
-
-
-
-
-
Command-Line Option
-
/keyfile
-
/nocompress
-
/genconfig
-
/all
-
-
-
-
-
/i
-
-
-
-
-
-
-
/v
-
-
-
-
-
-
-
/nocompress
-
-
N/A
-
X
-
-
-
-
/key
-
X
-
-
X
-
-
-
-
/decrypt
-
Required*
-
X
-
X
-
-
-
-
/keyfile
-
N/A
-
-
X
-
-
-
-
/l
-
-
-
-
-
-
-
/progress
-
-
-
X
-
-
-
-
/r
-
-
-
X
-
-
-
-
/w
-
-
-
X
-
-
-
-
/c
-
-
-
X
-
-
-
-
/p
-
-
-
X
-
N/A
-
-
-
/all
-
-
-
X
-
-
-
-
/ui
-
-
-
X
-
X
-
-
-
/ue
-
-
-
X
-
X
-
-
-
/uel
-
-
-
X
-
X
-
-
-
/genconfig
-
-
-
N/A
-
-
-
-
/config
-
-
-
X
-
-
-
-
StorePath
-
-
-
-
-
-
-
/md
-
-
-
-
-
-
-
/mu
-
-
-
-
-
-
-
/lae
-
-
-
-
-
-
-
/lac
-
-
-
-
-
-
-
-
-
-
-**Note**
-You must specify either the **/key** or **/keyfile** option with the **/encrypt** option.
-
+| Command-Line Option | /keyfile | /nocompress | /genconfig | /all |
+|--- |--- |--- |--- |--- |
+| **/i** | | | | |
+| **/v** | | | | |
+| **/nocompress** | | N/A | X | |
+| **/key** | X | | X | |
+| **/decrypt** | Required* | X | X | |
+| **/keyfile** | N/A | | X | |
+| **/l** | | | | |
+| **/progress** | | | X | |
+| **/r** | | | X | |
+| **/w** | | | X | |
+| **/c** | | | X | |
+| **/p** | | | X | N/A |
+| **/all** | | | X | |
+| **/ui** | | | X | X |
+| **/ue** | | | X | X |
+| **/uel** | | | X | X |
+| **/genconfig** | | | N/A | |
+| **/config** | | | X | |
+| *StorePath* | | | | |
+| **/md** | | | | |
+| **/mu** | | | | |
+| **/lae** | | | | |
+| **/lac** | | | | |
+> [!NOTE]
+> You must specify either the **/key** or **/keyfile** option with the **/encrypt** option.
## Related topics
-
[XML Elements Library](usmt-xml-elements-library.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-log-files.md b/windows/deployment/usmt/usmt-log-files.md
index 63fcf4af6f..3d42379783 100644
--- a/windows/deployment/usmt/usmt-log-files.md
+++ b/windows/deployment/usmt/usmt-log-files.md
@@ -16,7 +16,6 @@ ms.topic: article
# Log Files
-
You can use User State Migration Tool (USMT) 10.0 logs to monitor your migration and to troubleshoot errors and failed migrations. This topic describes the available command-line options to enable USMT logs, and new XML elements that configure which types of errors are fatal and should halt the migration, which types are non-fatal and should be skipped so that the migration can continue.
[Log Command-Line Options](#bkmk-commandlineoptions)
@@ -31,66 +30,25 @@ You can use User State Migration Tool (USMT) 10.0 logs to monitor your migratio
## Log Command-Line Options
-
The following table describes each command-line option related to logs, and it provides the log name and a description of what type of information each log contains.
-
-
-
-
-
-
-
-
-
Command line Option
-
File Name
-
Description
-
-
-
-
-
/l[Path]FileName
-
Scanstate.log or LoadState.log
-
Specifies the path and file name of the ScanState.log or LoadState log.
-
-
-
/progress[Path]FileName
-
Specifies the path and file name of the Progress log.
-
Provides information about the status of the migration, by percentage complete.
Specifies the path and file name of the Listfiles log.
-
Provides a list of the files that were migrated.
-
-
-
Set the environment variable MIG_ENABLE_DIAG to a path to an XML file.
-
USMTDiag.xml
-
The diagnostic log contains detailed system environment information, user environment information, and information about the migration units (migunits) being gathered and their contents.
-
-
-
+|Command line Option|File Name|Description|
+|--- |--- |--- |
+|**/l** *[Path]FileName*|Scanstate.log or LoadState.log|Specifies the path and file name of the ScanState.log or LoadState log.|
+|**/progress** *[Path]FileName*|Specifies the path and file name of the Progress log.|Provides information about the status of the migration, by percentage complete.|
+|**/v** *[VerbosityLevel]*|Not applicable|See the "Monitoring Options" section in [ScanState Syntax](usmt-scanstate-syntax.md).|
+|**/listfiles** *[Path]FileName*|Specifies the path and file name of the Listfiles log.|Provides a list of the files that were migrated.|
+|Set the environment variable MIG_ENABLE_DIAG to a path to an XML file.|USMTDiag.xml|The diagnostic log contains detailed system environment information, user environment information, and information about the migration units (migunits) being gathered and their contents.|
-
-
-**Note**
-You cannot store any of the log files in *StorePath*. If you do, the log will be overwritten when USMT is run.
-
-
+> [!NOTE]
+> You cannot store any of the log files in *StorePath*. If you do, the log will be overwritten when USMT is run.
## ScanState and LoadState Logs
-
ScanState and LoadState logs are text files that are create when you run the ScanState and LoadState tools. You can use these logs to help monitor your migration. The content of the log depends on the command-line options that you use and the verbosity level that you specify. For more information about verbosity levels, see Monitoring Options in [ScanState Syntax](usmt-scanstate-syntax.md).
## Progress Log
-
You can create a progress log using the **/progress** option. External tools, such as Microsoft System Center Operations Manager 2007, can parse the progress log to update your monitoring systems. The first three fields in each line are fixed as follows:
- **Date:** Date, in the format of *day* *shortNameOfTheMonth* *year*. For example: 08 Jun 2006.
@@ -101,137 +59,34 @@ You can create a progress log using the **/progress** option. External tools, su
The remaining fields are key/value pairs as indicated in the following table.
-
-
-
-
-
-
-
-
Key
-
Value
-
-
-
-
-
program
-
ScanState.exe or LoadState.exe.
-
-
-
productVersion
-
The full product version number of USMT.
-
-
-
computerName
-
The name of the source or destination computer on which USMT was run.
-
-
-
commandLine
-
The full command used to run USMT.
-
-
-
PHASE
-
Reports that a new phase in the migration is starting. This can be one of the following:
-
-
Initializing
-
Scanning
-
Collecting
-
Saving
-
Estimating
-
Applying
-
-
-
-
detectedUser
-
-
For the ScanState tool, these are the users USMT detected on the source computer that can be migrated.
-
For the LoadState tool, these are the users USMT detected in the store that can be migrated.
-
-
-
-
includedInMigration
-
Defines whether the user profile/component is included for migration. Valid values are Yes or No.
-
-
-
forUser
-
Specifies either of the following:
-
-
The user state being migrated.
-
This Computer, meaning files and settings that are not associated with a user.
-
-
-
-
detectedComponent
-
Specifies a component detected by USMT.
-
-
For ScanState, this is a component or application that is installed on the source computer.
-
For LoadState, this is a component or application that was detected in the store.
-
-
-
-
totalSizeInMBToTransfer
-
Total size of the files and settings to migrate in megabytes (MB).
-
-
-
totalPercentageCompleted
-
Total percentage of the migration that has been completed by either ScanState or LoadState.
-
-
-
collectingUser
-
Specifies which user ScanState is collecting files and settings for.
-
-
-
totalMinutesRemaining
-
Time estimate, in minutes, for the migration to complete.
-
-
-
error
-
Type of non-fatal error that occurred. This can be one of the following:
-
-
UnableToCopy: Unable to copy to store because the disk on which the store is located is full.
-
UnableToOpen: Unable to open the file for migration because the file is opened in non-shared mode by another application or service.
-
UnableToCopyCatalog: Unable to copy because the store is corrupted.
-
UnableToAccessDevice: Unable to access the device.
-
UnableToApply: Unable to apply the setting to the destination computer.
-
-
-
-
objectName
-
The name of the file or setting that caused the non-fatal error.
-
-
-
action
-
Action taken by USMT for the non-fatal error. The values are:
-
-
Ignore: Non-fatal error ignored and the migration continued because the /c option was specified on the command line.
-
Abort: Stopped the migration because the /c option was not specified.
-
-
-
-
errorCode
-
The errorCode or return value.
-
-
-
numberOfIgnoredErrors
-
The total number of non-fatal errors that USMT ignored.
-
-
-
message
-
The message corresponding to the errorCode.
-
-
-
-
-
+| Key | Value |
+|-----|-------|
+| program | ScanState.exe or LoadState.exe. |
+| productVersion | The full product version number of USMT. |
+| computerName | The name of the source or destination computer on which USMT was run. |
+| commandLine | The full command used to run USMT. |
+| PHASE | Reports that a new phase in the migration is starting. This can be one of the following:
Initializing
Scanning
Collecting
Saving
Estimating
Applying
|
+| detectedUser |
For the ScanState tool, these are the users USMT detected on the source computer that can be migrated.
For the LoadState tool, these are the users USMT detected in the store that can be migrated.
|
+| includedInMigration | Defines whether the user profile/component is included for migration. Valid values are Yes or No. |
+| forUser | Specifies either of the following:
The user state being migrated.
*This Computer*, meaning files and settings that are not associated with a user.
|
+| detectedComponent | Specifies a component detected by USMT.
For ScanState, this is a component or application that is installed on the source computer.
For LoadState, this is a component or application that was detected in the store.
|
+| totalSizeInMBToTransfer | Total size of the files and settings to migrate in megabytes (MB). |
+| totalPercentageCompleted | Total percentage of the migration that has been completed by either ScanState or LoadState. |
+| collectingUser | Specifies which user ScanState is collecting files and settings for. |
+| totalMinutesRemaining | Time estimate, in minutes, for the migration to complete. |
+| error | Type of non-fatal error that occurred. This can be one of the following:
**UnableToCopy**: Unable to copy to store because the disk on which the store is located is full.
**UnableToOpen**: Unable to open the file for migration because the file is opened in non-shared mode by another application or service.
**UnableToCopyCatalog**: Unable to copy because the store is corrupted.
**UnableToAccessDevice**: Unable to access the device.
**UnableToApply**: Unable to apply the setting to the destination computer.
|
+| objectName | The name of the file or setting that caused the non-fatal error. |
+| action | Action taken by USMT for the non-fatal error. The values are:
**Ignore**: Non-fatal error ignored and the migration continued because the **/c** option was specified on the command line.
**Abort**: Stopped the migration because the **/c** option was not specified.
|
+| errorCode | The errorCode or return value. |
+| numberOfIgnoredErrors | The total number of non-fatal errors that USMT ignored. |
+| message | The message corresponding to the errorCode. |
## List Files Log
-
The List files log (Listfiles.txt) provides a list of the files that were migrated. This list can be used to troubleshoot XML issues or can be retained as a record of the files that were gathered into the migration store. The List Files log is only available for ScanState.exe.
## Diagnostic Log
-
You can obtain the diagnostic log by setting the environment variable MIG\_ENABLE\_DIAG to a path to an XML file.
The diagnostic log contains:
@@ -244,7 +99,6 @@ The diagnostic log contains:
## Using the Diagnostic Log
-
The diagnostic log is essentially a report of all the migration units (migunits) included in the migration. A migunit is a collection of data that is identified by the component it is associated with in the XML files. The migration store is made up of all the migunits in the migration. The diagnostic log can be used to verify which migunits were included in the migration and can be used for troubleshooting while authoring migration XML files.
The following examples describe common scenarios in which you can use the diagnostic log.
@@ -253,7 +107,7 @@ The following examples describe common scenarios in which you can use the diagno
Let's imagine that we have the following directory structure and that we want the "data" directory to be included in the migration along with the "New Text Document.txt" file in the "New Folder." The directory of **C:\\data** contains:
-```
+```console
01/21/2009 10:08 PM .
01/21/2009 10:08 PM ..
01/21/2009 10:08 PM New Folder
@@ -264,7 +118,7 @@ Let's imagine that we have the following directory structure and that we want th
The directory of **C:\\data\\New Folder** contains:
-```
+```console
01/21/2009 10:08 PM .
01/21/2009 10:08 PM ..
01/21/2009 10:08 PM 0 New Text Document.txt
@@ -295,7 +149,7 @@ To migrate these files you author the following migration XML:
However, upon testing the migration you notice that the "New Text Document.txt" file isn't included in the migration. To troubleshoot this failure, the migration can be repeated with the environment variable MIG\_ENABLE\_DIAG set such that the diagnostic log is generated. Upon searching the diagnostic log for the component "DATA1", the following XML section is discovered:
-``` xml
+```xml
@@ -316,13 +170,13 @@ Analysis of this XML section reveals the migunit that was created when the migra
An analysis of the XML elements reference topic reveals that the <pattern> tag needs to be modified as follows:
-``` xml
+```xml
c:\data\* [*]
```
When the migration is preformed again with the modified tag, the diagnostic log reveals the following:
-``` xml
+```xml
@@ -347,7 +201,7 @@ This diagnostic log confirms that the modified <pattern> value enables the
In this scenario, you have the following directory structure and you want all files in the "data" directory to migrate, except for text files. The **C:\\Data** folder contains:
-```
+```console
Directory of C:\Data
01/21/2009 10:08 PM .
@@ -360,7 +214,7 @@ Directory of C:\Data
The **C:\\Data\\New Folder\\** contains:
-```
+```console
01/21/2009 10:08 PM .
01/21/2009 10:08 PM ..
01/21/2009 10:08 PM 0 New Text Document.txt
@@ -397,7 +251,7 @@ You author the following migration XML:
However, upon testing the migration you notice that all the text files are still included in the migration. In order to troubleshoot this issue, the migration can be performed with the environment variable MIG\_ENABLE\_DIAG set so that the diagnostic log is generated. Upon searching the diagnostic log for the component "DATA1", the following XML section is discovered:
-``` xml
+```xml
@@ -454,7 +308,7 @@ Upon reviewing the diagnostic log, you confirm that the files are still migratin
Your revised migration XML script excludes the files from migrating, as confirmed in the diagnostic log:
-``` xml
+```xml
@@ -484,11 +338,3 @@ Your revised migration XML script excludes the files from migrating, as confirme
[LoadState Syntax](usmt-loadstate-syntax.md)
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-migration-store-encryption.md b/windows/deployment/usmt/usmt-migration-store-encryption.md
index c10a7ba4f3..6ba4824bdc 100644
--- a/windows/deployment/usmt/usmt-migration-store-encryption.md
+++ b/windows/deployment/usmt/usmt-migration-store-encryption.md
@@ -16,62 +16,24 @@ ms.topic: article
# Migration Store Encryption
-
This topic discusses User State Migration Tool (USMT) 10.0 options for migration store encryption to protect the integrity of user data during a migration.
## USMT Encryption Options
-
USMT enables support for stronger encryption algorithms, called Advanced Encryption Standard (AES), in several bit-level options. AES is a National Institute of Standards and Technology (NIST) specification for the encryption of electronic data.
The encryption algorithm you choose must be specified for both the **ScanState** and the **LoadState** commands, so that these commands can create or read the store during encryption and decryption. The new encryption algorithms can be specified on the **ScanState** and the **LoadState** command lines by using the **/encrypt**:*"encryptionstrength"* and the **/decrypt**:*"encryptionstrength"* command-line options. All of the encryption application programming interfaces (APIs) used by USMT are available in Windows 7, Windows 8, and Windows 10 operating systems. However, export restrictions might limit the set of algorithms that are available to computers in certain locales. You can use the Usmtutils.exe file to determine which encryption algorithms are available to the computers' locales before you begin the migration.
The following table describes the command-line encryption options in USMT.
-
This option and argument specify that the migration store is encrypted and which algorithm to use. When the algorithm argument is not provided, the ScanState tool employs the 3DES algorithm.
This option and argument specify that the store must be decrypted and which algorithm to use. When the algorithm argument is not provided, the LoadState tool employs the 3DES algorithm.
-
-
-
-
-
+|Component|Option|Description|
+|--- |--- |--- |
+|**ScanState**|**/encrypt**<*AES, AES_128, AES_192, AES_256, 3DES, 3DES_112*>|This option and argument specify that the migration store is encrypted and which algorithm to use. When the algorithm argument is not provided, the **ScanState** tool employs the 3DES algorithm.|
+|**LoadState**|**/decrypt**<*AES, AES_128, AES_192, AES_256, 3DES, 3DES_112*>|This option and argument specify that the store must be decrypted and which algorithm to use. When the algorithm argument is not provided, the **LoadState** tool employs the 3DES algorithm.|
**Important**
Some encryption algorithms may not be available on your systems. You can verify which algorithms are available by running the UsmtUtils command with the **/ec** option. For more information see [UsmtUtils Syntax](usmt-utilities.md)
-
-
## Related topics
-
[Plan Your Migration](usmt-plan-your-migration.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-plan-your-migration.md b/windows/deployment/usmt/usmt-plan-your-migration.md
index 7ea0c4d341..3090fc7efd 100644
--- a/windows/deployment/usmt/usmt-plan-your-migration.md
+++ b/windows/deployment/usmt/usmt-plan-your-migration.md
@@ -16,7 +16,6 @@ ms.topic: article
# Plan Your Migration
-
Before you use the User State Migration Tool (USMT) 10.0 to perform your migration, we recommend that you plan your migration carefully. Planning can help your migration proceed smoothly and can reduce the risk of migration failure.
In migration planning, both organizations and individuals must first identify what to migrate, including user settings, applications and application settings, and personal data files and folders. Identifying the applications to migrate is especially important so that you can avoid capturing data about applications that may be phased out.
@@ -25,48 +24,14 @@ One of the most important requirements for migrating settings and data is restor
## In This Section
-
-
Test your migration before you deploy Windows to all users.
-
-
-
-
-
+| Link | Description |
+|--- |--- |
+|[Common Migration Scenarios](usmt-common-migration-scenarios.md)|Determine whether you will perform a refresh migration or a replace migration.|
+|[What Does USMT Migrate?](usmt-what-does-usmt-migrate.md)|Learn which applications, user data, and operating system components USMT migrates.|
+|[Choose a Migration Store Type](usmt-choose-migration-store-type.md)|Choose an uncompressed, compressed, or hard-link migration store.|
+|[Determine What to Migrate](usmt-determine-what-to-migrate.md)|Identify user accounts, application settings, operating system settings, and files that you want to migrate inside your organization.|
+|[Test Your Migration](usmt-test-your-migration.md)|Test your migration before you deploy Windows to all users.|
## Related topics
-
[USMT XML Reference](usmt-xml-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-recognized-environment-variables.md b/windows/deployment/usmt/usmt-recognized-environment-variables.md
index a2ff4251a9..6e522e003e 100644
--- a/windows/deployment/usmt/usmt-recognized-environment-variables.md
+++ b/windows/deployment/usmt/usmt-recognized-environment-variables.md
@@ -31,441 +31,112 @@ When using the XML files MigDocs.xml, MigApp.xml, and MigUser.xml, you can use e
You can use these variables within sections in the .xml files with `context=UserAndSystem`, `context=User`, and `context=System`.
-
-
-
-
-
-
-
-
Variable
-
Explanation
-
-
-
-
-
ALLUSERSAPPDATA
-
Same as CSIDL_COMMON_APPDATA.
-
-
-
ALLUSERSPROFILE
-
Refers to %PROFILESFOLDER%\Public or %PROFILESFOLDER%\all users.
-
-
-
COMMONPROGRAMFILES
-
Same as CSIDL_PROGRAM_FILES_COMMON.
-
-
-
COMMONPROGRAMFILES(X86)
-
Refers to the C:\Program Files (x86)\Common Files folder on 64-bit systems.
-
-
-
CSIDL_COMMON_ADMINTOOLS
-
Version 10.0. The file-system directory that contains administrative tools for all users of the computer.
-
-
-
CSIDL_COMMON_ALTSTARTUP
-
The file-system directory that corresponds to the non-localized Startup program group for all users.
-
-
-
CSIDL_COMMON_APPDATA
-
The file-system directory that contains application data for all users. A typical path Windows is C:\ProgramData.
-
-
-
CSIDL_COMMON_DESKTOPDIRECTORY
-
The file-system directory that contains files and folders that appear on the desktop for all users. A typical Windows® XP path is C:\Documents and Settings\All Users\Desktop. A typical path is C:\Users\Public\Desktop.
-
-
-
CSIDL_COMMON_DOCUMENTS
-
The file-system directory that contains documents that are common to all users. A typical path in Windows XP is C:\Documents and Settings\All Users\Documents. A typical path is C:\Users\Public\Documents.
-
-
-
CSIDL_COMMON_FAVORITES
-
The file-system directory that serves as a common repository for favorites common to all users. A typical path is C:\Users\Public\Favorites.
-
-
-
CSIDL_COMMON_MUSIC
-
The file-system directory that serves as a repository for music files common to all users. A typical path is C:\Users\Public\Music.
-
-
-
CSIDL_COMMON_PICTURES
-
The file-system directory that serves as a repository for image files common to all users. A typical path is C:\Users\Public\Pictures.
-
-
-
CSIDL_COMMON_PROGRAMS
-
The file-system directory that contains the directories for the common program groups that appear on the Start menu for all users. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs.
-
-
-
CSIDL_COMMON_STARTMENU
-
The file-system directory that contains the programs and folders which appear on the Start menu for all users. A typical path in Windows is C:\ProgramData\Microsoft\Windows\Start Menu.
-
-
-
CSIDL_COMMON_STARTUP
-
The file-system directory that contains the programs that appear in the Startup folder for all users. A typical path in Windows XP is C:\Documents and Settings\All Users\Start Menu\Programs\Startup. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup.
-
-
-
CSIDL_COMMON_TEMPLATES
-
The file-system directory that contains the templates that are available to all users. A typical path is C:\ProgramData\Microsoft\Windows\Templates.
-
-
-
CSIDL_COMMON_VIDEO
-
The file-system directory that serves as a repository for video files common to all users. A typical path is C:\Users\Public\Videos.
-
-
-
CSIDL_DEFAULT_APPDATA
-
Refers to the Appdata folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_LOCAL_APPDATA
-
Refers to the local Appdata folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_COOKIES
-
Refers to the Cookies folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_CONTACTS
-
Refers to the Contacts folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_DESKTOP
-
Refers to the Desktop folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_DOWNLOADS
-
Refers to the Downloads folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_FAVORITES
-
Refers to the Favorites folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_HISTORY
-
Refers to the History folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_INTERNET_CACHE
-
Refers to the Internet Cache folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_PERSONAL
-
Refers to the Personal folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_MYDOCUMENTS
-
Refers to the My Documents folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_MYPICTURES
-
Refers to the My Pictures folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_MYMUSIC
-
Refers to the My Music folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_MYVIDEO
-
Refers to the My Videos folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_RECENT
-
Refers to the Recent folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_SENDTO
-
Refers to the Send To folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_STARTMENU
-
Refers to the Start Menu folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_PROGRAMS
-
Refers to the Programs folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_STARTUP
-
Refers to the Startup folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_TEMPLATES
-
Refers to the Templates folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_DEFAULT_QUICKLAUNCH
-
Refers to the Quick Launch folder inside %DEFAULTUSERPROFILE%.
-
-
-
CSIDL_FONTS
-
A virtual folder containing fonts. A typical path is C:\Windows\Fonts.
-
-
-
CSIDL_PROGRAM_FILESX86
-
The Program Files folder on 64-bit systems. A typical path is C:\Program Files(86).
-
-
-
CSIDL_PROGRAM_FILES_COMMONX86
-
A folder for components that are shared across applications on 64-bit systems. A typical path is C:\Program Files(86)\Common.
-
-
-
CSIDL_PROGRAM_FILES
-
The Program Files folder. A typical path is C:\Program Files.
-
-
-
CSIDL_PROGRAM_FILES_COMMON
-
A folder for components that are shared across applications. A typical path is C:\Program Files\Common.
-
-
-
CSIDL_RESOURCES
-
The file-system directory that contains resource data. A typical path is C:\Windows\Resources.
-
-
-
CSIDL_SYSTEM
-
The Windows System folder. A typical path is C:\Windows\System32.
-
-
-
CSIDL_WINDOWS
-
The Windows directory or system root. This corresponds to the %WINDIR% or %SYSTEMROOT% environment variables. A typical path is C:\Windows.
-
-
-
DEFAULTUSERPROFILE
-
Refers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [DefaultUserProfile].
-
-
-
PROFILESFOLDER
-
Refers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [ProfilesDirectory].
-
-
-
PROGRAMFILES
-
Same as CSIDL_PROGRAM_FILES.
-
-
-
PROGRAMFILES(X86)
-
Refers to the C:\Program Files (x86) folder on 64-bit systems.
-
-
-
SYSTEM
-
Refers to %WINDIR%\system32.
-
-
-
SYSTEM16
-
Refers to %WINDIR%\system.
-
-
-
SYSTEM32
-
Refers to %WINDIR%\system32.
-
-
-
SYSTEMPROFILE
-
Refers to the value in HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList\S-1-5-18 [ProfileImagePath].
-
-
-
SYSTEMROOT
-
Refers to the root of the system drive.
-
-
-
WINDIR
-
Refers to the Windows folder located on the system drive.
-
-
-
-
-
+|Variable|Explanation|
+|--- |--- |
+|**ALLUSERSAPPDATA**|Same as **CSIDL_COMMON_APPDATA**.|
+|**ALLUSERSPROFILE**|Refers to %**PROFILESFOLDER**%\Public or %**PROFILESFOLDER**%\all users.|
+|**COMMONPROGRAMFILES**|Same as **CSIDL_PROGRAM_FILES_COMMON**.|
+|**COMMONPROGRAMFILES**(X86)|Refers to the C:\Program Files (x86)\Common Files folder on 64-bit systems.|
+|**CSIDL_COMMON_ADMINTOOLS**|Version 10.0. The file-system directory that contains administrative tools for all users of the computer.|
+|**CSIDL_COMMON_ALTSTARTUP**|The file-system directory that corresponds to the non-localized Startup program group for all users.|
+|**CSIDL_COMMON_APPDATA**|The file-system directory that contains application data for all users. A typical path Windows is C:\ProgramData.|
+|**CSIDL_COMMON_DESKTOPDIRECTORY**|The file-system directory that contains files and folders that appear on the desktop for all users. A typical Windows® XP path is C:\Documents and Settings\All Users\Desktop. A typical path is C:\Users\Public\Desktop.|
+|**CSIDL_COMMON_DOCUMENTS**|The file-system directory that contains documents that are common to all users. A typical path in Windows XP is C:\Documents and Settings\All Users\Documents. A typical path is C:\Users\Public\Documents.|
+|**CSIDL_COMMON_FAVORITES**|The file-system directory that serves as a common repository for favorites common to all users. A typical path is C:\Users\Public\Favorites.|
+|**CSIDL_COMMON_MUSIC**|The file-system directory that serves as a repository for music files common to all users. A typical path is C:\Users\Public\Music.|
+|**CSIDL_COMMON_PICTURES**|The file-system directory that serves as a repository for image files common to all users. A typical path is C:\Users\Public\Pictures.|
+|**CSIDL_COMMON_PROGRAMS**|The file-system directory that contains the directories for the common program groups that appear on the **Start** menu for all users. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs.|
+|**CSIDL_COMMON_STARTMENU**|The file-system directory that contains the programs and folders which appear on the **Start** menu for all users. A typical path in Windows is C:\ProgramData\Microsoft\Windows\Start Menu.|
+|**CSIDL_COMMON_STARTUP**|The file-system directory that contains the programs that appear in the Startup folder for all users. A typical path in Windows XP is C:\Documents and Settings\All Users\Start Menu\Programs\Startup. A typical path is C:\ProgramData\Microsoft\Windows\Start Menu\Programs\Startup.|
+|**CSIDL_COMMON_TEMPLATES**|The file-system directory that contains the templates that are available to all users. A typical path is C:\ProgramData\Microsoft\Windows\Templates.|
+|**CSIDL_COMMON_VIDEO**|The file-system directory that serves as a repository for video files common to all users. A typical path is C:\Users\Public\Videos.|
+|**CSIDL_DEFAULT_APPDATA**|Refers to the Appdata folder inside %**DEFAULTUSERPROFILE**%.|
+|C**SIDL_DEFAULT_LOCAL_APPDATA**|Refers to the local Appdata folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_COOKIES**|Refers to the Cookies folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_CONTACTS**|Refers to the Contacts folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_DESKTOP**|Refers to the Desktop folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_DOWNLOADS**|Refers to the Downloads folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_FAVORITES**|Refers to the Favorites folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_HISTORY**|Refers to the History folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_INTERNET_CACHE**|Refers to the Internet Cache folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_PERSONAL**|Refers to the Personal folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_MYDOCUMENTS**|Refers to the My Documents folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_MYPICTURES**|Refers to the My Pictures folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_MYMUSIC**|Refers to the My Music folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_MYVIDEO**|Refers to the My Videos folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_RECENT**|Refers to the Recent folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_SENDTO**|Refers to the Send To folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_STARTMENU**|Refers to the Start Menu folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_PROGRAMS**|Refers to the Programs folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_STARTUP**|Refers to the Startup folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_TEMPLATES**|Refers to the Templates folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_DEFAULT_QUICKLAUNCH**|Refers to the Quick Launch folder inside %**DEFAULTUSERPROFILE**%.|
+|**CSIDL_FONTS**|A virtual folder containing fonts. A typical path is C:\Windows\Fonts.|
+|**CSIDL_PROGRAM_FILESX86**|The Program Files folder on 64-bit systems. A typical path is C:\Program Files(86).|
+|**CSIDL_PROGRAM_FILES_COMMONX86**|A folder for components that are shared across applications on 64-bit systems. A typical path is C:\Program Files(86)\Common.|
+|**CSIDL_PROGRAM_FILES**|The Program Files folder. A typical path is C:\Program Files.|
+|**CSIDL_PROGRAM_FILES_COMMON**|A folder for components that are shared across applications. A typical path is C:\Program Files\Common.|
+|**CSIDL_RESOURCES**|The file-system directory that contains resource data. A typical path is C:\Windows\Resources.|
+|**CSIDL_SYSTEM**|The Windows System folder. A typical path is C:\Windows\System32.|
+|**CSIDL_WINDOWS**|The Windows directory or system root. This corresponds to the %**WINDIR**% or %**SYSTEMROOT**% environment variables. A typical path is C:\Windows.|
+|**DEFAULTUSERPROFILE**|Refers to the value in **HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [DefaultUserProfile]**.|
+|**PROFILESFOLDER**|Refers to the value in **HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList [ProfilesDirectory]**.|
+|**PROGRAMFILES**|Same as **CSIDL_PROGRAM_FILES**.|
+|**PROGRAMFILES(X86)**|Refers to the C:\Program Files (x86) folder on 64-bit systems.|
+|**SYSTEM**|Refers to %**WINDIR**%\system32.|
+|**SYSTEM16**|Refers to %**WINDIR**%\system.|
+|**SYSTEM32**|Refers to %**WINDIR**%\system32.|
+|**SYSTEMPROFILE**|Refers to the value in **HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\ProfileList\S-1-5-18 [ProfileImagePath]**.|
+|**SYSTEMROOT**|Refers to the root of the system drive.|
+|**WINDIR**|Refers to the Windows folder located on the system drive.|
## Variables that are recognized only in the user context
-
You can use these variables in the .xml files within sections with `context=User` and `context=UserAndSystem`.
-
-
-
-
-
-
-
-
Variable
-
Explanation
-
-
-
-
-
APPDATA
-
Same as CSIDL_APPDATA.
-
-
-
CSIDL_ADMINTOOLS
-
The file-system directory that is used to store administrative tools for an individual user. The Microsoft® Management Console (MMC) saves customized consoles to this directory, which roams with the user profile.
-
-
-
CSIDL_ALTSTARTUP
-
The file-system directory that corresponds to the user's non-localized Startup program group.
-
-
-
CSIDL_APPDATA
-
The file-system directory that serves as a common repository for application-specific data. A typical path is C:\Documents and Settings\username\Application Data or C:\Users\username\AppData\Roaming.
-
-
-
CSIDL_BITBUCKET
-
The virtual folder that contains the objects in the user's Recycle Bin.
-
-
-
CSIDL_CDBURN_AREA
-
The file-system directory acting as a staging area for files waiting to be written to CD. A typical path is C:\Users\username\AppData\Local\Microsoft\Windows\MasteredBurning\Disc Burning.
-
-
-
CSIDL_CONNECTIONS
-
The virtual folder representing Network Connections that contains network and dial-up connections.
-
-
-
CSIDL_CONTACTS
-
This refers to the Contacts folder in %CSIDL_PROFILE%.
-
-
-
CSIDL_CONTROLS
-
The virtual folder that contains icons for the Control Panel items.
-
-
-
CSIDL_COOKIES
-
The file-system directory that serves as a common repository for Internet cookies. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Cookies.
-
-
-
CSIDL_DESKTOP
-
The virtual folder representing the Windows desktop.
-
-
-
CSIDL_DESKTOPDIRECTORY
-
The file-system directory used to physically store file objects on the desktop, which should not be confused with the desktop folder itself. A typical path is C:\Users\username\Desktop.
-
-
-
CSIDL_DRIVES
-
The virtual folder representing My Computer that contains everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.
-
-
-
CSIDL_FAVORITES
-
The file-system directory that serves as a common repository for the user's favorites. A typical path is C:\Users\Username\Favorites.
-
-
-
CSIDL_HISTORY
-
The file-system directory that serves as a common repository for Internet history items.
-
-
-
CSIDL_INTERNET
-
A virtual folder for Internet Explorer.
-
-
-
CSIDL_INTERNET_CACHE
-
The file-system directory that serves as a common repository for temporary Internet files. A typical path is C:\Users\username\AppData\Local\Microsoft\Windows\Temporary Internet Files
-
-
-
CSIDL_LOCAL_APPDATA
-
The file-system directory that serves as a data repository for local, non-roaming applications. A typical path is C:\Users\username\AppData\Local.
-
-
-
CSIDL_MYDOCUMENTS
-
The virtual folder representing My Documents.A typical path is C:\Users\Username\Documents.
-
-
-
CSIDL_MYMUSIC
-
The file-system directory that serves as a common repository for music files. A typical path is C:\Users\Username\Music.
-
-
-
CSIDL_MYPICTURES
-
The file-system directory that serves as a common repository for image files. A typical path is C:\Users\Username\Pictures.
-
-
-
CSIDL_MYVIDEO
-
The file-system directory that serves as a common repository for video files. A typical path is C:\Users\Username\Videos.
-
-
-
CSIDL_NETHOOD
-
A file-system directory that contains the link objects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Network Shortcuts.
-
-
-
CSIDL_NETWORK
-
A virtual folder representing My Network Places, the root of the network namespace hierarchy.
-
-
-
CSIDL_PERSONAL
-
The virtual folder representing the My Documents desktop item. This is equivalent to CSIDL_MYDOCUMENTS.
-
A typical path is C:\Documents and Settings\username\My Documents.
-
-
-
CSIDL_PLAYLISTS
-
The virtual folder used to store play albums, typically C:\Users\username\My Music\Playlists.
-
-
-
CSIDL_PRINTERS
-
The virtual folder that contains installed printers.
-
-
-
CSIDL_PRINTHOOD
-
The file-system directory that contains the link objects that can exist in the Printers virtual folder. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Printer Shortcuts.
-
-
-
CSIDL_PROFILE
-
The user's profile folder. A typical path is C:\Users\Username.
-
-
-
CSIDL_PROGRAMS
-
The file-system directory that contains the user's program groups, which are themselves file-system directories. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs.
-
-
-
CSIDL_RECENT
-
The file-system directory that contains shortcuts to the user's most recently used documents. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Recent.
-
-
-
CSIDL_SENDTO
-
The file-system directory that contains Send To menu items. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\SendTo.
-
-
-
CSIDL_STARTMENU
-
The file-system directory that contains Start menu items. A typical path in Windows XP is C:\Documents and Settings\username\Start Menu. A typical path in Windows Vista, Windows 7, or Windows 8 is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu.
-
-
-
CSIDL_STARTUP
-
The file-system directory that corresponds to the user's Startup program group. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup.
-
-
-
CSIDL_TEMPLATES
-
The file-system directory that serves as a common repository for document templates. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Templates.
-
-
-
HOMEPATH
-
Same as the standard environment variable.
-
-
-
TEMP
-
The temporary folder on the computer. A typical path is %USERPROFILE%\AppData\Local\Temp.
-
-
-
TMP
-
The temporary folder on the computer. A typical path is %USERPROFILE%\AppData\Local\Temp.
-
-
-
USERPROFILE
-
Same as CSIDL_PROFILE.
-
-
-
USERSID
-
Represents the current user-account security identifier (SID). For example,
-
S-1-5-21-1714567821-1326601894-715345443-1026.
-
-
-
-
-
+|Variable|Explanation|
+|--- |--- |
+|**APPDATA**|Same as **CSIDL_APPDATA**.|
+|**CSIDL_ADMINTOOLS**|The file-system directory that is used to store administrative tools for an individual user. The Microsoft® Management Console (MMC) saves customized consoles to this directory, which roams with the user profile.|
+|**CSIDL_ALTSTARTUP**|The file-system directory that corresponds to the user's non-localized Startup program group.|
+|**CSIDL_APPDATA**|The file-system directory that serves as a common repository for application-specific data. A typical path is C:\Documents and Settings\username\Application Data or C:\Users\username\AppData\Roaming.|
+|**CSIDL_BITBUCKET**|The virtual folder that contains the objects in the user's Recycle Bin.|
+|**CSIDL_CDBURN_AREA**|The file-system directory acting as a staging area for files waiting to be written to CD. A typical path is C:\Users\username\AppData\Local\Microsoft\Windows\MasteredBurning\Disc Burning.|
+|**CSIDL_CONNECTIONS**|The virtual folder representing Network Connections that contains network and dial-up connections.|
+|**CSIDL_CONTACTS**|This refers to the Contacts folder in %**CSIDL_PROFILE**%.|
+|**CSIDL_CONTROLS**|The virtual folder that contains icons for the Control Panel items.|
+|**CSIDL_COOKIES**|The file-system directory that serves as a common repository for Internet cookies. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Cookies.|
+|**CSIDL_DESKTOP**|The virtual folder representing the Windows desktop.|
+|**CSIDL_DESKTOPDIRECTORY**|The file-system directory used to physically store file objects on the desktop, which should not be confused with the desktop folder itself. A typical path is C:\Users\username\Desktop.|
+|**CSIDL_DRIVES**|The virtual folder representing My Computer that contains everything on the local computer: storage devices, printers, and Control Panel. The folder may also contain mapped network drives.|
+|**CSIDL_FAVORITES**|The file-system directory that serves as a common repository for the user's favorites. A typical path is C:\Users\Username\Favorites.|
+|**CSIDL_HISTORY**|The file-system directory that serves as a common repository for Internet history items.|
+|**CSIDL_INTERNET**|A virtual folder for Internet Explorer.|
+|**CSIDL_INTERNET_CACHE**|The file-system directory that serves as a common repository for temporary Internet files. A typical path is C:\Users\username\AppData\Local\Microsoft\Windows\Temporary Internet Files|
+|**CSIDL_LOCAL_APPDATA**|The file-system directory that serves as a data repository for local, non-roaming applications. A typical path is C:\Users\username\AppData\Local.|
+|**CSIDL_MYDOCUMENTS**|The virtual folder representing My Documents.A typical path is C:\Users\Username\Documents.|
+|**CSIDL_MYMUSIC**|The file-system directory that serves as a common repository for music files. A typical path is C:\Users\Username\Music.|
+|**CSIDL_MYPICTURES**|The file-system directory that serves as a common repository for image files. A typical path is C:\Users\Username\Pictures.|
+|**CSIDL_MYVIDEO**|The file-system directory that serves as a common repository for video files. A typical path is C:\Users\Username\Videos.|
+|**CSIDL_NETHOOD**|A file-system directory that contains the link objects that may exist in the My Network Places virtual folder. It is not the same as CSIDL_NETWORK, which represents the network namespace root. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Network Shortcuts.|
+|**CSIDL_NETWORK**|A virtual folder representing My Network Places, the root of the network namespace hierarchy.|
+|**CSIDL_PERSONAL**|The virtual folder representing the My Documents desktop item. This is equivalent to **CSIDL_MYDOCUMENTS**. A typical path is C:\Documents and Settings\username\My Documents.|
+|**CSIDL_PLAYLISTS**|The virtual folder used to store play albums, typically C:\Users\username\My Music\Playlists.|
+|**CSIDL_PRINTERS**|The virtual folder that contains installed printers.|
+|**CSIDL_PRINTHOOD**|The file-system directory that contains the link objects that can exist in the Printers virtual folder. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Printer Shortcuts.|
+|**CSIDL_PROFILE**|The user's profile folder. A typical path is C:\Users\Username.|
+|**CSIDL_PROGRAMS**|The file-system directory that contains the user's program groups, which are themselves file-system directories. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs.|
+|**CSIDL_RECENT**|The file-system directory that contains shortcuts to the user's most recently used documents. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Recent.|
+|**CSIDL_SENDTO**|The file-system directory that contains **Send To** menu items. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\SendTo.|
+|**CSIDL_STARTMENU**|The file-system directory that contains **Start** menu items. A typical path in Windows XP is C:\Documents and Settings\username\Start Menu. A typical path in Windows Vista, Windows 7, or Windows 8 is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu.|
+|**CSIDL_STARTUP**|The file-system directory that corresponds to the user's Startup program group. A typical path is C:\Users\Username\AppData\Roaming\Microsoft\Windows\Start Menu\Programs\Startup.|
+|**CSIDL_TEMPLATES**|The file-system directory that serves as a common repository for document templates. A typical path is C:\Users\username\AppData\Roaming\Microsoft\Windows\Templates.|
+|**HOMEPATH**|Same as the standard environment variable.|
+|**TEMP**|The temporary folder on the computer. A typical path is %**USERPROFILE**%\AppData\Local\Temp.|
+|**TMP**|The temporary folder on the computer. A typical path is %**USERPROFILE**%\AppData\Local\Temp.|
+|**USERPROFILE**|Same as **CSIDL_PROFILE**.|
+|**USERSID**|Represents the current user-account security identifier (SID). For example, S-1-5-21-1714567821-1326601894-715345443-1026.|
## Related topics
-
[USMT XML Reference](usmt-xml-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-reference.md b/windows/deployment/usmt/usmt-reference.md
index 7e00f19577..a24a5da4cd 100644
--- a/windows/deployment/usmt/usmt-reference.md
+++ b/windows/deployment/usmt/usmt-reference.md
@@ -16,63 +16,22 @@ ms.topic: article
# User State Migration Toolkit (USMT) Reference
-
## In This Section
-
-
Find requirements, best practices, and other considerations for performing a migration offline.
-
-
-
-
-
+| Link | Description |
+|--- |--- |
+|[USMT Requirements](usmt-requirements.md)|Describes operating system, hardware, and software requirements, and user prerequisites.|
+|[USMT Best Practices](usmt-best-practices.md)|Discusses general and security-related best practices when using USMT.|
+|[How USMT Works](usmt-how-it-works.md)|Learn about the processes behind the ScanState and LoadState tools.|
+|[Plan Your Migration](usmt-plan-your-migration.md)|Choose what to migrate and the best migration scenario for your enterprise.|
+|[User State Migration Tool (USMT) Command-line Syntax](usmt-command-line-syntax.md)|Explore command-line options for the ScanState, LoadState, and UsmtUtils tools.|
+|[USMT XML Reference](usmt-xml-reference.md)|Learn about customizing a migration with XML files.|
+|[Offline Migration Reference](offline-migration-reference.md)|Find requirements, best practices, and other considerations for performing a migration offline.|
## Related topics
-
[User State Migration Tool (USMT) Overview Topics](usmt-topics.md)
[User State Migration Tool (USMT) How-to topics](usmt-how-to.md)
[User State Migration Tool (USMT) Troubleshooting](usmt-troubleshooting.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-requirements.md b/windows/deployment/usmt/usmt-requirements.md
index 9134680979..5df90fe4bb 100644
--- a/windows/deployment/usmt/usmt-requirements.md
+++ b/windows/deployment/usmt/usmt-requirements.md
@@ -16,10 +16,8 @@ ms.topic: article
# USMT Requirements
-
## In This Topic
-
- [Supported Operating Systems](#bkmk-1)
- [Windows PE](#windows-pe)
- [Credentials](#credentials)
@@ -30,63 +28,21 @@ ms.topic: article
## Supported Operating Systems
-
The User State Migration Tool (USMT) 10.0 does not have any explicit RAM or CPU speed requirements for either the source or destination computers. If your computer complies with the system requirements of the operating system, it also complies with the requirements for USMT. You need an intermediate store location large enough to hold all of the migrated data and settings, and the same amount of hard disk space on the destination computer for the migrated files and settings.
The following table lists the operating systems supported in USMT.
-
+|Operating Systems|ScanState (source computer)|LoadState (destination computer)|
+|--- |--- |--- |
+|32-bit versions of Windows 7|✔️|✔️|
+|64-bit versions of Windows 7|✔️|✔️|
+|32-bit versions of Windows 8|✔️|✔️|
+|64-bit versions of Windows 8|✔️|✔️|
+|32-bit versions of Windows 10|✔️|✔️|
+|64-bit versions of Windows 10|✔️|✔️|
-
-
-
-
-
-
-
-
Operating Systems
-
ScanState (source computer)
-
LoadState (destination computer)
-
-
-
-
-
32-bit versions of Windows 7
-
X
-
X
-
-
-
64-bit versions of Windows 7
-
X
-
X
-
-
-
32-bit versions of Windows 8
-
X
-
X
-
-
-
64-bit versions of Windows 8
-
X
-
X
-
-
-
32-bit versions of Windows 10
-
X
-
X
-
-
-
64-bit versions of Windows 10
-
X
-
X
-
-
-
-
-
-
-**Note**
-You can migrate a 32-bit operating system to a 64-bit operating system. However, you cannot migrate a 64-bit operating system to a 32-bit operating system.
+> [!NOTE]
+> You can migrate a 32-bit operating system to a 64-bit operating system. However, you cannot migrate a 64-bit operating system to a 32-bit operating system.
USMT does not support any of the Windows Server® operating systems, Windows 2000, Windows XP, or any of the starter editions for Windows Vista or Windows 7.
@@ -100,7 +56,7 @@ For more information about previous releases of the USMT tools, see [User State
## Credentials
- **Run as administrator**
- When manually running the **ScanState** and **LoadState** tools on Windows 7, Windows 8 or Windows 10 you must run them from an elevated command prompt to ensure that all specified users are migrated. If you do not run USMT from an elevated prompt, only the user profile that is logged on will be included in the migration.
+ When manually running the **ScanState** and **LoadState** tools on Windows 7, Windows 8, or Windows 10 you must run them from an elevated command prompt to ensure that all specified users are migrated. If you do not run USMT from an elevated prompt, only the user profile that is logged on will be included in the migration.
To open an elevated command prompt:
@@ -110,8 +66,8 @@ To open an elevated command prompt:
3. Right-click **cmd** or **Command Prompt**, and then click **Run as administrator**.
4. If the current user is not already an administrator, you will be prompted to enter administrator credentials.
-**Important**
-You must run USMT using an account with full administrative permissions, including the following privileges:
+> [!IMPORTANT]
+> You must run USMT using an account with full administrative permissions, including the following privileges:
- SeBackupPrivilege (Back up files and directories)
- SeDebugPrivilege (Debug programs)
@@ -119,11 +75,10 @@ You must run USMT using an account with full administrative permissions, includi
- SeSecurityPrivilege (Manage auditing and security log)
- SeTakeOwnership Privilege (Take ownership of files or other objects)
-
## Config.xml
- **Specify the /c option and <ErrorControl> settings in the Config.xml file.**
- USMT will fail if it cannot migrate a file or setting, unless you specify the **/c** option. When you specify the **/c** option, USMT logs an error each time it encounters a file that is in use that did not migrate, but the migration will not be interrupted. In USMT, you can specify in the Config.xml file which types of errors should allow the migration to continue, and which should cause the migration to fail. For more information about error reporting, and the **<ErrorControl>** element, see [Config.xml File](usmt-configxml-file.md), [Log Files](usmt-log-files.md), and [XML Elements Library](usmt-xml-elements-library.md).
+ USMT will fail if it cannot migrate a file or setting, unless you specify the **/c** option. When you specify the **/c** option, USMT logs an error each time it encounters a file that is in use that did not migrate, but the migration will not be interrupted. In USMT, you can specify in the Config.xml file, which types of errors should allow the migration to continue, and which should cause the migration to fail. For more information about error reporting, and the **<ErrorControl>** element, see [Config.xml File](usmt-configxml-file.md), [Log Files](usmt-log-files.md), and [XML Elements Library](usmt-xml-elements-library.md).
## LoadState
@@ -132,12 +87,10 @@ You must run USMT using an account with full administrative permissions, includi
## Hard-Disk Requirements
-
Ensure that there is enough available space in the migration-store location and on the source and destination computers. For more information, see [Estimate Migration Store Size](usmt-estimate-migration-store-size.md).
## User Prerequisites
-
This documentation assumes that IT professionals using USMT understand command-line tools. The documentation also assumes that IT professionals using USMT to author MigXML rules understand the following:
- The navigation and hierarchy of the Windows registry.
@@ -147,10 +100,6 @@ This documentation assumes that IT professionals using USMT understand command-l
## Related topics
-
[Plan Your Migration](usmt-plan-your-migration.md)
[Estimate Migration Store Size](usmt-estimate-migration-store-size.md)
[User State Migration Tool (USMT) Overview Topics](usmt-topics.md)
-
-
-
diff --git a/windows/deployment/usmt/usmt-return-codes.md b/windows/deployment/usmt/usmt-return-codes.md
index 44089d6d19..b10a808b61 100644
--- a/windows/deployment/usmt/usmt-return-codes.md
+++ b/windows/deployment/usmt/usmt-return-codes.md
@@ -16,14 +16,12 @@ ms.topic: article
# Return Codes
-
This topic describes User State Migration Tool (USMT) 10.0 return codes and error messages. Also included is a table listing the USMT return codes with their associated mitigation steps. In addition, this topic provides tips to help you use the logfiles to determine why you received an error.
Understanding the requirements for running USMT can help minimize errors in your USMT migrations. For more information, see [USMT Requirements](usmt-requirements.md).
## In This Topic
-
[USMT Return Codes](#bkmk-returncodes)
[USMT Error Messages](#bkmk-errormessages)
@@ -32,7 +30,6 @@ Understanding the requirements for running USMT can help minimize errors in your
## USMT Return Codes
-
If you encounter an error in your USMT migration, you can use return codes and the more specific information provided in the associated USMT error messages to troubleshoot the issue and to identify mitigation steps.
Return codes are grouped into the following broad categories that describe their area of error reporting:
@@ -51,731 +48,231 @@ As a best practice, we recommend that you set verbosity level to 5, **/v**:5
## USMT Error Messages
-
Error messages provide more detailed information about the migration problem than the associated return code. For example, the **ScanState**, **LoadState**, or **USMTUtils** tool might return a code of "11” (for “USMT\_INVALID\_PARAMETERS") and a related error message that reads "/key and /keyfile both specified". The error message is displayed at the command prompt and is identified in the **ScanState**, **LoadState**, or **USMTUtils** log files to help you determine why the return code was received.
You can obtain more information about any listed Windows application programming interface (API) system error codes by typing **net helpmsg** on the command line and, then typing the error code number. For more information about System Error Codes, see [this Microsoft Web site](/windows/win32/debug/system-error-codes--0-499-).
## Troubleshooting Return Codes and Error Messages
+The following information lists each return code by numeric value, along with the associated error messages and suggested troubleshooting actions.
-The following table lists each return code by numeric value, along with the associated error messages and suggested troubleshooting actions.
+- **0: USMT_SUCCESS**
+ - **Error message**: Successful run
-
-
-
-
-
-
-
-
-
-
-
Return code value
-
Return code
-
Error message
-
Troubleshooting, mitigation, workarounds
-
Category
-
-
-
-
-
0
-
USMT_SUCCESS
-
Successful run
-
Not applicable
-
Success or Cancel
-
-
-
1
-
USMT_DISPLAY_HELP
-
Command line help requested
-
Not applicable
-
Success or Cancel
-
-
-
2
-
USMT_STATUS_CANCELED
-
Gather was aborted because of an EFS file
-
Not applicable
-
-
-
-
-
-
User chose to cancel (such as pressing CTRL+C)
-
Not applicable
-
Success or Cancel
-
-
-
3
-
USMT_WOULD_HAVE_FAILED
-
At least one error was skipped as a result of /c
-
Review ScanState, LoadState, or UsmtUtils log for details about command-line errors.
-
-
-
-
11
-
USMT_INVALID_PARAMETERS
-
/all conflicts with /ui, /ue or /uel
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/auto expects an optional parameter for the script folder
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/encrypt can't be used with /nocompress
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/encrypt requires /key or /keyfile
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/genconfig can't be used with most other options
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/genmigxml can't be used with most other options
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/hardlink requires /nocompress
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/key and /keyfile both specified
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/key or /keyfile used without enabling encryption
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/lae is only used with /lac
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/listfiles cannot be used with /p
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/offline requires a valid path to an XML file describing offline paths
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/offlinewindir requires a valid path to offline windows folder
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
/offlinewinold requires a valid path to offline windows folder
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
A command was already specified
-
Verify that the command-line syntax is correct and that there are no duplicate commands.
-
-
-
-
-
-
An option argument is missing
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
An option is specified more than once and is ambiguous
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
By default /auto selects all users and uses the highest log verbosity level. Switches like /all, /ui, /ue, /v are not allowed.
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Command line arguments are required. Specify /? for options.
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Command line option is not valid
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
EFS parameter specified is not valid for /efs
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
File argument is invalid for /genconfig
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
File argument is invalid for /genmigxml
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Invalid space estimate path. Check the parameters and/or file system permissions
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
List file path argument is invalid for /listfiles
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Retry argument must be an integer
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Settings store argument specified is invalid
-
Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set.
-
-
-
-
-
-
Specified encryption algorithm is not supported
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
The /efs:hardlink requires /hardlink
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
The /targetWindows7 option is only available for Windows XP, Windows Vista, and Windows 7
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
The store parameter is required but not specified
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
The source-to-target domain mapping is invalid for /md
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
The source-to-target user account mapping is invalid for /mu
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Undefined or incomplete command line option
-
Review ScanState log or LoadState log for details about command-line errors.
-
Invalid Command Lines
-
-
-
-
-
Use /nocompress, or provide an XML file path with /p"pathtoafile" to get a compressed store size estimate
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
User exclusion argument is invalid
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Verbosity level must be specified as a sum of the desired log options: Verbose (0x01), Record Objects (0x04), Echo to debug port (0x08)
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Volume shadow copy feature is not supported with a hardlink store
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
-
-
Wait delay argument must be an integer
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
12
-
USMT_ERROR_OPTION_PARAM_TOO_LARGE
-
Command line arguments cannot exceed 256 characters
-
Review ScanState log or LoadState log for details about command-line errors.
-
Invalid Command Lines
-
-
-
-
-
Specified settings store path exceeds the maximum allowed length of 256 characters
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
13
-
USMT_INIT_LOGFILE_FAILED
-
Log path argument is invalid for /l
-
When /l is specified in the ScanState command line, USMT validates the path. Verify that the drive and other information, for example file system characters, are correct.
-
Invalid Command Lines
-
-
-
14
-
USMT_ERROR_USE_LAC
-
Unable to create a local account because /lac was not specified
-
When creating local accounts, the command-line options /lac and /lae should be used.
-
Invalid Command Lines
-
-
-
26
-
USMT_INIT_ERROR
-
Multiple Windows installations found
-
Listfiles.txt could not be created. Verify that the location you specified for the creation of this file is valid.
-
Setup and Initialization
-
-
-
-
-
Software malfunction or unknown exception
-
Check all loaded .xml files for errors, common error when using /I to load the Config.xml file.
-
-
-
-
-
-
Unable to find a valid Windows directory to proceed with requested offline operation; Check if offline input file is present and has valid entries
-
Verify that the offline input file is present and that it has valid entries. USMT could not find valid offline operating system. Verify your offline directory mapping.
-
-
-
-
27
-
USMT_INVALID_STORE_LOCATION
-
A store path can't be used because an existing store exists; specify /o to overwrite
-
Specify /o to overwrite an existing intermediate or migration store.
-
Setup and Initialization
-
-
-
-
-
A store path is missing or has incomplete data
-
Make sure that the store path is accessible and that the proper permission levels are set.
-
-
-
-
-
-
An error occurred during store creation
-
Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store.
-
-
-
-
-
-
An inappropriate device such as a floppy disk was specified for the store
-
Make sure that the store path is accessible and that the proper permission levels are set.
-
-
-
-
-
-
Invalid store path; check the store parameter and/or file system permissions
-
Invalid store path; check the store parameter and/or file system permissions
-
-
-
-
-
-
The file layout and/or file content is not recognized as a valid store
-
Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store.
-
-
-
-
-
-
The store path holds a store incompatible with the current USMT version
-
Make sure that the store path is accessible and that the proper permission levels are set.
-
-
-
-
-
-
The store save location is read-only or does not support a requested storage option
-
Make sure that the store path is accessible and that the proper permission levels are set.
-
-
-
-
28
-
USMT_UNABLE_GET_SCRIPTFILES
-
Script file is invalid for /i
-
Check all specified migration .xml files for errors. This is a common error when using /i to load the Config.xml file.
-
Setup and Initialization
-
-
-
-
-
Unable to find a script file specified by /i
-
Verify the location of your script files, and ensure that the command-line options are correct.
-
-
-
-
29
-
USMT_FAILED_MIGSTARTUP
-
A minimum of 250 MB of free space is required for temporary files
-
Verify that the system meets the minimum temporary disk space requirement of 250 MB. As a workaround, you can set the environment variable USMT_WORKING_DIR=<path> to redirect the temporary files working directory.
-
Setup and Initialization
-
-
-
-
-
Another process is preventing migration; only one migration tool can run at a time
-
Check the ScanState log file for migration .xml file errors.
-
-
-
-
-
-
Failed to start main processing, look in log for system errors or check the installation
-
Check the ScanState log file for migration .xml file errors.
-
-
-
-
-
-
Migration failed because of an XML error; look in the log for specific details
-
Check the ScanState log file for migration .xml file errors.
-
-
-
-
-
-
Unable to automatically map the drive letters to match the online drive letter layout; Use /offline to provide a mapping table
-
Check the ScanState log file for migration .xml file errors.
-
-
-
-
31
-
USMT_UNABLE_FINDMIGUNITS
-
An error occurred during the discover phase; the log should have more specific information
-
Check the ScanState log file for migration .xml file errors.
-
Setup and Initialization
-
-
-
32
-
USMT_FAILED_SETMIGRATIONTYPE
-
An error occurred processing the migration system
-
Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line.
-
Setup and Initialization
-
-
-
33
-
USMT_UNABLE_READKEY
-
Error accessing the file specified by the /keyfile parameter
-
Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line.
-
Setup and Initialization
-
-
-
-
-
The encryption key must have at least one character
-
Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line.
-
-
-
-
34
-
USMT_ERROR_INSUFFICIENT_RIGHTS
-
Directory removal requires elevated privileges
-
Log on as Administrator, and run with elevated privileges.
-
Setup and Initialization
-
-
-
-
-
No rights to create user profiles; log in as Administrator; run with elevated privileges
-
Log on as Administrator, and run with elevated privileges.
-
-
-
-
-
-
No rights to read or delete user profiles; log in as Administrator, run with elevated privileges
-
Log on as Administrator, and run with elevated privileges.
-
-
-
-
35
-
USMT_UNABLE_DELETE_STORE
-
A reboot is required to remove the store
-
Reboot to delete any files that could not be deleted when the command was executed.
-
Setup and Initialization
-
-
-
-
-
A store path can't be used because it contains data that could not be overwritten
-
A migration store could not be deleted. If you are using a hardlink migration store you might have a locked file in it. You should manually delete the store, or use USMTUtils /rd command to delete the store.
-
-
-
-
-
-
There was an error removing the store
-
Review ScanState log or LoadState log for details about command-line errors.
-
-
-
-
36
-
USMT_ERROR_UNSUPPORTED_PLATFORM
-
Compliance check failure; please check the logs for details
-
Investigate whether there is an active temporary profile on the system.
-
Setup and Initialization
-
-
-
-
-
Use of /offline is not supported during apply
-
The /offline command was not used while running in the Windows Preinstallation Environment (WinPE).
-
-
-
-
-
-
Use /offline to run gather on this platform
-
The /offline command was not used while running in WinPE.
-
-
-
-
37
-
USMT_ERROR_NO_INVALID_KEY
-
The store holds encrypted data but the correct encryption key was not provided
-
Verify that you have included the correct encryption /key or /keyfile.
-
Setup and Initialization
-
-
-
38
-
USMT_ERROR_CORRUPTED_NOTENCRYPTED_STORE
-
An error occurred during store access
-
Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set.
-
Setup and Initialization
-
-
-
39
-
USMT_UNABLE_TO_READ_CONFIG_FILE
-
Error reading Config.xml
-
Review ScanState log or LoadState log for details about command-line errors in the Config.xml file.
-
Setup and Initialization
-
-
-
-
-
File argument is invalid for /config
-
Check the command line you used to load the Config.xml file. You can use online Help by typing /? on the command line.
-
-
-
-
40
-
USMT_ERROR_UNABLE_CREATE_PROGRESS_LOG
-
Error writing to the progress log
-
The Progress log could not be created. Verify that the location is valid and that you have write access.
-
Setup and Initialization
-
-
-
-
-
Progress log argument is invalid for /progress
-
The Progress log could not be created. Verify that the location is valid and that you have write access.
-
-
-
-
41
-
USMT_PREFLIGHT_FILE_CREATION_FAILED
-
Can't overwrite existing file
-
The Progress log could not be created. Verify that the location is valid and that you have write access.
-
Setup and Initialization
-
-
-
-
-
Invalid space estimate path. Check the parameters and/or file system permissions
-
Review ScanState log or LoadState log for details about command-line errors.
USMT exited but can continue with the /c command-line option, with the optional configurable <ErrorControl> section or by using the /vsc command-line option.
-
Non-fatal Errors
-
-
-
71
-
USMT_INIT_OPERATING_ENVIRONMENT_FAILED
-
A Windows Win32 API error occurred
-
Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details.
-
Fatal Errors
-
-
-
-
-
An error occurred when attempting to initialize the diagnostic mechanisms such as the log
-
Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
-
-
Failed to record diagnostic information
-
Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
-
-
Unable to start. Make sure you are running USMT with elevated privileges
-
Exit USMT and log in again with elevated privileges.
-
-
-
-
72
-
USMT_UNABLE_DOMIGRATION
-
An error occurred closing the store
-
Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
-
Fatal Errors
-
-
-
-
-
An error occurred in the apply process
-
Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
-
-
An error occurred in the gather process
-
Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
-
-
Out of disk space while writing the store
-
Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
-
-
Out of temporary disk space on the local system
-
Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
-
-
-
-
+- **1: USMT_DISPLAY_HELP**
+ - **Error message**: Command line help requested
-
+- **2: USMT_STATUS_CANCELED**
+ - **Error message**:
+ - Gather was aborted because of an EFS file
+ - User chose to cancel (such as pressing CTRL+C)
+
+- **3: USMT_WOULD_HAVE_FAILED**
+ - **Error message**: At least one error was skipped as a result of /c.
+ - **Troubleshooting, mitigation, workarounds**: Review ScanState, LoadState, or UsmtUtils log for details about command-line errors.
+
+- **11: USMT_INVALID_PARAMETERS**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | /all conflicts with /ui, /ue or /uel | Review ScanState log or LoadState log for details about command-line errors. |
+ | /auto expects an optional parameter for the script folder | Review ScanState log or LoadState log for details about command-line errors. |
+ | /encrypt can't be used with /nocompress | Review ScanState log or LoadState log for details about command-line errors. |
+ | /encrypt requires /key or /keyfile | Review ScanState log or LoadState log for details about command-line errors. |
+ | /genconfig can't be used with most other options | Review ScanState log or LoadState log for details about command-line errors. |
+ | /genmigxml can't be used with most other options | Review ScanState log or LoadState log for details about command-line errors. |
+ | /hardlink requires /nocompress | Review ScanState log or LoadState log for details about command-line errors. |
+ | /key and /keyfile both specified | Review ScanState log or LoadState log for details about command-line errors. |
+ | /key or /keyfile used without enabling encryption | Review ScanState log or LoadState log for details about command-line errors. |
+ | /lae is only used with /lac | Review ScanState log or LoadState log for details about command-line errors. |
+ | /listfiles cannot be used with /p | Review ScanState log or LoadState log for details about command-line errors. |
+ | /offline requires a valid path to an XML file describing offline paths | Review ScanState log or LoadState log for details about command-line errors. |
+ | /offlinewindir requires a valid path to offline windows folder | Review ScanState log or LoadState log for details about command-line errors. |
+ | /offlinewinold requires a valid path to offline windows folder | Review ScanState log or LoadState log for details about command-line errors. |
+ | A command was already specified | Verify that the command-line syntax is correct and that there are no duplicate commands. |
+ | An option argument is missing | Review ScanState log or LoadState log for details about command-line errors. |
+ | An option is specified more than once and is ambiguous | Review ScanState log or LoadState log for details about command-line errors. |
+ | By default /auto selects all users and uses the highest log verbosity level. Switches like /all, /ui, /ue, /v are not allowed. | Review ScanState log or LoadState log for details about command-line errors. |
+ | Command line arguments are required. Specify /? for options. | Review ScanState log or LoadState log for details about command-line errors. |
+ | Command line option is not valid | Review ScanState log or LoadState log for details about command-line errors. |
+ | EFS parameter specified is not valid for /efs | Review ScanState log or LoadState log for details about command-line errors. |
+ | File argument is invalid for /genconfig | Review ScanState log or LoadState log for details about command-line errors. |
+ | File argument is invalid for /genmigxml | Review ScanState log or LoadState log for details about command-line errors. |
+ | Invalid space estimate path. Check the parameters and/or file system permissions | Review ScanState log or LoadState log for details about command-line errors. |
+ | List file path argument is invalid for /listfiles | Review ScanState log or LoadState log for details about command-line errors. |
+ | Retry argument must be an integer | Review ScanState log or LoadState log for details about command-line errors. |
+ | Settings store argument specified is invalid | Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set. |
+ | Specified encryption algorithm is not supported | Review ScanState log or LoadState log for details about command-line errors. |
+ | The /efs:hardlink requires /hardlink | Review ScanState log or LoadState log for details about command-line errors. |
+ | The /targetWindows7 option is only available for Windows XP, Windows Vista, and Windows 7 | Review ScanState log or LoadState log for details about command-line errors. |
+ | The store parameter is required but not specified | Review ScanState log or LoadState log for details about command-line errors. |
+ | The source-to-target domain mapping is invalid for /md | Review ScanState log or LoadState log for details about command-line errors. |
+ | The source-to-target user account mapping is invalid for /mu | Review ScanState log or LoadState log for details about command-line errors. |
+ | Undefined or incomplete command line option | Review ScanState log or LoadState log for details about command-line errors.
Category: Invalid Command Lines|
+ | Use /nocompress, or provide an XML file path with /p"pathtoafile" to get a compressed store size estimate | Review ScanState log or LoadState log for details about command-line errors. |
+ | User exclusion argument is invalid | Review ScanState log or LoadState log for details about command-line errors. |
+ | Verbosity level must be specified as a sum of the desired log options: Verbose (0x01), Record Objects (0x04), Echo to debug port (0x08) | Review ScanState log or LoadState log for details about command-line errors. |
+ | Volume shadow copy feature is not supported with a hardlink store | Review ScanState log or LoadState log for details about command-line errors. |
+ | Wait delay argument must be an integer | Review ScanState log or LoadState log for details about command-line errors. |
+
+- **12: USMT_ERROR_OPTION_PARAM_TOO_LARGE**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Command line arguments cannot exceed 256 characters | Review ScanState log or LoadState log for details about command-line errors.
Category: Invalid Command Lines |
+ | Specified settings store path exceeds the maximum allowed length of 256 characters | Review ScanState log or LoadState log for details about command-line errors. |
+
+- **13: USMT_INIT_LOGFILE_FAILED**
+ - **Error message**: Log path argument is invalid for /l
+ - **Troubleshooting, mitigation, workarounds**: When /l is specified in the ScanState command line, USMT validates the path. Verify that the drive and other information, for example file system characters, are correct.
+ - **Category**: Invalid Command Lines
+
+- **14: USMT_ERROR_USE_LAC**
+ - **Error message**: Unable to create a local account because /lac was not specified
+ - **Troubleshooting, mitigation, workarounds**: When creating local accounts, the command-line options /lac and /lae should be used.
+ - **Category**: Invalid Command Lines
+
+- **26: USMT_INIT_ERROR**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Multiple Windows installations found | Listfiles.txt could not be created. Verify that the location you specified for the creation of this file is valid.
Category: Setup and Initialization |
+ | Software malfunction or unknown exception | Check all loaded .xml files for errors, common error when using /I to load the Config.xml file. |
+ | Unable to find a valid Windows directory to proceed with requested offline operation; Check if offline input file is present and has valid entries | Verify that the offline input file is present and that it has valid entries. USMT could not find valid offline operating system. Verify your offline directory mapping. |
+
+- **27: USMT_INVALID_STORE_LOCATION**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | A store path can't be used because an existing store exists; specify /o to overwrite | Specify /o to overwrite an existing intermediate or migration store.
Category: Setup and Initialization |
+ | A store path is missing or has incomplete data | Make sure that the store path is accessible and that the proper permission levels are set. |
+ | An error occurred during store creation | Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store. |
+ | An inappropriate device such as a floppy disk was specified for the store | Make sure that the store path is accessible and that the proper permission levels are set. |
+ | Invalid store path; check the store parameter and/or file system permissions | Invalid store path; check the store parameter and/or file system permissions. |
+ | The file layout and/or file content is not recognized as a valid store | Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store. |
+ | The store path holds a store incompatible with the current USMT version | Make sure that the store path is accessible and that the proper permission levels are set. |
+ | The store save location is read-only or does not support a requested storage option | Make sure that the store path is accessible and that the proper permission levels are set. |
+
+- **28: USMT_UNABLE_GET_SCRIPTFILES**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Script file is invalid for /i | Check all specified migration .xml files for errors. This is a common error when using /i to load the Config.xml file.
Category: Setup and Initialization |
+ | Unable to find a script file specified by /i | Verify the location of your script files, and ensure that the command-line options are correct. |
+
+- **29: USMT_FAILED_MIGSTARTUP**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | A minimum of 250 MB of free space is required for temporary files | Verify that the system meets the minimum temporary disk space requirement of 250 MB. As a workaround, you can set the environment variable `USMT_WORKING_DIR=` to redirect the temporary files working directory.
Category: Setup and Initialization |
+ | Another process is preventing migration; only one migration tool can run at a time | Check the ScanState log file for migration .xml file errors. |
+ | Failed to start main processing, look in log for system errors or check the installation | Check the ScanState log file for migration .xml file errors. |
+ | Migration failed because of an XML error; look in the log for specific details | Check the ScanState log file for migration .xml file errors. |
+ | Unable to automatically map the drive letters to match the online drive letter layout; Use /offline to provide a mapping table | Check the ScanState log file for migration .xml file errors. |
+
+- **31: USMT_UNABLE_FINDMIGUNITS**
+
+ - **Error message**: An error occurred during the discover phase; the log should have more specific information
+ - **Troubleshooting, mitigation, workarounds**: Check the ScanState log file for migration .xml file errors.
+ - **Category**: Setup and Initialization
+
+- **32: USMT_FAILED_SETMIGRATIONTYPE**
+ - **Error message**: An error occurred processing the migration system
+ - **Troubleshooting, mitigation, workarounds**: Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line.
+ - **Category**: Setup and Initialization
+
+- **33: USMT_UNABLE_READKEY**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Error accessing the file specified by the /keyfile parameter | Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line.
Category: Setup and Initialization |
+ | The encryption key must have at least one character | Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line. |
+
+- **34: USMT_ERROR_INSUFFICIENT_RIGHTS**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Directory removal requires elevated privileges | Log on as Administrator, and run with elevated privileges.
Category: Setup and Initialization |
+ | No rights to create user profiles; log in as Administrator; run with elevated privileges | Log on as Administrator, and run with elevated privileges. |
+ | No rights to read or delete user profiles; log in as Administrator, run with elevated privileges | Log on as Administrator, and run with elevated privileges. |
+
+- **35: USMT_UNABLE_DELETE_STORE**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | A reboot is required to remove the store | Reboot to delete any files that could not be deleted when the command was executed.
Category: Setup and Initialization |
+ | A store path can't be used because it contains data that could not be overwritten | A migration store could not be deleted. If you are using a hardlink migration store you might have a locked file in it. You should manually delete the store, or use **USMTUtils /rd** command to delete the store. |
+ | There was an error removing the store | Review ScanState log or LoadState log for details about command-line errors. |
+
+- **36: USMT_ERROR_UNSUPPORTED_PLATFORM**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Compliance check failure; please check the logs for details | Investigate whether there is an active temporary profile on the system.
Category: Setup and Initialization |
+ | Use of /offline is not supported during apply | The **/offline** command was not used while running in the Windows Preinstallation Environment (WinPE). |
+ | Use /offline to run gather on this platform | The **/offline** command was not used while running in WinPE. |
+
+- **37: USMT_ERROR_NO_INVALID_KEY**
+ - **Error message**: The store holds encrypted data but the correct encryption key was not provided
+ - **Troubleshooting, mitigation, workarounds**: Verify that you have included the correct encryption /key or /keyfile.
+ - **Category**: Setup and Initialization
+
+- **38: USMT_ERROR_CORRUPTED_NOTENCRYPTED_STORE**
+ - **Error message**: An error occurred during store access
+ - **Troubleshooting, mitigation, workarounds**: Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set.
+ - **Category**: Setup and Initialization
+
+- **39: USMT_UNABLE_TO_READ_CONFIG_FILE**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Error reading Config.xml | Review ScanState log or LoadState log for details about command-line errors in the Config.xml file.
Category: Setup and Initialization |
+ | File argument is invalid for /config | Check the command line you used to load the Config.xml file. You can use online Help by typing /? on the command line. |
+
+- **40: USMT_ERROR_UNABLE_CREATE_PROGRESS_LOG**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Error writing to the progress log | The Progress log could not be created. Verify that the location is valid and that you have write access.
Category: Setup and Initialization |
+ | Progress log argument is invalid for /progress | The Progress log could not be created. Verify that the location is valid and that you have write access. |
+
+- **41: USMT_PREFLIGHT_FILE_CREATION_FAILED**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | Can't overwrite existing file | The Progress log could not be created. Verify that the location is valid and that you have write access.
Category: Setup and Initialization |
+ | Invalid space estimate path. Check the parameters and/or file system permissions | Review ScanState log or LoadState log for details about command-line errors. |
+
+- **42: USMT_ERROR_CORRUPTED_STORE**
+ - **Error message**: The store contains one or more corrupted files
+ - **Troubleshooting, mitigation, workarounds**: Review UsmtUtils log for details about the corrupted files. For information on how to extract the files that are not corrupted, see [Extract Files from a Compressed USMT Migration Store](usmt-extract-files-from-a-compressed-migration-store.md).
+
+- **61: USMT_MIGRATION_STOPPED_NONFATAL**
+ - **Error message**: Processing stopped due to an I/O error
+ - **Troubleshooting, mitigation, workarounds**: USMT exited but can continue with the /c command-line option, with the optional configurable <ErrorControl> section or by using the /vsc command-line option.
+ - **Category**: Non-fatal Errors
+
+- **71: USMT_INIT_OPERATING_ENVIRONMENT_FAILED**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | A Windows Win32 API error occurred | Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details.
Category: Fatal Errors |
+ | An error occurred when attempting to initialize the diagnostic mechanisms such as the log | Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details. |
+ | Failed to record diagnostic information | Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details. |
+ | Unable to start. Make sure you are running USMT with elevated privileges | Exit USMT and log in again with elevated privileges. |
+
+- **72: USMT_UNABLE_DOMIGRATION**
+
+ | Error message | Troubleshooting, mitigation, workarounds |
+ | --- | --- |
+ | An error occurred closing the store | Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details.
Category: Fatal Errors|
+ | An error occurred in the apply process | Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
+ | An error occurred in the gather process | Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
+ | Out of disk space while writing the store | Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
+ | Out of temporary disk space on the local system | Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
## Related topics
-
[User State Migration Tool (USMT) Troubleshooting](usmt-troubleshooting.md)
[Log Files](usmt-log-files.md)
-
-
-
diff --git a/windows/deployment/usmt/usmt-scanstate-syntax.md b/windows/deployment/usmt/usmt-scanstate-syntax.md
index eaaf29d214..37fb5cbc81 100644
--- a/windows/deployment/usmt/usmt-scanstate-syntax.md
+++ b/windows/deployment/usmt/usmt-scanstate-syntax.md
@@ -16,12 +16,10 @@ ms.topic: article
# ScanState Syntax
-
The ScanState command is used with the User State Migration Tool (USMT) 10.0 to scan the source computer, collect the files and settings, and create a store.
## In This Topic
-
[Before You Begin](#bkmk-beforeyoubegin)
[Syntax](#bkmk-syntax)
@@ -40,7 +38,6 @@ The ScanState command is used with the User State Migration Tool (USMT) 10.0 to
## Before You Begin
-
Before you run the **ScanState** command, note the following:
- To ensure that all operating system settings migrate, in most cases you must run the **ScanState** commands in administrator mode from an account with administrative credentials.
@@ -59,7 +56,6 @@ Before you run the **ScanState** command, note the following:
## Syntax
-
This section explains the syntax and usage of the **ScanState** command-line options. The options can be specified in any order. If the option contains a parameter, you can use either a colon or a space separator.
The **ScanState** command's syntax is:
@@ -76,80 +72,20 @@ To create an encrypted store using the Config.xml file and the default migration
## Storage Options
-
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
StorePath
-
Indicates a folder where files and settings will be saved. Note that StorePath cannot be C:\. You must specify the StorePath option in the ScanState command, except when using the /genconfig option. You cannot specify more than one StorePath location.
-
-
-
/apps
-
Scans the image for apps and includes them and their associated registry settings.
-
-
-
/ppkg [<FileName>]
-
Exports to a specific file location.
-
-
-
/o
-
Required to overwrite any existing data in the migration store or Config.xml file. If not specified, the ScanState command will fail if the migration store already contains data. You cannot use this option more than once on a command line.
-
-
-
/vsc
-
This option enables the volume shadow-copy service to migrate files that are locked or in use. This command-line option eliminates most file-locking errors that are typically encountered by the <ErrorControl> section.
-
This option can be used only with the ScanState executable file and cannot be combined with the /hardlink option.
-
-
-
/hardlink
-
Enables the creation of a hard-link migration store at the specified location. The /nocompress option must be specified with the /hardlink option.
-
-
-
/encrypt [{/key:<KeyString> | /keyfile:<file>]}
-
Encrypts the store with the specified key. Encryption is disabled by default. With this option, you will need to specify the encryption key-in one of the following ways:
-
-
/key:KeyString specifies the encryption key. If there is a space in KeyString, you will need to surround KeyString with quotation marks.
-
/keyfile:FilePathAndName specifies a text (.txt) file that contains the encryption key.
-
-
We recommend that KeyString be at least eight characters long, but it cannot exceed 256 characters. The /key and /keyfile options cannot be used on the same command line. The /encrypt and /nocompress options cannot be used on the same command line.
-
-Important
You should use caution with this option, because anyone who has access to the ScanState command-line script will also have access to the encryption key.
-
-
-
-
-
The following example shows the ScanState command and the /key option:
The /encrypt option accepts a command-line parameter to define the encryption strength to be used for encryption of the migration store. For more information about supported encryption algorithms, see Migration Store Encryption.
-
-
-
/nocompress
-
Disables compression of data and saves the files to a hidden folder named "File" at StorePath\USMT. Compression is enabled by default. Combining the /nocompress option with the /hardlink option generates a hard-link migration store. You can use the uncompressed store to view what USMT stored, troubleshoot a problem, or run an antivirus utility against the files. You should use this option only in testing environments, because we recommend that you use a compressed store during your actual migration, unless you are combining the /nocompress option with the /hardlink option.
-
The /nocompress and /encrypt options cannot be used together in one statement on the command line. However, if you do choose to migrate an uncompressed store, the LoadState command will migrate each file directly from the store to the correct location on the destination computer without a temporary location.
-
-
+| Command-Line Option | Description |
+|-----|-----|
+| *StorePath* | Indicates a folder where files and settings will be saved. Note that *StorePath* cannot be **C:\**. You must specify the *StorePath* option in the **ScanState** command, except when using the **/genconfig** option. You cannot specify more than one *StorePath* location. |
+| **/apps** | Scans the image for apps and includes them and their associated registry settings. |
+| **/ppkg** [*<FileName>*] | Exports to a specific file location. |
+| **/o** | Required to overwrite any existing data in the migration store or Config.xml file. If not specified, the **ScanState** command will fail if the migration store already contains data. You cannot use this option more than once on a command line. |
+| **/vsc** | This option enables the volume shadow-copy service to migrate files that are locked or in use. This command-line option eliminates most file-locking errors that are typically encountered by the **<ErrorControl>** section.
This option can be used only with the ScanState executable file and cannot be combined with the **/hardlink** option. |
+| **/hardlink** | Enables the creation of a hard-link migration store at the specified location. The **/nocompress** option must be specified with the **/hardlink** option. |
+| **/encrypt** [{**/key:** *<KeyString>* | **/keyfile**:*<file>*]} | Encrypts the store with the specified key. Encryption is disabled by default. With this option, you will need to specify the encryption key-in one of the following ways:
**/key:** *KeyString* specifies the encryption key. If there is a space in *KeyString*, you will need to surround *KeyString* with quotation marks.
**/keyfile:** *FilePathAndName* specifies a text (.txt) file that contains the encryption key.
We recommend that *KeyString* be at least eight characters long, but it cannot exceed 256 characters. The **/key** and **/keyfile** options cannot be used on the same command line. The **/encrypt** and **/nocompress** options cannot be used on the same command line.
**Important** You should use caution with this option, because anyone who has access to the **ScanState** command-line script will also have access to the encryption key.
The following example shows the ScanState command and the **/key** option: `scanstate /i:migdocs.xml /i:migapp.xml \server\share\migration\mystore /encrypt /key:mykey` |
+| **/encrypt**:*<EncryptionStrength>* | The **/encrypt** option accepts a command-line parameter to define the encryption strength to be used for encryption of the migration store. For more information about supported encryption algorithms, see [Migration Store Encryption](usmt-migration-store-encryption.md). |
+| **/nocompress** | Disables compression of data and saves the files to a hidden folder named "File" at *StorePath*\USMT. Compression is enabled by default. Combining the **/nocompress** option with the **/hardlink** option generates a hard-link migration store. You can use the uncompressed store to view what USMT stored, troubleshoot a problem, or run an antivirus utility against the files. You should use this option only in testing environments, because we recommend that you use a compressed store during your actual migration, unless you are combining the **/nocompress** option with the **/hardlink** option.
The **/nocompress** and **/encrypt** options cannot be used together in one statement on the command line. However, if you do choose to migrate an uncompressed store, the **LoadState** command will migrate each file directly from the store to the correct location on the destination computer without a temporary location.
For example: `scanstate /i:migdocs.xml /i:migapp.xml \server\share\migration\mystore /nocompress` |
## Run the ScanState Command on an Offline Windows System
-
You can run the **ScanState** command in Windows Preinstallation Environment (WinPE). In addition, USMT supports migrations from previous installations of Windows contained in Windows.old directories. The offline directory can be a Windows directory when you run the **ScanState** command in WinPE or a Windows.old directory when you run the **ScanState** command in Windows.
There are several benefits to running the **ScanState** command on an offline Windows image, including:
@@ -172,445 +108,87 @@ There are several benefits to running the **ScanState** command on an offline Wi
## Offline Migration Options
-
-
-
-
-
-
-
-
-
Command-Line Option
-
Definition
-
-
-
-
-
/offline:"path to an offline.xml file"
-
This option is used to define a path to an offline .xml file that might specify other offline migration options, for example, an offline Windows directory or any domain or folder redirection required in your migration.
-
-
-
/offlinewindir:"path to a Windows directory"
-
This option specifies the offline Windows directory that the ScanState command gathers user state from. The offline directory can be Windows.old when you run the ScanState command in Windows or a Windows directory when you run the ScanState command in WinPE.
-
-
-
/offlinewinold:"Windows.old directory"
-
This command-line option enables the offline migration mode and starts the migration from the location specified. It is only intended to be used in Windows.old migration scenarios, where the migration is occurring from a Windows.old directory.
-
-
-
-
-
+|Command-Line Option|Definition|
+|--- |--- |
+|**/offline:** *"path to an offline.xml file"*|This option is used to define a path to an offline .xml file that might specify other offline migration options, for example, an offline Windows directory or any domain or folder redirection required in your migration.|
+|**/offlinewindir:** *"path to a Windows directory"*|This option specifies the offline Windows directory that the **ScanState** command gathers user state from. The offline directory can be Windows.old when you run the **ScanState** command in Windows or a Windows directory when you run the **ScanState** command in WinPE.|
+|**/offlinewinold:** *"Windows.old directory"*|This command-line option enables the offline migration mode and starts the migration from the location specified. It is only intended to be used in Windows.old migration scenarios, where the migration is occurring from a Windows.old directory.|
## Migration Rule Options
-
USMT provides the following options to specify what files you want to migrate.
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/i:[Path]FileName
-
(include)
-
Specifies an .xml file that contains rules that define what user, application, or system state to migrate. You can specify this option multiple times to include all of your .xml files (MigApp.xml, MigDocs.xml, and any custom .xml files that you create). Path can be either a relative or full path. If you do not specify the Path variable, then FileName must be located in the current directory. For more information about which files to specify, see the "XML Files" section of the Frequently Asked Questions topic.
-
-
-
/genconfig:[Path]FileName
-
(Generate Config.xml)
-
Generates the optional Config.xml file, but does not create a migration store. To ensure that this file contains every component, application and setting that can be migrated, you should create this file on a source computer that contains all the components, applications, and settings that will be present on the destination computers. In addition, you should specify the other migration .xml files, using the /i option, when you specify this option.
-
After you create this file, you will need to make use of it with the ScanState command using the /config option.
-
The only options that you can specify with this option are the /i, /v, and /l options. You cannot specify StorePath, because the /genconfig option does not create a store. Path can be either a relative or full path. If you do not specify the Path variable, then FileName will be created in the current directory.
-
Examples:
-
-
The following example creates a Config.xml file in the current directory:
Specifies the Config.xml file that the ScanState command should use to create the store. You cannot use this option more than once on the command line. Path can be either a relative or full path. If you do not specify the Path variable, then FileName must be located in the current directory.
-
The following example creates a store using the Config.xml file, MigDocs.xml, and MigApp.xml files:
This option enables you to specify the location of the default .xml files and then begin the migration. If no path is specified, USMT will reference the directory where the USMT binaries are located. The /auto option has the same effect as using the following options: /i: MigDocs.xml/i:MigApp.xml /v:5.
-
-
-
/genmigxml:path to a file
-
This option specifies that the ScanState command should use the document finder to create and export an .xml file that defines how to migrate all of the files on the computer on which the ScanState command is running.
-
-
-
/targetwindows8
-
Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 8 or Windows 8.1 instead of Windows 10. You should use this command-line option in the following scenarios:
-
-
To create a Config.xml file by using the /genconfig option. Using the /targetwindows8 option optimizes the Config.xml file so that it only contains components that relate to Windows 8 or Windows 8.1.
-
To create a migration store. Using the /targetwindows8 option ensures that the ScanState tool gathers the correct set of operating system settings. Without the /targetwindows8 command-line option, some settings can be lost during the migration.
-
-
-
-
/targetwindows7
-
Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 7 instead of Windows 10. You should use this command-line option in the following scenarios:
-
-
To create a Config.xml file by using the /genconfig option. Using the /targetwindows7 option optimizes the Config.xml file so that it only contains components that relate to Windows 7.
-
To create a migration store. Using the /targetwindows7 option ensures that the ScanState tool gathers the correct set of operating system settings. Without the /targetwindows7 command-line option, some settings can be lost during the migration.
-
-
-
-
/localonly
-
Migrates only files that are stored on the local computer, regardless of the rules in the .xml files that you specify on the command line. You should use this option when you want to exclude the data from removable drives on the source computer, such as USB flash drives (UFDs), some external hard drives, and so on, and when there are network drives mapped on the source computer. If the /localonly option is not specified, then the ScanState command will copy files from these removable or network drives into the store.
-
Anything that is not considered a fixed drive by the OS will be excluded by /localonly. In some cases large external hard drives are considered fixed drives. These drives can be explicitly excluded from migration by using a custom.xml file. For more information about how to exclude all files on a specific drive, see Exclude Files and Settings.
-
The /localonly command-line option includes or excludes data in the migration as identified in the following table:
Specifies an .xml file that contains rules that define what user, application, or system state to migrate. You can specify this option multiple times to include all of your .xml files (MigApp.xml, MigDocs.xml, and any custom .xml files that you create). *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* must be located in the current directory. For more information about which files to specify, see the "XML Files" section of the [Frequently Asked Questions](usmt-faq.yml) topic. |
+| **/genconfig:**[*Path*]*FileName* | (Generate **Config.xml**)
Generates the optional Config.xml file, but does not create a migration store. To ensure that this file contains every component, application and setting that can be migrated, you should create this file on a source computer that contains all the components, applications, and settings that will be present on the destination computers. In addition, you should specify the other migration .xml files, using the **/i** option, when you specify this option.
After you create this file, you will need to make use of it with the **ScanState** command using the **/config** option.
The only options that you can specify with this option are the **/i**, **/v**, and **/l** options. You cannot specify *StorePath*, because the **/genconfig** option does not create a store. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* will be created in the current directory.
Examples:
The following example creates a Config.xml file in the current directory: `scanstate /i:migapp.xml /i:migdocs.xml /genconfig:config.xml /v:13`
|
+| **/config:**[*Path*]*FileName* | Specifies the Config.xml file that the **ScanState** command should use to create the store. You cannot use this option more than once on the command line. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* must be located in the current directory.
The following example creates a store using the Config.xml file, MigDocs.xml, and MigApp.xml files: `scanstate \server\share\migration\mystore /config:config.xml /i:migdocs.xml /i:migapp.xml /v:13 /l:scan.log`
The following example migrates the files and settings to the destination computer using the **Config.xml**, **MigDocs.xml**, and **MigApp.xml** files: `loadstate \server\share\migration\mystore /config:config.xml /i:migdocs.xml /i:migapp.xml /v:13 /l:load.log` |
+| **/auto:** *path to script files* | This option enables you to specify the location of the default .xml files and then begin the migration. If no path is specified, USMT will reference the directory where the USMT binaries are located. The **/auto** option has the same effect as using the following options: **/i: MigDocs.xml** **/i:MigApp.xml /v:5**. |
+| **/genmigxml:** *path to a file* | This option specifies that the **ScanState** command should use the document finder to create and export an .xml file that defines how to migrate all of the files on the computer on which the **ScanState** command is running. |
+| **/targetwindows8** | Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 8 or Windows 8.1 instead of Windows 10. You should use this command-line option in the following scenarios:
**To create a Config.xml file by using the /genconfig option.** Using the **/targetwindows8** option optimizes the Config.xml file so that it only contains components that relate to Windows 8 or Windows 8.1.
**To create a migration store.** Using the **/targetwindows8** option ensures that the ScanState tool gathers the correct set of operating system settings. Without the **/targetwindows8** command-line option, some settings can be lost during the migration.
|
+| **/targetwindows7** | Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 7 instead of Windows 10. You should use this command-line option in the following scenarios:
**To create a Config.xml file by using the /genconfig option.** Using the **/targetwindows7** option optimizes the Config.xml file so that it only contains components that relate to Windows 7.
**To create a migration store.** Using the **/targetwindows7** option ensures that the ScanState tool gathers the correct set of operating system settings. Without the **/targetwindows7** command-line option, some settings can be lost during the migration.
|
+| **/localonly** | Migrates only files that are stored on the local computer, regardless of the rules in the .xml files that you specify on the command line. You should use this option when you want to exclude the data from removable drives on the source computer, such as USB flash drives (UFDs), some external hard drives, and so on, and when there are network drives mapped on the source computer. If the **/localonly** option is not specified, then the **ScanState** command will copy files from these removable or network drives into the store.
Anything that is not considered a fixed drive by the OS will be excluded by **/localonly**. In some cases large external hard drives are considered fixed drives. These drives can be explicitly excluded from migration by using a custom.xml file. For more information about how to exclude all files on a specific drive, see [Exclude Files and Settings](usmt-exclude-files-and-settings.md).
The **/localonly** command-line option includes or excludes data in the migration as identified in the following:
**Removable drives such as a USB flash drive** - Excluded
**Network drives** - Excluded
**Fixed drives** - Included
|
## Monitoring Options
-
USMT provides several options that you can use to analyze problems that occur during migration.
-> [!NOTE]
+> [!NOTE]
> The ScanState log is created by default, but you can specify the name and location of the log with the **/l** option.
-
-
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/listfiles:<FileName>
-
You can use the /listfiles command-line option with the ScanState command to generate a text file that lists all of the files included in the migration.
-
-
-
/l:[Path]FileName
-
Specifies the location and name of the ScanState log.
-
You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then the log will be created in the current directory. You can use the /v option to adjust the amount of output.
-
If you run the ScanState or LoadState commands from a shared network resource, you must specify this option or USMT will fail with the following error: "USMT was unable to create the log file(s)". To fix this issue, use the /l: scan.log command.
-
-
-
/v:<VerbosityLevel>
-
(Verbosity)
-
Enables verbose output in the ScanState log file. The default value is 0.
-
You can set the VerbosityLevel to one of the following levels:
Creates the optional progress log. You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then FileName will be created in the current directory.
When this option is specified, the ScanState command will continue to run, even if non-fatal errors occur. Any files or settings that cause an error are logged in the progress log. For example, if there is a large file that will not fit in the store, the ScanState command will log an error and continue with the migration. In addition, if a file is open or in use by an application, USMT may not be able to migrate the file and will log an error. Without the /c option, the ScanState command will exit on the first error.
-
You can use the new <ErrorControl> section in the Config.xml file to specify which file or registry read/write errors can be safely ignored and which might cause the migration to fail. This enables the /c command-line option to safely skip all input/output (I/O) errors in your environment. In addition, the /genconfig option now generates a sample <ErrorControl> section that is enabled by specifying error messages and desired behaviors in the Config.xml file.
-
-
-
/r:<TimesToRetry>
-
(Retry)
-
Specifies the number of times to retry when an error occurs while saving the user state to a server. The default is three times. This option is useful in environments where network connectivity is not reliable.
-
While storing the user state, the /r option will not be able to recover data that is lost due to a network-hardware failure, such as a faulty or disconnected network cable, or when a virtual private network (VPN) connection fails. The retry option is intended for large, busy networks where connectivity is satisfactory, but communication latency is a problem.
-
-
-
/w:<SecondsBeforeRetry>
-
(Wait)
-
Specifies the time to wait, in seconds, before retrying a network file operation. The default is 1 second.
-
-
-
/p:<pathToFile>
-
When the ScanState command runs, it will create an .xml file in the path specified. This .xml file includes improved space estimations for the migration store. The following example shows how to create this .xml file:
To preserve the functionality of existing applications or scripts that require the previous behavior of USMT, you can use the /p option, without specifying "pathtoafile", in USMT. If you specify only the /p option, the storage space estimations are created in the same manner as with USMT3.x releases.
-
-
-
/? or /help
-
Displays Help at the command line.
-
-
-
-
-
+| Command-Line Option | Description |
+|-----|-----|
+| **/listfiles**:<FileName> | You can use the **/listfiles** command-line option with the **ScanState** command to generate a text file that lists all of the files included in the migration. |
+| **/l:**[*Path*]*FileName* | Specifies the location and name of the ScanState log.
You cannot store any of the log files in *StorePath*. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then the log will be created in the current directory. You can use the **/v** option to adjust the amount of output.
If you run the **ScanState** or **LoadState** commands from a shared network resource, you must specify this option or USMT will fail with the following error: "USMT was unable to create the log file(s)". To fix this issue, use the /**l: scan.log** command. |
+| **/v:***<VerbosityLevel>* | **(Verbosity)**
Enables verbose output in the ScanState log file. The default value is 0.
You can set the *VerbosityLevel* to one of the following levels:
**0** - Only the default errors and warnings are enabled.
**1** - Enables verbose output.
**4** - Enables error and status output.
**5** - Enables verbose and status output.
**8** - Enables error output to a debugger.
**9** - Enables verbose output to a debugger.
**12** - Enables error and status output to a debugger.
**13** - Enables verbose, status, and debugger output.
For example: `scanstate \server\share\migration\mystore /v:13 /i:migdocs.xml /i:migapp.xml`|
+| /**progress**:[*Path*]*FileName* | Creates the optional progress log. You cannot store any of the log files in *StorePath*. *Path* can be either a relative or full path. If you do not specify the *Path* variable, then *FileName* will be created in the current directory.
For example: `scanstate /i:migapp.xml /i:migdocs.xml \server\share\migration\mystore /progress:prog.log /l:scanlog.log` |
+| **/c** | When this option is specified, the **ScanState** command will continue to run, even if non-fatal errors occur. Any files or settings that cause an error are logged in the progress log. For example, if there is a large file that will not fit in the store, the **ScanState** command will log an error and continue with the migration. In addition, if a file is open or in use by an application, USMT may not be able to migrate the file and will log an error. Without the **/c** option, the **ScanState** command will exit on the first error.
You can use the new <**ErrorControl**> section in the Config.xml file to specify which file or registry read/write errors can be safely ignored and which might cause the migration to fail. This enables the /**c** command-line option to safely skip all input/output (I/O) errors in your environment. In addition, the /**genconfig** option now generates a sample <**ErrorControl**> section that is enabled by specifying error messages and desired behaviors in the Config.xml file. |
+| **/r:***<TimesToRetry>* | **(Retry)**
Specifies the number of times to retry when an error occurs while saving the user state to a server. The default is three times. This option is useful in environments where network connectivity is not reliable.
While storing the user state, the **/r** option will not be able to recover data that is lost due to a network-hardware failure, such as a faulty or disconnected network cable, or when a virtual private network (VPN) connection fails. The retry option is intended for large, busy networks where connectivity is satisfactory, but communication latency is a problem. |
+| **/w:***<SecondsBeforeRetry>* | **(Wait)**
Specifies the time to wait, in seconds, before retrying a network file operation. The default is 1 second. |
+| **/p:***<pathToFile>* | When the **ScanState** command runs, it will create an .xml file in the path specified. This .xml file includes improved space estimations for the migration store. The following example shows how to create this .xml file: `Scanstate.exe C:\MigrationLocation [additional parameters]` `/p:"C:\MigrationStoreSize.xml"`
For more information, see [Estimate Migration Store Size](usmt-estimate-migration-store-size.md).
To preserve the functionality of existing applications or scripts that require the previous behavior of USMT, you can use the **/p** option, without specifying *"pathtoafile"*, in USMT. If you specify only the **/p** option, the storage space estimations are created in the same manner as with USMT3.x releases. |
+| /**?** or /**help** | Displays Help at the command line. |
## User Options
-
By default, all users are migrated. The only way to specify which users to include and exclude is by using the following options. You cannot exclude users in the migration .xml files or using the Config.xml file. For more information, see [Identify Users](usmt-identify-users.md) and [Migrate User Accounts](usmt-migrate-user-accounts.md).
-
-
-
-
-
-
-
-
Command-Line Option
-
Description
-
-
-
-
-
/all
-
Migrates all of the users on the computer.
-
USMT migrates all user accounts on the computer, unless you specifically exclude an account with either the /ue or /uel options. For this reason, you do not need to specify this option on the command line. However, if you choose to specify the /all option, you cannot also use the /ui, /ue or /uel options.
-
-
-
/ui:<DomainName>\<UserName>
-
or
-
/ui:<ComputerName>\<LocalUserName>
-
(User include)
-
Migrates the specified users. By default, all users are included in the migration. Therefore, this option is helpful only when used with the /ue or /uel options. You can specify multiple /ui options, but you cannot use the /ui option with the /all option. DomainName and UserName can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotation marks.
-
-Note
If a user is specified for inclusion with the /ui option, and also is specified to be excluded with either the /ue or /uel options, the user will be included in the migration.
-
-
-
-
-
For example:
-
-
To include only User2 from the Fabrikam domain, type:
-
/ue:*\* /ui:fabrikam\user2
-
To migrate all users from the Fabrikam domain, and only the user accounts from other domains that have been active or otherwise modified in the last 30 days, type:
-
/uel:30 /ui:fabrikam\*
-
In this example, a user account from the Contoso domain that was last modified two months ago will not be migrated.
-
-
For more examples, see the descriptions of the /ue and /ui options in this table.
-
-
-
/uel:<NumberOfDays>
-
or
-
/uel:<YYYY/MM/DD>
-
or
-
/uel:0
-
(User exclude based on last logon)
-
Migrates the users that logged on to the source computer within the specified time period, based on the Last Modified date of the Ntuser.dat file on the source computer. The /uel option acts as an include rule. For example, the /uel:30 option migrates users who logged on, or whose account was modified, within the last 30 days from the date when the ScanState command is run.
-
You can specify a number of days or you can specify a date. You cannot use this option with the /all option. USMT retrieves the last logon information from the local computer, so the computer does not need to be connected to the network when you run this option. In addition, if a domain user has logged on to another computer, that logon instance is not considered by USMT.
-
-Note
The /uel option is not valid in offline migrations.
-
-
-
-
-
-
/uel:0 migrates any users who are currently logged on.
-
/uel:90 migrates users who have logged on, or whose accounts have been otherwise modified, within the last 90 days.
-
/uel:1 migrates users whose account has been modified within the last 24 hours.
-
/uel:2002/1/15 migrates users who have logged on or been modified January 15, 2002 or afterwards.
Excludes the specified users from the migration. You can specify multiple /ue options. You cannot use this option with the /all option. <DomainName> and <UserName> can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you need to surround it with quotation marks.
-
-
+| Command-Line Option | Description |
+|-----|-----|
+| /**all** | Migrates all of the users on the computer.
USMT migrates all user accounts on the computer, unless you specifically exclude an account with either the /**ue** or /**uel** options. For this reason, you do not need to specify this option on the command line. However, if you choose to specify the /**all** option, you cannot also use the /**ui**, /**ue** or /**uel** options. |
+| /**ui**:*<DomainName>*\*<UserName>* or /**ui**:*<ComputerName>*\*<LocalUserName>* | **(User include)**
Migrates the specified users. By default, all users are included in the migration. Therefore, this option is helpful only when used with the /**ue** or /**uel** options. You can specify multiple /**ui** options, but you cannot use the /**ui** option with the /**all** option. *DomainName* and *UserName* can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotation marks.
**Note** If a user is specified for inclusion with the /**ui** option, and also is specified to be excluded with either the /**ue** or /**uel** options, the user will be included in the migration.
For example:
To include only User2 from the Fabrikam domain, type: `/ue:*\* /ui:fabrikam\user2`
To migrate all users from the Fabrikam domain, and only the user accounts from other domains that have been active or otherwise modified in the last 30 days, type: `/uel:30 /ui:fabrikam\*` In this example, a user account from the Contoso domain that was last modified two months ago will not be migrated.
For more examples, see the descriptions of the /**ue** and /**ui** options in this table. |
+| /**uel**:*<NumberOfDays>* or /**uel**:*<YYYY/MM/DD>* or **/uel:0** | **(User exclude based on last logon)**
Migrates the users that logged on to the source computer within the specified time period, based on the **Last Modified** date of the Ntuser.dat file on the source computer. The /**uel** option acts as an include rule. For example, the **/uel:30** option migrates users who logged on, or whose account was modified, within the last 30 days from the date when the ScanState command is run.
You can specify a number of days or you can specify a date. You cannot use this option with the /**all** option. USMT retrieves the last logon information from the local computer, so the computer does not need to be connected to the network when you run this option. In addition, if a domain user has logged on to another computer, that logon instance is not considered by USMT.
**Note** The /**uel** option is not valid in offline migrations.
**/uel:0** migrates any users who are currently logged on.
**/uel:90** migrates users who have logged on, or whose accounts have been otherwise modified, within the last 90 days.
**/uel:1** migrates users whose account has been modified within the last 24 hours.
**/uel:2002/1/15** migrates users who have logged on or been modified January 15, 2002 or afterwards.
Excludes the specified users from the migration. You can specify multiple /**ue** options. You cannot use this option with the /**all** option. *<DomainName>* and *<UserName>* can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you need to surround it with quotation marks.
For example: `scanstate /i:migdocs.xml /i:migapp.xml \\server\share\migration\mystore /ue:contoso\user1` |
## How to Use /ui and /ue
-
The following examples apply to both the /**ui** and /**ue** options. You can replace the /**ue** option with the /**ui** option to include, rather than exclude, the specified users.
-
-
-
-
-
-
-
-
Behavior
-
Command
-
-
-
-
-
Exclude the user named User One in the Fabrikam domain.
-
/ue:"fabrikam\user one"
-
-
-
Exclude the user named User1 in the Fabrikam domain.
-
/ue:fabrikam\user1
-
-
-
Exclude the local user named User1.
-
/ue:%computername%\user1
-
-
-
Exclude all domain users.
-
/ue:Domain\*
-
-
-
Exclude all local users.
-
/ue:%computername%\*
-
-
-
Exclude users in all domains named User1, User2, and so on.
-
/ue:*\user*
-
-
-
-
-
+|Behavior|Command|
+|--- |--- |
+|Exclude the user named User One in the Fabrikam domain.|`/ue:"fabrikam\user one"`|
+|Exclude the user named User1 in the Fabrikam domain.|`/ue:fabrikam\user1`|
+|Exclude the local user named User1.|`/ue:%computername%\user1`|
+|Exclude all domain users.|`/ue:Domain\*`|
+|Exclude all local users.|`/ue:%computername%\*`|
+|Exclude users in all domains named User1, User2, and so on.|`/ue:*\user*`|
## Using the Options Together
-
You can use the /**uel**, /**ue** and /**ui** options together to migrate only the users that you want migrated.
The /**ui** option has precedence over the /**ue** and /**uel** options. If a user is specified to be included using the /**ui** option, and also specified to be excluded using either the /**ue** or /**uel** options, the user will be included in the migration. For example, if you specify `/ui:contoso\* /ue:contoso\user1`, then User1 will be migrated, because the /**ui** option takes precedence over the /**ue** option.
The /**uel** option takes precedence over the /**ue** option. If a user has logged on within the specified time period set by the /**uel** option, that user’s profile will be migrated even if they are excluded by using the /**ue** option. For example, if you specify `/ue:fixed\user1 /uel:14`, the User1 will be migrated if they have logged on to the computer within the last 14 days.
-
-
-
-
-
-
-
-
Behavior
-
Command
-
-
-
-
-
Include only User2 from the Fabrikam domain and exclude all other users.
-
/ue:*\* /ui:fabrikam\user2
-
-
-
Include only the local user named User1 and exclude all other users.
-
/ue:*\* /ui:user1
-
-
-
Include only the domain users from Contoso, except Contoso\User1.
-
This behavior cannot be completed using a single command. Instead, to migrate this set of users, you will need to specify the following:
-
-
On the ScanState command line, type: /ue:*\* /ui:contoso\*
-
On the LoadState command line, type: /ue:contoso\user1
-
-
-
-
Include only local (non-domain) users.
-
/ue:*\* /ui:%computername%\*
-
-
-
-
-
+|Behavior|Command|
+|--- |--- |
+|Include only User2 from the Fabrikam domain and exclude all other users.|`/ue:*\* /ui:fabrikam\user2`|
+|Include only the local user named User1 and exclude all other users.|`/ue:*\* /ui:user1`|
+|Include only the domain users from Contoso, except Contoso\User1.|This behavior cannot be completed using a single command. Instead, to migrate this set of users, you will need to specify the following:
On the **ScanState** command line, type: `/ue:*\* /ui:contoso\*`
On the **LoadState** command line, type: `/ue:contoso\user1`
|
+|Include only local (non-domain) users.|`/ue:*\* /ui:%computername%\*`|
## Encrypted File Options
-
You can use the following options to migrate encrypted files. In all cases, by default, USMT fails if an encrypted file is found unless you specify an /**efs** option. To migrate encrypted files, you must change the default behavior.
For more information, see [Migrate EFS Files and Certificates](usmt-migrate-efs-files-and-certificates.md).
@@ -618,245 +196,49 @@ For more information, see [Migrate EFS Files and Certificates](usmt-migrate-efs-
> [!NOTE]
> EFS certificates will be migrated automatically when migrating to Windows 7, Windows 8 or Windows 10. Therefore, you should specify the /**efs:copyraw** option with the **ScanState** command to migrate the encrypted files
-
> [!CAUTION]
> Take caution when migrating encrypted files. If you migrate an encrypted file without also migrating the certificate, end users will not be able to access the file after the migration.
-
-
-
-
-
-
-
-
-
-
Command-Line Option
-
Explanation
-
-
-
-
-
/efs:hardlink
-
Creates a hard link to the EFS file instead of copying it. Use only with the /hardlink and the /nocompress options.
-
-
-
/efs:abort
-
Causes the ScanState command to fail with an error code, if an Encrypting File System (EFS) file is found on the source computer. Enabled by default.
-
-
-
/efs:skip
-
Causes the ScanState command to ignore EFS files.
-
-
-
/efs:decryptcopy
-
Causes the ScanState command to decrypt the file, if possible, before saving it to the migration store, and to fail if the file cannot be decrypted. If the ScanState command succeeds, the file will be unencrypted in the migration store, and once you run the LoadState command, the file will be copied to the destination computer.
-
-
-
/efs:copyraw
-
Causes the ScanState command to copy the files in the encrypted format. The files will be inaccessible on the destination computer until the EFS certificates are migrated. EFS certificates will be automatically migrated; however, by default USMT fails if an encrypted file is found, unless you specify an /efs option. Therefore you should specify the /efs:copyraw option with the ScanState command to migrate the encrypted file. Then, when you run the LoadState command, the encrypted file and the EFS certificate will be automatically migrated.
All files must be encrypted if the parent folder is encrypted. If the encryption attribute on a file inside an encrypted folder has been removed, the file will be encrypted during the migration using the credentials of the account used to run the LoadState tool. For more information, see Migrate EFS Files and Certificates.
-
-
-
-
-
-
-
-
-
+| Command-Line Option | Explanation |
+|----|----|
+| **/efs:hardlink** | Creates a hard link to the EFS file instead of copying it. Use only with the **/hardlink** and the **/nocompress** options. |
+| **/efs:abort** | Causes the **ScanState** command to fail with an error code, if an Encrypting File System (EFS) file is found on the source computer. Enabled by default. |
+| **/efs:skip** | Causes the **ScanState** command to ignore EFS files. |
+| /**efs:decryptcopy** | Causes the **ScanState** command to decrypt the file, if possible, before saving it to the migration store, and to fail if the file cannot be decrypted. If the **ScanState** command succeeds, the file will be unencrypted in the migration store, and once you run the **LoadState** command, the file will be copied to the destination computer. |
+| **/efs:copyraw** | Causes the **ScanState** command to copy the files in the encrypted format. The files will be inaccessible on the destination computer until the EFS certificates are migrated. EFS certificates will be automatically migrated; however, by default USMT fails if an encrypted file is found, unless you specify an **/efs** option. Therefore you should specify the **/efs:copyraw** option with the **ScanState** command to migrate the encrypted file. Then, when you run the **LoadState** command, the encrypted file and the EFS certificate will be automatically migrated.
For example: `ScanState /i:migdocs.xml /i:migapp.xml \server\share\migration\mystore /efs:copyraw`
**Important** All files must be encrypted if the parent folder is encrypted. If the encryption attribute on a file inside an encrypted folder has been removed, the file will be encrypted during the migration using the credentials of the account used to run the LoadState tool. For more information, see [Migrate EFS Files and Certificates](usmt-migrate-efs-files-and-certificates.md).
|
## Incompatible Command-Line Options
-
The following table indicates which command-line options are not compatible with the **ScanState** command. If the table entry for a particular combination is blank, the options are compatible and you can use them together. The X symbol means that the options are not compatible. For example, you cannot use the **/nocompress** option with the **/encrypt** option.
-
-
-
-
-
-
-
-
-
-
-
Command-Line Option
-
/keyfile
-
/nocompress
-
/genconfig
-
/all
-
-
-
-
-
/i
-
-
-
-
-
-
-
/o
-
-
-
-
-
-
-
/v
-
-
-
-
-
-
-
/nocompress
-
-
-
-
N/A
-
-
-
/localonly
-
-
-
X
-
-
-
-
/key
-
X
-
-
X
-
-
-
-
/encrypt
-
Required*
-
X
-
X
-
-
-
-
/keyfile
-
N/A
-
-
X
-
-
-
-
/l
-
-
-
-
-
-
-
/progress
-
-
-
X
-
-
-
-
/r
-
-
-
X
-
-
-
-
/w
-
-
-
X
-
-
-
-
/c
-
-
-
X
-
-
-
-
/p
-
-
-
X
-
N/A
-
-
-
/all
-
-
-
X
-
-
-
-
/ui
-
-
-
X
-
X
-
-
-
/ue
-
-
-
X
-
X
-
-
-
/uel
-
-
-
X
-
X
-
-
-
/efs:<option>
-
-
-
X
-
-
-
-
/genconfig
-
-
-
N/A
-
-
-
-
/config
-
-
-
X
-
-
-
-
<StorePath>
-
-
-
X
-
-
-
-
-
+|Command-Line Option|/keyfile|/nocompress|/genconfig|/all|
+|--- |--- |--- |--- |--- |
+|**/i**|||||
+|**/o**|||||
+|**/v**|||||
+|/**nocompress**||||N/A|
+|/**localonly**|||X||
+|/**key**|X||X||
+|/**encrypt**|Required*|X|X||
+|/**keyfile**|N/A||X||
+|/**l**|||||
+|/**progress**|||X||
+|/**r**|||X||
+|/**w**|||X||
+|/**c**|||X||
+|/**p**|||X|N/A|
+|/**all**|||X||
+|/**ui**|||X|X|
+|/**ue**|||X|X|
+|/**uel**|||X|X|
+|/**efs**:*<option>*|||X||
+|/**genconfig**|||N/A||
+|/**config**|||X||
+|*<StorePath>*|||X||
> [!NOTE]
> You must specify either the /**key** or /**keyfile** option with the /**encrypt** option.
-
-
## Related topics
-
[XML Elements Library](usmt-xml-elements-library.md)
-
diff --git a/windows/deployment/usmt/usmt-troubleshooting.md b/windows/deployment/usmt/usmt-troubleshooting.md
index 1a2fbc4401..7a4bedbd54 100644
--- a/windows/deployment/usmt/usmt-troubleshooting.md
+++ b/windows/deployment/usmt/usmt-troubleshooting.md
@@ -16,46 +16,20 @@ ms.topic: article
# User State Migration Tool (USMT) Troubleshooting
-
The following table describes topics that address common User State Migration Tool (USMT) 10.0 issues and questions. These topics describe tools that you can use to troubleshoot issues that arise during your migration.
## In This Section
-
-
-
-
+| Link | Description |
+|--- |--- |
+|[Common Issues](usmt-common-issues.md)|Find troubleshooting solutions for common problems in USMT.|
+|[Frequently Asked Questions](usmt-faq.yml)|Find answers to questions about how to use USMT.|
+|[Log Files](usmt-log-files.md)|Learn how to enable logging to help you troubleshoot issues in USMT.|
+|[Return Codes](usmt-return-codes.md)|Learn how to use return codes to identify problems in USMT.|
+|[USMT Resources](usmt-resources.md)|Find more information and support for using USMT.|
## Related topics
-
[USMT Best Practices](usmt-best-practices.md)
[User State Migration Tool (USMT) Overview Topics](usmt-topics.md)
@@ -63,12 +37,3 @@ The following table describes topics that address common User State Migration To
[User State Migration Tool (USMT) How-to topics](usmt-how-to.md)
[User State Migration Toolkit (USMT) Reference](usmt-reference.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-utilities.md b/windows/deployment/usmt/usmt-utilities.md
index d87666c8b6..0824d0f77f 100644
--- a/windows/deployment/usmt/usmt-utilities.md
+++ b/windows/deployment/usmt/usmt-utilities.md
@@ -16,7 +16,6 @@ ms.topic: article
# UsmtUtils Syntax
-
This topic describes the syntax for the utilities available in User State Migration Tool (USMT) 10.0 through the command-line interface. These utilities:
- Improve your ability to determine cryptographic options for your migration.
@@ -29,7 +28,6 @@ This topic describes the syntax for the utilities available in User State Migrat
## In This Topic
-
[Usmtutils.exe](#bkmk-usmtutils-exe)
[Verify Options](#bkmk-verifyoptions)
@@ -38,162 +36,34 @@ This topic describes the syntax for the utilities available in User State Migrat
## Usmtutils.exe
-
The following table lists command-line options for USMTutils.exe. The sections that follow provide further command-line options for the **/verify** and the **/extract** options.
The syntax for UsmtUtils.exe is:
usmtutils \[/ec | /rd *<storeDir>* | /verify *<filepath>* \[options\] | /extract *<filepath>* *<destinationPath>* \[options\]\]
-
-
-
-
-
-
-
-
Command-line Option
-
Description
-
-
-
-
-
/ec
-
Returns a list of supported cryptographic algorithms (AlgIDs) on the current system. You can use this on a destination computer to determine which algorithm to use with the /encrypt command before you run the ScanState tool on the source computer.
-
-
-
/rd<storeDir>
-
Removes the directory path specified by the <storeDir> argument on the computer. You can use this command to delete hard-link migration stores that cannot otherwise be deleted at a command prompt due to a sharing lock. If the migration store spans multiple volumes on a given drive, it will be deleted from all of these volumes.
-
For example:
-
usmtutils /rd D:\MyHardLinkStore
-
-
-
/y
-
Overrides the accept deletions prompt when used with the /rd option. When you use the /y option with the /rd option, you will not be prompted to accept the deletions before USMT deletes the directories.
-
-
-
/verify
-
Returns information on whether the compressed migration store is intact or whether it contains corrupted files or a corrupted catalog.
-
See Verify Options for syntax and options to use with /verify.
-
-
-
/extract
-
Recovers files from a compressed USMT migration store.
-
See Extract Options for syntax and options to use with /extract.
-
-
-
-
-
+|Command-line Option|Description|
+|--- |--- |
+|**/ec**|Returns a list of supported cryptographic algorithms (AlgIDs) on the current system. You can use this on a destination computer to determine which algorithm to use with the **/encrypt** command before you run the ScanState tool on the source computer.|
+|**/rd** *<storeDir>* |Removes the directory path specified by the *<storeDir>* argument on the computer. You can use this command to delete hard-link migration stores that cannot otherwise be deleted at a command prompt due to a sharing lock. If the migration store spans multiple volumes on a given drive, it will be deleted from all of these volumes.
For example: `usmtutils /rd D:\MyHardLinkStore`|
+|**/y**|Overrides the accept deletions prompt when used with the **/rd** option. When you use the **/y** option with the **/rd** option, you will not be prompted to accept the deletions before USMT deletes the directories.|
+|**/verify**|Returns information on whether the compressed migration store is intact or whether it contains corrupted files or a corrupted catalog.
See [Verify Options](#bkmk-verifyoptions) for syntax and options to use with **/verify**.|
+|**/extract**|Recovers files from a compressed USMT migration store.
See [Extract Options](#bkmk-extractoptions) for syntax and options to use with **/extract**.|
## Verify Options
-
Use the **/verify** option when you want to determine whether a compressed migration store is intact or whether it contains corrupted files or a corrupted catalog. For more information on how to use the **/verify** option, see [Verify the Condition of a Compressed Migration Store](verify-the-condition-of-a-compressed-migration-store.md).
The syntax for **/verify** is:
usmtutils /verify\[:*<reportType>*\] *<filePath>* \[/l:*<logfile>*\] \[/v:*VerbosityLevel*\] \[/decrypt \[:*<AlgID>*\] {/key:*<keystring>* | /keyfile:*<filename>*}\]
-
-
-
-
-
-
-
-
Command-line Option
-
Description
-
-
-
-
-
<reportType>
-
Specifies whether to report on all files, corrupted files only, or the status of the catalog.
-
-
Summary. Returns both the number of files that are intact and the number of files that are corrupted in the migration store. If no algorithm is specified, the summary report is displayed as a default.
-
all. Returns a tab-delimited list of all of the files in the compressed migration store and the status for each file. Each line contains the file name followed by a tab spacing, and either “CORRUPTED” or “OK” depending on the status of the file. The last entry reports the corruption status of the "CATALOG" of the store. A catalog file contains metadata for all files in a migration store. The LoadState tool requires a valid catalog file in order to open the migration store. Returns "OK" if the catalog file is intact and LoadState can open the migration store and "CORRUPTED" if the migration store is corrupted.
-
failureonly. Returns a tab-delimited list of only the files that are corrupted in the compressed migration store.
-
Catalog. Returns only the status of the catalog file.
-
-
-
-
/l:
-
<logfilePath>
-
Specifies the location and name of the log file.
-
-
-
/v:<VerbosityLevel>
-
(Verbosity)
-
Enables verbose output in the UsmtUtils log file. The default value is 0.
-
You can set the VerbosityLevel to one of the following levels:
-
-
-
-
-
-
-
-
Level
-
Explanation
-
-
-
-
-
0
-
Only the default errors and warnings are enabled.
-
-
-
1
-
Enables verbose output.
-
-
-
4
-
Enables error and status output.
-
-
-
5
-
Enables verbose and status output.
-
-
-
8
-
Enables error output to a debugger.
-
-
-
9
-
Enables verbose output to a debugger.
-
-
-
12
-
Enables error and status output to a debugger.
-
-
-
13
-
Enables verbose, status, and debugger output.
-
-
-
-
-
-
-
/decrypt<AlgID>/:<KeyString>
-
or
-
/decrypt<AlgID>/:<“Key String”>
-
or
-
/decrypt:<AlgID>/keyfile:<FileName>
-
Specifies that the /encrypt option was used to create the migration store with the ScanState tool. To decrypt the migration store, specify a /key or /keyfile option as follows:
-
-
<AlgID> specifies the cryptographic algorithm that was used to create the migration store on the ScanState command line. If no algorithm is specified, ScanState and UsmtUtils use the 3DES algorithm as a default.
-
<AlgID> valid values include: AES_128, AES_192, AES_256, 3DES, or 3DES_112.
-
/key:<KeyString> specifies the encryption key. If there is a space in <KeyString>, you must surround the argument with quotation marks.
-
/keyfile: <FileName> specifies the location and name of a text (.txt) file that contains the encryption key.
-
-
+| Command-line Option | Description |
+|-----|--------|
+| *<reportType>* | Specifies whether to report on all files, corrupted files only, or the status of the catalog.
**Summary**. Returns both the number of files that are intact and the number of files that are corrupted in the migration store. If no algorithm is specified, the summary report is displayed as a default.
**all**. Returns a tab-delimited list of all of the files in the compressed migration store and the status for each file. Each line contains the file name followed by a tab spacing, and either “CORRUPTED” or “OK” depending on the status of the file. The last entry reports the corruption status of the "CATALOG" of the store. A catalog file contains metadata for all files in a migration store. The LoadState tool requires a valid catalog file in order to open the migration store. Returns "OK" if the catalog file is intact and LoadState can open the migration store and "CORRUPTED" if the migration store is corrupted.
**failureonly**. Returns a tab-delimited list of only the files that are corrupted in the compressed migration store.
**Catalog**. Returns only the status of the catalog file.
|
+| **/l:** *<logfilePath>* | Specifies the location and name of the log file. |
+| **/v:** *<VerbosityLevel>* | **(Verbosity)**
Enables verbose output in the UsmtUtils log file. The default value is 0.
You can set the *VerbosityLevel* to one of the following levels:
**0** - Only the default errors and warnings are enabled.
**1** - Enables verbose output.
**4** - Enables error and status output.
**5** - Enables verbose and status output.
**8** - Enables error output to a debugger.
**9** - Enables verbose output to a debugger.
**12** - Enables error and status output to a debugger.
**13** - Enables verbose, status, and debugger output.
|
+| **/decrypt** *<AlgID>* **/**:*<KeyString>* or **/decrypt** *<AlgID>* **/**:*<“Key String”>* or **/decrypt:** *<AlgID>* **/keyfile**:*<FileName>* | Specifies that the **/encrypt** option was used to create the migration store with the ScanState tool. To decrypt the migration store, specify a **/key** or **/keyfile** option as follows:
*<AlgID>* specifies the cryptographic algorithm that was used to create the migration store on the ScanState command line. If no algorithm is specified, ScanState and UsmtUtils use the 3DES algorithm as a default. *<AlgID>* valid values include: AES_128, AES_192, AES_256, 3DES, or 3DES_112.
**/key:** *<KeyString>* specifies the encryption key. If there is a space in *<KeyString>*, you must surround the argument with quotation marks.
**/keyfile**: *<FileName>* specifies the location and name of a text (.txt) file that contains the encryption key.
For more information about supported encryption algorithms, see [Migration Store Encryption](usmt-migration-store-encryption.md) |
Some examples of **/verify** commands:
@@ -214,116 +84,16 @@ The syntax for **/extract** is:
/extract *<filePath>* *<destinationPath>* \[/i:*<includePattern>*\] \[/e: *<excludePattern>*\] \[/l: *<logfile>*\] \[/v: *VerbosityLevel>*\] \[/decrypt\[:*<AlgID>*\] {key: *<keystring>* | /keyfile: *<filename>*}\] \[/o\]
-
-
-
-
-
-
-
-
Command-line Option
-
Description
-
-
-
-
-
<filePath>
-
Path to the USMT migration store.
-
For example:
-
D:\MyMigrationStore\USMT\store.mig
-
-
-
<destinationPath>
-
Path to the folder where the tool puts the individual files.
-
-
-
/i:<includePattern>
-
Specifies a pattern for files to include in the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use /i: <includePattern> and /e: <excludePattern> options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns.
-
-
-
/e:<excludePattern>
-
Specifies a pattern for files to omit from the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use /i: <includePattern> and /e: <excludePattern> options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns.
-
-
-
/l:<logfilePath>
-
Specifies the location and name of the log file.
-
-
-
/v:<VerbosityLevel>
-
(Verbosity)
-
Enables verbose output in the UsmtUtils log file. The default value is 0.
-
You can set the VerbosityLevel to one of the following levels:
-
-
-
-
-
-
-
-
Level
-
Explanation
-
-
-
-
-
0
-
Only the default errors and warnings are enabled.
-
-
-
1
-
Enables verbose output.
-
-
-
4
-
Enables error and status output.
-
-
-
5
-
Enables verbose and status output.
-
-
-
8
-
Enables error output to a debugger.
-
-
-
9
-
Enables verbose output to a debugger.
-
-
-
12
-
Enables error and status output to a debugger.
-
-
-
13
-
Enables verbose, status, and debugger output.
-
-
-
-
-
-
-
/decrypt<AlgID>/key:<KeyString>
-
or
-
/decrypt<AlgID>/:<“Key String”>
-
or
-
/decrypt:<AlgID>/keyfile:<FileName>
-
Specifies that the /encrypt option was used to create the migration store with the ScanState tool. To decrypt the migration store, you must also specify a /key or /keyfile option as follows:
-
-
<AlgID> specifies the cryptographic algorithm that was used to create the migration store on the ScanState command line. If no algorithm is specified, ScanState and UsmtUtils use the 3DES algorithm as a default.
-
<AlgID> valid values include: AES_128, AES_192, AES_256, 3DES, or 3DES_112.
-
/key: <KeyString> specifies the encryption key. If there is a space in <KeyString>, you must surround the argument with quotation marks.
-
/keyfile:<FileName> specifies a text (.txt) file that contains the encryption key
-
-
+| Command-line Option | Description |
+|-------|-----|
+| *<filePath>* | Path to the USMT migration store.
For example: `D:\MyMigrationStore\USMT\store.mig` |
+| *<destinationPath>* | Path to the folder where the tool puts the individual files. |
+| **/i**:*<includePattern>* | Specifies a pattern for files to include in the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use **/i**: *<includePattern>* and **/e**: *<excludePattern>* options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns. |
+| **/e**:*<excludePattern>* | Specifies a pattern for files to omit from the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use **/i**: *<includePattern>* and **/e**: *<excludePattern>* options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns. |
+| **/l**:*<logfilePath>* | Specifies the location and name of the log file. |
+| **/v:***<VerbosityLevel>* | **(Verbosity)**
Enables verbose output in the UsmtUtils log file. The default value is 0.
You can set the *VerbosityLevel* to one of the following levels:
**0** - Only the default errors and warnings are enabled.
**1** - Enables verbose output.
**4** - Enables error and status output.
**5** - Enables verbose and status output.
**8** - Enables error output to a debugger.
**9** - Enables verbose output to a debugger.
**12** - Enables error and status output to a debugger.
**13** - Enables verbose, status, and debugger output.
|
+| **/decrypt***<AlgID>***/key**:*<KeyString>* or **/decrypt***<AlgID>***/**:*<“Key String”>* or **/decrypt:***<AlgID>***/keyfile**:*<FileName>* | Specifies that the **/encrypt** option was used to create the migration store with the ScanState tool. To decrypt the migration store, you must also specify a **/key** or **/keyfile** option as follows:
*<AlgID>* specifies the cryptographic algorithm that was used to create the migration store on the ScanState command line. If no algorithm is specified, ScanState and UsmtUtils use the 3DES algorithm as a default. *<AlgID>* valid values include: AES_128, AES_192, AES_256, 3DES, or 3DES_112.
**/key**: *<KeyString>* specifies the encryption key. If there is a space in *<KeyString>*, you must surround the argument with quotation marks.
**/keyfile**:*<FileName>* specifies a text (.txt) file that contains the encryption key
For more information about supported encryption algorithms, see [Migration Store Encryption](usmt-migration-store-encryption.md). |
+| **/o** | Overwrites existing output files. |
Some examples of **/extract** commands:
@@ -337,16 +107,6 @@ Some examples of **/extract** commands:
## Related topics
-
[User State Migration Tool (USMT) Command-line Syntax](usmt-command-line-syntax.md)
[Return Codes](usmt-return-codes.md)
-
-
-
-
-
-
-
-
-
diff --git a/windows/deployment/usmt/usmt-what-does-usmt-migrate.md b/windows/deployment/usmt/usmt-what-does-usmt-migrate.md
index c9c2d3cd28..c8660b4b6d 100644
--- a/windows/deployment/usmt/usmt-what-does-usmt-migrate.md
+++ b/windows/deployment/usmt/usmt-what-does-usmt-migrate.md
@@ -16,10 +16,8 @@ ms.topic: article
# What does USMT migrate?
-
## In this topic
-
- [Default migration scripts](#bkmk-defaultmigscripts)
- [User Data](#bkmk-3)
@@ -32,7 +30,6 @@ ms.topic: article
## Default migration scripts
-
The User State Migration Tool (USMT) 10.0 is designed so that an IT engineer can precisely define migrations using the USMT .xml scripting language. USMT provides the following sample scripts:
- **MigApp.XML.** Rules to migrate application settings.
@@ -41,25 +38,23 @@ The User State Migration Tool (USMT) 10.0 is designed so that an IT engineer ca
- **MigUser.XML.** Rules to migrate user profiles and user data.
- MigUser.xml gathers everything in a user’s profile and then does a file extension- based search of most of the system for other user data. If data doesn’t match either of these criteria, the data won’t be migrated. For the most part, this file describes a "core" migration.
+ MigUser.xml gathers everything in a user’s profile and then does a file extension- based search of most of the system for other user data. If data doesn’t match either of these criteria, the data won’t be migrated. For the most part, this file describes a "core" migration.
- The following data does not migrate with MigUser.xml:
+ The following data does not migrate with MigUser.xml:
- - Files outside the user profile that don’t match one of the file extensions in MigUser.xml.
-
- - Access control lists (ACLs) for folders outside the user profile.
+ - Files outside the user profile that don’t match one of the file extensions in MigUser.xml.
+ - Access control lists (ACLs) for folders outside the user profile.
## User data
-
This section describes the user data that USMT migrates by default, using the MigUser.xml file. It also defines how to migrate ACLs.
- **Folders from each user profile.** When you specify the MigUser.xml file, USMT migrates everything in a user’s profiles including the following:
- My Documents, My Video, My Music, My Pictures, desktop files, Start menu, Quick Launch settings, and Favorites.
+ My Documents, My Video, My Music, My Pictures, desktop files, Start menu, Quick Launch settings, and Favorites.
- >[!IMPORTANT]
- >Starting in Windows 10, version 1607 the USMT does not migrate the Start menu layout. To migrate a user's Start menu, you must export and then import settings using the Windows PowerShell cmdlets **Export-StartLayout** and **Import-StartLayout**. For more information, see [USMT common issues](./usmt-common-issues.md#usmt-does-not-migrate-the-start-layout).
+ > [!IMPORTANT]
+ > Starting in Windows 10, version 1607 the USMT does not migrate the Start menu layout. To migrate a user's Start menu, you must export and then import settings using the Windows PowerShell cmdlets **Export-StartLayout** and **Import-StartLayout**. For more information, see [USMT common issues](./usmt-common-issues.md#usmt-does-not-migrate-the-start-layout).
- **Folders from the All Users and Public profiles.** When you specify the MigUser.xml file, USMT also migrates the following from the **All Users** profile in Windows® XP, or the **Public** profile in Windows Vista, Windows 7, or Windows 8:
@@ -77,25 +72,20 @@ This section describes the user data that USMT migrates by default, using the Mi
- Shared Favorites
-- **File types.** When you specify the MigUser.xml file, the ScanState tool searches the fixed drives, collects and then migrates files with any of the following file extensions:
+- **File types.** When you specify the MigUser.xml file, the ScanState tool searches the fixed drives, collects, and then migrates files with any of the following file extensions:
- **.accdb, .ch3, .csv, .dif, .doc\*, .dot\*, .dqy, .iqy, .mcw, .mdb\*, .mpp, .one\*, .oqy, .or6, .pot\*, .ppa, .pps\*, .ppt\*, .pre, .pst, .pub, .qdf, .qel, .qph, .qsd, .rqy, .rtf, .scd, .sh3, .slk, .txt, .vl\*, .vsd, .wk\*, .wpd, .wps, .wq1, .wri, .xl\*, .xla, .xlb, .xls\*.**
+ **.accdb, .ch3, .csv, .dif, .doc\*, .dot\*, .dqy, .iqy, .mcw, .mdb\*, .mpp, .one\*, .oqy, .or6, .pot\*, .ppa, .pps\*, .ppt\*, .pre, .pst, .pub, .qdf, .qel, .qph, .qsd, .rqy, .rtf, .scd, .sh3, .slk, .txt, .vl\*, .vsd, .wk\*, .wpd, .wps, .wq1, .wri, .xl\*, .xla, .xlb, .xls\*.**
- **Note**
- The asterisk (\*) stands for zero or more characters.
-
-
+ > [!NOTE]
+ > The asterisk (\*) stands for zero or more characters.
- **Access control lists.** USMT migrates ACLs for specified files and folders from computers running both Windows® XP and Windows Vista. For example, if you migrate a file named File1.txt that is read-only for User1 and read/write for User2, these settings will still apply on the destination computer after the migration.
-**Important**
-To migrate ACLs, you must specify the directory to migrate in the MigUser.xml file. Using file patterns like \*.doc will not migrate a directory. The source ACL information is migrated only when you explicitly specify the directory. For example, `c:\test docs`.
-
-
+> [!IMPORTANT]
+> To migrate ACLs, you must specify the directory to migrate in the MigUser.xml file. Using file patterns like \*.doc will not migrate a directory. The source ACL information is migrated only when you explicitly specify the directory. For example, `c:\test docs`.
## Operating-system components
-
USMT migrates operating-system components to a destination computer from computers running Windows 7 and Windows 8
The following components are migrated by default using the manifest files:
@@ -150,229 +140,72 @@ The following components are migrated by default using the manifest files:
\* These settings are not available for an offline migration. For more information, see [Offline Migration Reference](offline-migration-reference.md).
-**Important**
-This list may not be complete. There may be additional components that are migrated.
+> [!IMPORTANT]
+> This list may not be complete. There may be additional components that are migrated.
-
-
-**Note**
-Some settings, such as fonts, are not applied by the LoadState tool until after the destination computer has been restarted. For this reason, restart the destination computer after you run the LoadState tool.
-
-
+> [!NOTE]
+> Some settings, such as fonts, are not applied by the LoadState tool until after the destination computer has been restarted. For this reason, restart the destination computer after you run the LoadState tool.
## Supported applications
-
Although it is not required for all applications, it is good practice to install all applications on the destination computer before restoring the user state. Installing applications before migrating settings helps to ensure that the migrated settings are not overwritten by the application installers.
-**Note**
-The versions of installed applications must match on the source and destination computers. USMT does not support migrating the settings of an earlier version of an application to a later version, except for Microsoft Office.
-
-
-
-**Note**
-USMT migrates only the settings that have been used or modified by the user. If there is an application setting on the source computer that was not touched by the user, the setting may not migrate.
-
-
+> [!NOTE]
+>
+> - The versions of installed applications must match on the source and destination computers. USMT does not support migrating the settings of an earlier version of an application to a later version, except for Microsoft Office.
+> - USMT migrates only the settings that have been used or modified by the user. If there is an application setting on the source computer that was not touched by the user, the setting may not migrate.
When you specify the MigApp.xml file, USMT migrates the settings for the following applications:
-
-
-
-
-
-
-
-
Product
-
Version
-
-
-
-
-
Adobe Acrobat Reader
-
9
-
-
-
AOL Instant Messenger
-
6.8
-
-
-
Adobe Creative Suite
-
2
-
-
-
Adobe Photoshop CS
-
8, 9
-
-
-
Adobe ImageReady CS
-
-
-
-
Apple iTunes
-
6, 7, 8
-
-
-
Apple QuickTime Player
-
5, 6, 7
-
-
-
Apple Safari
-
3.1.2
-
-
-
Google Chrome
-
beta
-
-
-
Google Picasa
-
3
-
-
-
Google Talk
-
beta
-
-
-
IBM Lotus 1-2-3
-
9
-
-
-
IBM Lotus Notes
-
6,7, 8
-
-
-
IBM Lotus Organizer
-
5
-
-
-
IBM Lotus WordPro
-
9.9
-
-
-
Intuit Quicken Deluxe
-
2009
-
-
-
Money Plus Business
-
2008
-
-
-
Money Plus Home
-
2008
-
-
-
Mozilla Firefox
-
3
-
-
-
Microsoft Office
-
2003, 2007, 2010
-
-
-
Microsoft Office Access®
-
2003, 2007, 2010
-
-
-
Microsoft Office Excel®
-
2003, 2007, 2010
-
-
-
Microsoft Office FrontPage®
-
2003, 2007, 2010
-
-
-
Microsoft Office OneNote®
-
2003, 2007, 2010
-
-
-
Microsoft Office Outlook®
-
2003, 2007, 2010
-
-
-
Microsoft Office PowerPoint®
-
2003, 2007, 2010
-
-
-
Microsoft Office Publisher
-
2003, 2007, 2010
-
-
-
Microsoft Office Word
-
2003, 2007, 2010
-
-
-
Opera Software Opera
-
9.5
-
-
-
Microsoft Outlook Express
-
(only mailbox file)
-
-
-
Microsoft Project
-
2003, 2007
-
-
-
Microsoft Office Visio®
-
2003, 2007
-
-
-
RealPlayer Basic
-
11
-
-
-
Sage Peachtree
-
2009
-
-
-
Skype
-
3.8
-
-
-
Windows Live Mail
-
12, 14
-
-
-
Windows Live Messenger
-
8.5, 14
-
-
-
Windows Live MovieMaker
-
14
-
-
-
Windows Live Photo Gallery
-
12, 14
-
-
-
Windows Live Writer
-
12, 14
-
-
-
Windows Mail
-
(Windows 7 and 8)
-
-
-
Microsoft Works
-
9
-
-
-
Yahoo Messenger
-
9
-
-
-
Microsoft Zune™ Software
-
3
-
-
-
-
-
+|Product|Version|
+|--- |--- |
+|Adobe Acrobat Reader|9|
+|AOL Instant Messenger|6.8|
+|Adobe Creative Suite|2|
+|Adobe Photoshop CS|8, 9|
+|Adobe ImageReady CS||
+|Apple iTunes|6, 7, 8|
+|Apple QuickTime Player|5, 6, 7|
+|Apple Safari|3.1.2|
+|Google Chrome|beta|
+|Google Picasa|3|
+|Google Talk|beta|
+|IBM Lotus 1-2-3|9|
+|IBM Lotus Notes|6,7, 8|
+|IBM Lotus Organizer|5|
+|IBM Lotus WordPro|9.9|
+|Intuit Quicken Deluxe|2009|
+|Money Plus Business|2008|
+|Money Plus Home|2008|
+|Mozilla Firefox|3|
+|Microsoft Office|2003, 2007, 2010|
+|Microsoft Office Access®|2003, 2007, 2010|
+|Microsoft Office Excel®|2003, 2007, 2010|
+|Microsoft Office FrontPage®|2003, 2007, 2010|
+|Microsoft Office OneNote®|2003, 2007, 2010|
+|Microsoft Office Outlook®|2003, 2007, 2010|
+|Microsoft Office PowerPoint®|2003, 2007, 2010|
+|Microsoft Office Publisher|2003, 2007, 2010|
+|Microsoft Office Word|2003, 2007, 2010|
+|Opera Software Opera|9.5|
+|Microsoft Outlook Express|(only mailbox file)|
+|Microsoft Project|2003, 2007|
+|Microsoft Office Visio®|2003, 2007|
+|RealPlayer Basic|11|
+|Sage Peachtree|2009|
+|Skype|3.8|
+|Windows Live Mail|12, 14|
+|Windows Live Messenger|8.5, 14|
+|Windows Live MovieMaker|14|
+|Windows Live Photo Gallery|12, 14|
+|Windows Live Writer|12, 14|
+|Windows Mail|(Windows 7 and 8)|
+|Microsoft Works|9|
+|Yahoo Messenger|9|
+|Microsoft Zune™ Software|3|
## What USMT does not migrate
-
The following is a list of the settings that USMT does not migrate. If you are having a problem that is not listed here, see [Common Issues](usmt-common-issues.md).
### Application settings
@@ -417,8 +250,4 @@ Starting in Windows 10, version 1607 the USMT does not migrate the Start menu la
## Related topics
-
[Plan your migration](usmt-plan-your-migration.md)
-
-
-
diff --git a/windows/deployment/usmt/usmt-xml-elements-library.md b/windows/deployment/usmt/usmt-xml-elements-library.md
index c97dfbadb0..7077db2d80 100644
--- a/windows/deployment/usmt/usmt-xml-elements-library.md
+++ b/windows/deployment/usmt/usmt-xml-elements-library.md
@@ -16,13 +16,10 @@ ms.topic: article
# XML Elements Library
-
-
-This topic describes the XML elements and helper functions that you can employ to author migration .xml files to use with User State Migration Tool (USMT). It is assumed that you understand the basics of XML. .
+This topic describes the XML elements and helper functions that you can employ to author migration .xml files to use with User State Migration Tool (USMT). It is assumed that you understand the basics of XML.
## In this topic
-
In addition to XML elements and helper functions, this topic describes how to specify encoded locations and locations patterns, functions that are for internal USMT use only, and the version tags that you can use with helper functions.
- [Elements and helper functions](#elements)
@@ -37,88 +34,14 @@ In addition to XML elements and helper functions, this topic describes how to sp
## Elements and Helper Functions
-
The following table describes the XML elements and helper functions you can use with USMT.
-
-
-
+| Elements A-K | Elements L-Z | Helper functions |
+|-----|----|-----|
+| [<addObjects>](#addobjects) [<attributes>](#attribute) [<bytes>](#bytes) [<commandLine>](#commandline) [<component>](#component) [<condition>](#condition) [<conditions>](#conditions) [<content>](#content) [<contentModify>](#contentmodify) [<description>](#description) [<destinationCleanup>](#destinationcleanup) [<detect>](#detect) [<detects>](#detects) [<detection>](#detection) [<displayName>](#displayname) [<environment>](#bkmk-environment) [<exclude>](#exclude) [<excludeAttributes>](#excludeattributes) [<extensions>](#extensions) [<extension>](#extension) [<externalProcess>](#externalprocess) [<icon>](#icon) [<include>](#include) [<includeAttribute>](#includeattributes) | [<library>](#library) [<location>](#location) [<locationModify>](#locationmodify) [<_locDefinition>](#locdefinition) [<manufacturer>](#manufacturer) [<merge>](#merge) [<migration>](#migration) [<namedElements>](#namedelements) [<object>](#object) [<objectSet>](#objectset) [<path>](#path) [<paths>](#paths) [<pattern>](#pattern) [<processing>](#processing) [<plugin>](#plugin) [<role>](#role) [<rules>](#rules) [<script>](#script) [<text>](#text) [<unconditionalExclude>](#unconditionalexclude) [<variable>](#variable) [<version>](#version) [<windowsObjects>](#windowsobjects) | [<condition> functions](#conditionfunctions) [<content> functions](#contentfunctions) [<contentModify> functions](#contentmodifyfunctions) [<include> and <exclude> filter functions](#persistfilterfunctions) [<locationModify> functions](#locationmodifyfunctions) [<merge> functions](#mergefunctions) [<script> functions](#scriptfunctions) [Internal USMT functions](#internalusmtfunctions) |
## <addObjects>
-
The <addObjects> element emulates the existence of one or more objects on the source computer. The child <object> elements provide the details of the emulated objects. If the content is a <script> element, the result of the invocation will be an array of objects.
- **Number of occurrences:** unlimited
@@ -131,13 +54,14 @@ The <addObjects> element emulates the existence of one or more objects on
Syntax:
-<addObjects>
-
-</addObjects>
+```xml
+
+
+```
The following example is from the MigApp.xml file:
-``` xml
+```xml