| Element | -Description | -Supported browser | -
|---|---|---|
| <site-list> | -A new root node with this text is using the updated v.2 version of the schema. It replaces <rules>.
- Example - -<site-list version="205"> - <site url="contoso.com"> - <compat-mode>IE8Enterprise</compat-mode> - <open-in>IE11</open-in> - </site> -</site-list> |
-Internet Explorer 11 and Microsoft Edge | -
| <site> | -A unique entry added for each site you want to put on the Enterprise Mode site list. The first <site> element will overrule any additional <site> elements that use the same value for the <url> element.
- Example - -<site url="contoso.com"> - <compat-mode>default</compat-mode> - <open-in>none</open-in> -</site>--or- - For IPv4 ranges: <site url="10.122.34.99:8080"> - <compat-mode>IE8Enterprise</compat-mode> -<site> --or- - For IPv6 ranges: <site url="[10.122.34.99]:8080"> - <compat-mode>IE8Enterprise</compat-mode> -<site> -You can also use the self-closing version, <url="contoso.com" />, which also sets: -
|
-Internet Explorer 11 and Microsoft Edge | -
| <compat-mode> | -A child element that controls what compatibility setting is used for specific sites or domains. This element is only supported in IE11.
- Example - -<site url="contoso.com"> - <compat-mode>IE8Enterprise</compat-mode> -</site>--or- - For IPv4 ranges: <site url="10.122.34.99:8080"> - <compat-mode>IE8Enterprise</compat-mode> -<site> --or- - For IPv6 ranges: <site url="[10.122.34.99]:8080"> - <compat-mode>IE8Enterprise</compat-mode> -<site> -Where: -
- - - |
-Internet Explorer 11 | -
| <open-in> | -A child element that controls what browser is used for sites. This element supports the Open in IE11 or Open in Microsoft Edge experiences, for devices running Windows 10.
- Example - -<site url="contoso.com"> - <open-in>none</open-in> -</site> -Where: -
- - |
-Internet Explorer 11 and Microsoft Edge | -
| Attribute | -Description | -Supported browser | -
|---|---|---|
| allow-redirect | -A boolean attribute of the <open-in> element that controls the behavior for redirected sites. Setting this attribute to "true" indicates that the site will open in IE11 or Microsoft Edge even if the site is navigated to as part of a HTTP or meta refresh redirection chain. Omitting the attribute is equivalent to "false" (sites in redirect chain will not open in another browser).
- Example - -<site url="contoso.com/travel"> - <open-in allow-redirect="true">IE11</open-in> -</site>-In this example, if https://contoso.com/travel is encountered in a redirect chain in Microsoft Edge, it will be opened in Internet Explorer. |
-Internet Explorer 11 and Microsoft Edge | -
| version | -Specifies the version of the Enterprise Mode Site List. This attribute is supported for the <site-list> element. | -Internet Explorer 11 and Microsoft Edge | -
| url | -Specifies the URL (and port number using standard port conventions) to which the child elements apply. The URL can be a domain, sub-domain, or any path URL.
- Note -Make sure that you don't specify a protocol. Using <site url="contoso.com"> applies to both https://contoso.com and https://contoso.com. - Example - -<site url="contoso.com:8080"> - <compat-mode>IE8Enterprise</compat-mode> - <open-in>IE11</open-in> -</site>-In this example, going to https://contoso.com:8080 using Microsoft Edge, causes the site to open in IE11 and load in IE8 Enterprise Mode. |
-Internet Explorer 11 and Microsoft Edge | -
| Deprecated attribute | -New attribute | -Replacement example | -
|---|---|---|
| <forceCompatView> | -<compat-mode> | -Replace <forceCompatView="true"> with <compat-mode>IE7Enterprise</compat-mode> | -
| <docMode> | -<compat-mode> | -Replace <docMode="IE5"> with <compat-mode>IE5</compat-mode> | -
| <doNotTransition> | -<open-in> | -Replace <doNotTransition="true"> with <open-in>none</open-in> | -
| <domain> and <path> | -<site> | -Replace:
--<emie> - <domain exclude="false">contoso.com</domain> -</emie>-With: - -<site url="contoso.com"/> - <compat-mode>IE8Enterprise</compat-mode> -</site>--AND- -Replace: - -<emie> - <domain exclude="true">contoso.com - <path exclude="false" forceCompatView="true">/about</path> - </domain> -</emie>-With: - -<site url="contoso.com/about"> - <compat-mode>IE7Enterprise</compat-mode> -</site> |
-
| Element | +Description | +Supported browser | +
|---|---|---|
| <site-list> | +A new root node with this text is using the updated v.2 version of the schema. It replaces <rules>.
+ Example + +<site-list version="205"> + <site url="contoso.com"> + <compat-mode>IE8Enterprise</compat-mode> + <open-in>IE11</open-in> + </site> +</site-list> |
+Internet Explorer 11 and Microsoft Edge | +
| <site> | +A unique entry added for each site you want to put on the Enterprise Mode site list. The first <site> element will overrule any additional <site> elements that use the same value for the <url> element.
+ Example + +<site url="contoso.com"> + <compat-mode>default</compat-mode> + <open-in>none</open-in> +</site>+-or- + For IPv4 ranges: <site url="10.122.34.99:8080"> + <compat-mode>IE8Enterprise</compat-mode> +<site> +-or- + For IPv6 ranges: <site url="[10.122.34.99]:8080"> + <compat-mode>IE8Enterprise</compat-mode> +<site> +You can also use the self-closing version, <url="contoso.com" />, which also sets: +
|
+Internet Explorer 11 and Microsoft Edge | +
| <compat-mode> | +A child element that controls what compatibility setting is used for specific sites or domains. This element is only supported in IE11.
+ Example + +<site url="contoso.com"> + <compat-mode>IE8Enterprise</compat-mode> +</site>+-or- + For IPv4 ranges: <site url="10.122.34.99:8080"> + <compat-mode>IE8Enterprise</compat-mode> +<site> +-or- + For IPv6 ranges: <site url="[10.122.34.99]:8080"> + <compat-mode>IE8Enterprise</compat-mode> +<site> +Where: +
+ + + |
+Internet Explorer 11 | +
| <open-in> | +A child element that controls what browser is used for sites. This element supports the Open in IE11 or Open in Microsoft Edge experiences, for devices running Windows 10.
+ Example + +<site url="contoso.com"> + <open-in>none</open-in> +</site> +Where: +
+ + |
+Internet Explorer 11 and Microsoft Edge | +
| Attribute | +Description | +Supported browser | +
|---|---|---|
| allow-redirect | +A boolean attribute of the <open-in> element that controls the behavior for redirected sites. Setting this attribute to "true" indicates that the site will open in IE11 or Microsoft Edge even if the site is navigated to as part of a HTTP or meta refresh redirection chain. Omitting the attribute is equivalent to "false" (sites in redirect chain will not open in another browser).
+ Example + +<site url="contoso.com/travel"> + <open-in allow-redirect="true">IE11</open-in> +</site>+In this example, if https://contoso.com/travel is encountered in a redirect chain in Microsoft Edge, it will be opened in Internet Explorer. |
+Internet Explorer 11 and Microsoft Edge | +
| version | +Specifies the version of the Enterprise Mode Site List. This attribute is supported for the <site-list> element. | +Internet Explorer 11 and Microsoft Edge | +
| url | +Specifies the URL (and port number using standard port conventions) to which the child elements apply. The URL can be a domain, sub-domain, or any path URL.
+ Note +Make sure that you don't specify a protocol. Using <site url="contoso.com"> applies to both https://contoso.com and https://contoso.com. + Example + +<site url="contoso.com:8080"> + <compat-mode>IE8Enterprise</compat-mode> + <open-in>IE11</open-in> +</site>+In this example, going to https://contoso.com:8080 using Microsoft Edge, causes the site to open in IE11 and load in IE8 Enterprise Mode. |
+Internet Explorer 11 and Microsoft Edge | +
| Deprecated attribute | +New attribute | +Replacement example | +
|---|---|---|
| <forceCompatView> | +<compat-mode> | +Replace <forceCompatView="true"> with <compat-mode>IE7Enterprise</compat-mode> | +
| <docMode> | +<compat-mode> | +Replace <docMode="IE5"> with <compat-mode>IE5</compat-mode> | +
| <doNotTransition> | +<open-in> | +Replace <doNotTransition="true"> with <open-in>none</open-in> | +
| <domain> and <path> | +<site> | +Replace:
++<emie> + <domain exclude="false">contoso.com</domain> +</emie>+With: + +<site url="contoso.com"/> + <compat-mode>IE8Enterprise</compat-mode> +</site>+-AND- +Replace: + +<emie> + <domain exclude="true">contoso.com + <path exclude="false" forceCompatView="true">/about</path> + </domain> +</emie>+With: + +<site url="contoso.com/about"> + <compat-mode>IE7Enterprise</compat-mode> +</site> |
+
Policy
Policy nodes define the policy for launching executables, Windows Installer files, scripts, store apps, and DLL files. The contents of a given Policy node is precisely the XML format for a RuleCollection node in the corresponding AppLocker XML policy.
-Policy nodes are a Base64-encoded blob of the binary policy representation. The binary policy may be signed or unsigned.
-For CodeIntegrity/Policy, you can use the certutil -encode command line tool to encode the data to base-64.
-Here is a sample certutil invocation:
- -``` -certutil -encode WinSiPolicy.p7b WinSiPolicy.cer -``` - -An alternative to using certutil would be to use the following PowerShell invocation:
- -``` -[Convert]::ToBase64String($(Get-Content -Encoding Byte -ReadCount 0 -PathIf you are using hybrid MDM management with System Center Configuration Manager or using Intune, ensure that you are using Base64 as the Data type when using Custom OMA-URI functionality to apply the Code Integrity policy.
-Data type is string. Supported operations are Get, Add, Delete, and Replace.
For nodes, other than CodeIntegrity, policy leaf data type is string. Supported operations are Get, Add, Delete, and Replace.
+For CodeIntegrity/Policy, data type is Base64. Supported operations are Get, Add, Delete, and Replace.
EnforcementMode
| - | - | Windows 10 Home | -Windows 10 Pro | -Windows 10 Pro Education | -Windows 10 Education | -Windows 10 Enterprise | -Windows 10 Mobile | -Windows 10 Mobile Enterprise | -
| Windows 7 | -||||||||
| Starter | -✔ | -✔ | -✔ | -✔ | -- | - | - | |
| Home Basic | -✔ | -✔ | -✔ | -✔ | -- | - | - | |
| Home Premium | -✔ | -✔ | -✔ | -✔ | -- | - | - | |
| Professional | -D | -✔ | -✔ | -✔ | -✔ | -- | - | |
| Ultimate | -D | -✔ | -✔ | -✔ | -✔ | -- | - | |
| Enterprise | -- | - | - | ✔ | -✔ | -- | - | |
| Windows 8.1 | -||||||||
| (Core) | -✔ | -✔ | -✔ | -✔ | -- | - | - | |
| Connected | -✔ | -✔ | -✔ | -✔ | -- | - | - | |
| Pro | -D | -✔ | -✔ | -✔ | -✔ | -- | - | |
| Pro Student | -D | -✔ | -✔ | -✔ | -✔ | -- | - | |
| Pro WMC | -D | -✔ | -✔ | -✔ | -✔ | -- | - | |
| Enterprise | -- | - | - | ✔ | -✔ | -- | - | |
| Embedded Industry | -- | - | - | - | ✔ | -- | - | |
| Windows RT | -- | - | - | - | - | - | - | |
| Windows Phone 8.1 | -- | - | - | - | - | - | ✔ | -|
| Windows 10 | -||||||||
| Home | -- | ✔ | -✔ | -✔ | -- | - | - | |
| Pro | -D | -- | ✔ | -✔ | -✔ | -- | - | |
| Education | -- | - | - | - | D | -- | - | |
| Enterprise | -- | - | - | ✔ | -- | - | - | |
| Mobile | -- | - | - | - | - | - | ✔ | -|
| Mobile Enterprise | -- | - | - | - | - | D | -- |
| + | + | Windows 10 Home | +Windows 10 Pro | +Windows 10 Pro Education | +Windows 10 Education | +Windows 10 Enterprise | +Windows 10 Mobile | +Windows 10 Mobile Enterprise | +
| Windows 7 | +||||||||
| Starter | +✔ | +✔ | +✔ | +✔ | ++ | + | + | |
| Home Basic | +✔ | +✔ | +✔ | +✔ | ++ | + | + | |
| Home Premium | +✔ | +✔ | +✔ | +✔ | ++ | + | + | |
| Professional | +D | +✔ | +✔ | +✔ | +✔ | ++ | + | |
| Ultimate | +D | +✔ | +✔ | +✔ | +✔ | ++ | + | |
| Enterprise | ++ | + | + | ✔ | +✔ | ++ | + | |
| Windows 8.1 | +||||||||
| (Core) | +✔ | +✔ | +✔ | +✔ | ++ | + | + | |
| Connected | +✔ | +✔ | +✔ | +✔ | ++ | + | + | |
| Pro | +D | +✔ | +✔ | +✔ | +✔ | ++ | + | |
| Pro Student | +D | +✔ | +✔ | +✔ | +✔ | ++ | + | |
| Pro WMC | +D | +✔ | +✔ | +✔ | +✔ | ++ | + | |
| Enterprise | ++ | + | + | ✔ | +✔ | ++ | + | |
| Embedded Industry | ++ | + | + | + | ✔ | ++ | + | |
| Windows RT | ++ | + | + | + | + | + | + | |
| Windows Phone 8.1 | ++ | + | + | + | + | + | ✔ | +|
| Windows 10 | +||||||||
| Home | ++ | ✔ | +✔ | +✔ | ++ | + | + | |
| Pro | +D | ++ | ✔ | +✔ | +✔ | ++ | + | |
| Education | ++ | + | + | + | D | ++ | + | |
| Enterprise | ++ | + | + | ✔ | ++ | + | + | |
| Mobile | ++ | + | + | + | + | + | ✔ | +|
| Mobile Enterprise | ++ | + | + | + | + | D | ++ |
| 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 |
-
| 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. |
-
| 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: - |
-
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: - |
-
| 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 |
+
| 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. |
+
| 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: + |
+
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: + |
+
| 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. |
-
| 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 |
-
Rule 1 |
- |
-
Rule 2 |
- |
-
| 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. |
+
| 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 |
+
Rule 1 |
+ |
+
Rule 2 |
+ |
+
| Parameter | -Required | -Value | -
|---|---|---|
errorCode |
-No |
-"any" or "specify system error message here" |
-
| 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. |
-
| 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 | +
|---|---|---|
errorCode |
+No |
+"any" or "specify system error message here" |
+
| 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. |
+
| 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. |
+
| If you have the following code in the same component | -Resulting behavior | -Explanation | -
|---|---|---|
|
-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. |
-
|
-Migrates all files and subfolders in C:\Dir1, except the .txt files in C:\Dir1\Dir2 and its subfolders. |
-Both rules are processed as intended. |
-
|
-Migrates all files and subfolders in C:\Dir1, except the .txt files in C:\Dir1 and its subfolders. |
-Both rules are processed as intended. |
-
|
-Nothing will be migrated. |
-The rules are equally specific, so the <exclude> rule takes precedence over the <include> rule. |
-
|
-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. |
-
|
-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: -
Component 2: -
|
-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: -
Component 2: -
|
-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: -
Component 2: -
|
-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 the same component | -Resulting behavior | -Explanation | -
|---|---|---|
|
-Migrates all keys in HKLM\Software\Microsoft\Command Processor except DefaultColor. |
-Both rules are processed as intended. |
-
|
-Migrates only DefaultColor in HKLM\Software\Microsoft\Command Processor. |
-DefaultColor is migrated because the <include> rule is more specific than the <exclude> rule. |
-
|
-Does not migrate DefaultColor. |
-The rules are equally specific, so the <exclude> rule takes precedence over the <include> rule. |
-
| If you have the following code in different components | -Resulting behavior | -Explanation | -
|---|---|---|
Component 1: -
Component 2: -
|
-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 specify the following code | -Resulting behavior | -
|---|---|
|
-During ScanState, all the files will be added to the store. -During LoadState, only C:\Data\SampleA.txt will be restored. |
-
|
-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. |
-
|
-During ScanState, all the files will be added to the store. -During LoadState, the following will occur: -
|
-
| If you have the following code in the same component | +Resulting behavior | +Explanation | +
|---|---|---|
|
+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. |
+
|
+Migrates all files and subfolders in C:\Dir1, except the .txt files in C:\Dir1\Dir2 and its subfolders. |
+Both rules are processed as intended. |
+
|
+Migrates all files and subfolders in C:\Dir1, except the .txt files in C:\Dir1 and its subfolders. |
+Both rules are processed as intended. |
+
|
+Nothing will be migrated. |
+The rules are equally specific, so the <exclude> rule takes precedence over the <include> rule. |
+
|
+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. |
+
|
+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: +
Component 2: +
|
+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: +
Component 2: +
|
+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: +
Component 2: +
|
+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 the same component | +Resulting behavior | +Explanation | +
|---|---|---|
|
+Migrates all keys in HKLM\Software\Microsoft\Command Processor except DefaultColor. |
+Both rules are processed as intended. |
+
|
+Migrates only DefaultColor in HKLM\Software\Microsoft\Command Processor. |
+DefaultColor is migrated because the <include> rule is more specific than the <exclude> rule. |
+
|
+Does not migrate DefaultColor. |
+The rules are equally specific, so the <exclude> rule takes precedence over the <include> rule. |
+
| If you have the following code in different components | +Resulting behavior | +Explanation | +
|---|---|---|
Component 1: +
Component 2: +
|
+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 specify the following code | +Resulting behavior | +
|---|---|
|
+During ScanState, all the files will be added to the store. +During LoadState, only C:\Data\SampleA.txt will be restored. |
+
|
+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. |
+
|
+During ScanState, all the files will be added to the store. +During LoadState, the following will occur: +
|
+
| Code | -Behavior | -
|---|---|
|
-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. |
-
|
-Migrates My Videos for all users. |
-
| Code | -Behavior | -
|---|---|
|
-Migrates all instances of the file Usmttestfile.txt from all sub-directories under %ProgramFiles%\USMTTestFolder. |
-
|
-Migrates the whole directory under %ProgramFiles%\USMTDIRTestFolder. |
-
|
-Migrates all instances of MyKey under HKCU\Software\USMTTESTKEY. |
-
|
-Migrates the entire registry hive under HKLM\Software\USMTTESTKEY. |
-
| Code | +Behavior | +
|---|---|
|
+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. |
+
|
+Migrates My Videos for all users. |
+
| Code | +Behavior | +
|---|---|
|
+Migrates all instances of the file Usmttestfile.txt from all sub-directories under %ProgramFiles%\USMTTestFolder. |
+
|
+Migrates the whole directory under %ProgramFiles%\USMTDIRTestFolder. |
+
|
+Migrates all instances of MyKey under HKCU\Software\USMTTESTKEY. |
+
|
+Migrates the entire registry hive under HKLM\Software\USMTTESTKEY. |
+
<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. -Syntax: <createHardLink> [pattern] </createHardLink> |
-
<errorHardLink> |
-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> |
-
<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. +Syntax: <createHardLink> [pattern] </createHardLink> |
+
<errorHardLink> |
+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> |
+
| 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. |
-
/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. |
-
| 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: -
|
-
detectedUser |
-
|
-
includedInMigration |
-Defines whether the user profile/component is included for migration. Valid values are Yes or No. |
-
forUser |
-Specifies either of the following: -
|
-
detectedComponent |
-Specifies a component detected by USMT. -
|
-
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: -
|
-
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: -
|
-
errorCode |
-The errorCode or return value. |
-
numberOfIgnoredErrors |
-The total number of non-fatal errors that USMT ignored. |
-
message |
-The message corresponding to the errorCode. |
-
| 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. |
+
/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. |
+
| 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: +
|
+
detectedUser |
+
|
+
includedInMigration |
+Defines whether the user profile/component is included for migration. Valid values are Yes or No. |
+
forUser |
+Specifies either of the following: +
|
+
detectedComponent |
+Specifies a component detected by USMT. +
|
+
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: +
|
+
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: +
|
+
errorCode |
+The errorCode or return value. |
+
numberOfIgnoredErrors |
+The total number of non-fatal errors that USMT ignored. |
+
message |
+The message corresponding to the errorCode. |
+
| Elements A-K | -Elements L-Z | -Helper functions | -
|---|---|---|
| - - - - - - - - - - - - - - - - - - - - - - - | -- - - - - - - - - - - - - - - - - - - - - - | -- - - - - - - | -
| Setting | -Required? | -Value | -
|---|---|---|
Content |
-Yes |
-The content depends on the type of object specified. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
string |
-No, default is No |
-Determines whether Content should be interpreted as a string or as bytes. |
-
expand |
-No (default = Yes |
-When the expand parameter is Yes, the content of the <bytes> element is first expanded in the context of the source computer and then interpreted. |
-
Content |
-Yes |
-Depends on the value of the string. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
CommandLineString |
-Yes |
-A valid command line. |
-
| Setting | -Required? | -Value | -
|---|---|---|
type |
-Yes |
-You can use the following to group settings, and define the type of the component. -
|
-
context |
-No -Default = UserAndSystem |
-Defines the scope of this parameter; that is, whether to process this component in the context of the specific user, across the entire operating system, or both. -The largest possible scope is set by the <component> element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it has a context of User. If a <rules> element has a context of System, it would act as though the <rules> element is not there. -
|
-
defaultSupported |
-No -(default = TRUE) |
-Can be any of TRUE, FALSE, YES or NO. If this parameter is FALSE (or NO), the component will not be migrated unless there is an equivalent component on the destination computer. -When type="System" and defaultSupported="FALSE" the settings will not migrate unless there is an equivalent component in the .xml files that are specified on the LoadState command line. For example, the default MigSys.xml file contains components with type="System" and defaultSupported="FALSE". If you specify this file on the ScanState command line, you must also specify the file on the LoadState command line for the settings to migrate. This is because the LoadState tool must detect an equivalent component. That is, the component must have the same migration urlid of the .xml file and an identical display name or the LoadState tool will not migrate those settings from the store. This is helpful when the source computer is running Windows XP, and you are migrating to both Windows Vista and Windows XP because you can use the same store for both destination computers. |
-
hidden |
-
|
-This parameter is for internal USMT use only. |
-
| Setting | -Required? | -Value | -
|---|---|---|
negation |
-No -Default = No |
-"Yes" reverses the True/False value of the condition. |
-
ScriptName |
-Yes |
-A script that has been defined within this migration section. |
-
| Setting | -Required? | -Value | -
|---|---|---|
OSType |
- Yes |
- The only valid value for this setting is NT. Note, however, that you must set this setting for the <condition> functions to work correctly. |
-
OSVersion |
- Yes |
- The major version, minor version, build number and corrected service diskette version separated by periods. For example, |
-
| Setting | -Required? | -Value | -
|---|---|---|
OSType |
- Yes |
- Can be 9x or NT. If OSType does not match the type of the current operating system, then it returns FALSE. For example, if the current operating system is Windows NT-based and OSType is “9x”, the result will be FALSE. |
-
OSVersion |
- Yes |
- The major version, minor version, build number, and corrected service diskette version separated by periods. For example, The IsOSLaterThan function returns TRUE if the current operating system is later than or equal to OSVersion. |
-
| Setting | -Required? | -Value | -
|---|---|---|
OSType |
- Yes |
- Can be 9x or NT. If OSType does not match the type of the current operating system, then it returns FALSE. For example, if the current operating system is Windows NT-based and OSType is “9x” the result will be FALSE. |
-
OSVersion |
- Yes |
- The major version, minor version, build number, and corrected service diskette version separated by periods. For example, The IsOSEarlierThan function returns TRUE if the current operating system is earlier than OSVersion. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- Defines the object type. Can be File or Registry. |
-
EncodedLocationPattern |
- Yes |
- The location pattern. Environment variables are allowed. |
-
| Setting | -Required? | -Value | -
|---|---|---|
EncodedFileLocation |
- Yes |
- The location pattern for the file that will be checked. Environment variables are allowed. |
-
VersionTag |
- Yes |
- The version tag value that will be checked. |
-
VersionValue |
- Yes |
- A string pattern. For example, "Microsoft*". |
-
| Setting | -Required? | -Value | -
|---|---|---|
EncodedFileLocation |
- Yes |
- The location pattern for the file that will be checked. Environment variables are allowed. |
-
VersionTag |
- Yes |
- The version tag value that will be checked. |
-
VersionValue |
- Yes |
- The value to compare to. You cannot specify a pattern. |
-
| Setting | -Required? | -Value | -
|---|---|---|
EncodedFileLocation |
- Yes |
- The location pattern for the file that will be checked. Environment variables are allowed. |
-
VersionTag |
- Yes |
- The version tag value that will be checked. |
-
VersionValue |
- Yes |
- The value to compare to. You cannot specify a pattern. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- Defines the type of object. Can be File or Registry. |
-
EncodedLocationPattern |
- Yes |
- The encoded location for the object that will be examined. You can specify environment variables. |
-
StringContent |
- Yes |
- The string that will be checked against. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- Defines the type of object. Can be File or Registry. |
-
EncodedLocationPattern |
- Yes |
- The encoded location for the object that will be examined. You can specify environment variables. |
-
StrToFind |
- Yes |
- A string that will be searched inside the content of the given object. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- Defines the type of object. Can be File or Registry. |
-
EncodedLocation1 |
- Yes |
- The encoded location for the first object. You can specify environment variables. |
-
EncodedLocation2 |
- Yes |
- The encoded location for the second object. You can specify environment variables. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType1 |
- Yes |
- Defines the type of the first object. Can be File or Registry. |
-
EncodedLocation1 |
- Yes |
- The encoded location for the first object. You can specify environment variables. |
-
ObjectType2 |
- Yes |
- Defines the type of the second object. Can be File or Registry. |
-
EncodedLocation2 |
- Yes |
- The encoded location for the second object. You can specify environment variables. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType1 |
- Yes |
- Defines the type of the first object. Can be File or Registry. |
-
EncodedLocation1 |
- Yes |
- The encoded location for the first object. You can specify environment variables. |
-
ObjectType2 |
- Yes |
- Defines the type of the second object. Can be File or Registry. |
-
EncodedLocation2 |
- Yes |
- The encoded location for the second object. You can specify environment variables. |
-
| Setting | -Required? | -Value | -
|---|---|---|
operation |
-No, default = AND |
-Defines the Boolean operation that is performed on the results that are obtained from the child elements. |
-
| Setting | -Required? | -Value | -
|---|---|---|
filter |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script is called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Separators |
- Yes |
- A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. You can specify NULL. |
-
PathHints |
- Yes |
- A list of extra paths, separated by colons (;), where the function will look for a file matching the current content. For example, if the content is "Notepad.exe" and the path is the %Path% environment variable, the function will find Notepad.exe in %windir% and returns "c:\Windows [Notepad.exe]". You can specify NULL. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Separators |
- Yes |
- A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. This parameter must be NULL when processing MULTI-SZ registry values. |
-
PathHints |
- Yes |
- A list of extra paths, separated by colons (;), where the function will look for a file matching the current content. For example, if the content is "Notepad.exe" and the path is the %Path% environment variable, the function will find Notepad.exe in %windir% and returns "c:\Windows [Notepad.exe]". You can specify NULL. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Separators |
- No |
- A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. You must specify NULL when processing MULTI-SZ registry values. |
-
LevelsToTrim |
- Yes |
- The number of levels to delete from the end of the directory specification. Use this function to extract a root directory when you have a registry value that points inside that root directory in a known location. |
-
PatternSuffix |
- Yes |
- The pattern to add to the directory specification. For example, |
-
| Setting | -Required? | -Value | -
|---|---|---|
script |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
DefaultValueOnError |
- No |
- The value that will be written into the value name if the conversion fails. You can specify NULL, and 0 will be written if the conversion fails. |
-
| Setting | -Required? | -Value | -
|---|---|---|
DefaultValueOnError |
- No |
- The value that will be written into the value name if the conversion fails. You can specify NULL, and 0 will be written if the conversion fails. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Value |
- Yes |
- The string representation of a numeric value. It can be positive or negative. For example, |
-
| Setting | -Required? | -Value | -
|---|---|---|
SourceTable |
- Yes |
- A list of values separated by commas that are possible for the source registry values. |
-
DestinationTable |
- No |
- A list of translated values separated by commas. |
-
DefaultValueOnError |
- No |
- The value that will be applied to the destination computer if either 1) the value for the source computer does not match SourceTable, or 2) DestinationTable has no equivalent value. -If DefaultValueOnError is NULL, the value will not be changed on the destination computer. |
-
| Setting | -Required? | -Value | -
|---|---|---|
OptionString |
- Yes |
- OptionString can be Security, TimeFields, or FileAttrib:Letter. You can specify one of each type of OptionStrings. Do not specify multiple OptionStrings with the same value. If you do, the right-most option of that type will be kept. For example, do not specify ("FileAttrib:H", "FileAttrib:R") because only Read-only will be evaluated. Instead specify ("FileAttrib:HR") and both Hidden and Read-only attributes will be kept on the destination computer. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
Instruction |
- Yes |
- Can be one of the following: -
|
-
String |
- Yes |
- The string to be added or removed. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Delimiters |
- Yes |
- A single character that will be used to separate the content of the object that is being processed. The content will be considered as a list of elements that is separated by the Delimiters. -For example, "." will separate the string based on a period. |
-
Instruction |
- Yes |
- Can one of the following: -
|
-
String |
- Yes |
- The string to be added or removed. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ComponentDescription |
-Yes |
-The description of the component. |
-
| Setting | -Required? | -Value | -
|---|---|---|
filter |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-Yes, when <detect> is a child to <namedElements> -No, when <detect> is a child to <detects> |
-When ID is specified, any child elements are not processed. Instead, any other <detect> elements with the same name that are declared within the <namedElements> element are processed. |
-
context |
-No -(default = UserAndSystem) |
-Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. -The largest possible scope is set by the component element. For example, if a <component> element has a context of User, and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though the <rules> element were not there. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-Yes, when <detects> is a child to <namedElements> -No, when <detects> is a child to <role> or <rules> |
-When ID is specified, no child <detect> elements are processed. Instead, any other <detects> elements with the same name that are declared within the <namedElements> element are processed. |
-
context |
-No -(default = UserAndSystem) |
-Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. -The largest possible scope is set by the <component element>. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though the <rules> element were not there. -
The context parameter is ignored for <detects> elements that are inside <rules> elements. |
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-
|
-If declared, the content of the <detection> element is ignored and the content of the <detection> element with the same name that is declared in the <namedElements> element will be evaluated. |
-
context |
-No, default = UserAndSystem |
-Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
locID |
-No |
-This parameter is for internal USMT use. Do not use this parameter. |
-
ComponentName |
-Yes |
-The name for the component. |
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-Yes, when <environment> is a child of <namedElements> -No, when <environment> is a child of <role> or <component> |
-When declared as a child of the <role> or <component> elements, if ID is declared, USMT ignores the content of the <environment> element and the content of the <environment> element with the same name declared in the <namedElements> element is processed. |
-
context |
-No -(default = UserAndSystem) |
-Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. -The largest possible scope is set by the <component> element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though <rules> were not there. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
filter |
-No -(default = No) |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Parameter | -Required? | -Value | -
|---|---|---|
attributes |
-Yes |
-Specifies the attributes to be excluded. You can specify one of the following, or both separated by quotes; for example,
|
-
| Setting | -Required? | -Value | -
|---|---|---|
FilenameExtension |
-Yes |
-A file name extension. |
-
| Setting | -Required? | -Value | -
|---|---|---|
when |
-Yes |
-Indicates when the command line should be run. This value can be one of the following: -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
filter |
-No. -If this parameter is not specified, then all patterns that are inside the child <ObjectSet> element will be processed. |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
StringContent |
- Yes |
- The string to check against. |
-
CompareType |
- Yes |
- A string. Use one of the following values: -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
attributes |
-Yes |
-Specifies the attributes to be included with a migrated object. You can specify one of the following, or both separated by quotes; for example,
|
-
| Setting | -Required? | -Value | -
|---|---|---|
type |
-Yes |
-typeID can be Registry or File. |
-
ObjectLocation |
-Yes |
-The location of the object. |
-
| Setting | -Required? | -Value | -
|---|---|---|
script |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectEncodedLocation |
- Yes |
- The destination location for all of the source objects. |
-
| Setting | -Required? | -Value | -
|---|---|---|
DestinationRoot |
- Yes |
- The location where the source objects will be moved. If needed, this function will create any subdirectories that were above the longest CSIDL in the source object name. |
-
| Setting | -Required? | -Value | -
|---|---|---|
SourceRoot |
- Yes |
- The location from where the objects will be moved. Any source objects that are enumerated by the parent <ObjectSet> element that are not in this location will not be moved. |
-
DestinationRoot |
- Yes |
- The location where the source objects will be moved to on the destination computer. If needed, this function will create any subdirectories that were above SourceRoot. |
-
| Setting | -Required? | -Value | -
|---|---|---|
Name |
-Yes |
-The name of the manufacturer for the component. |
-
| Setting | -Required? | -Value | -
|---|---|---|
script |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
-
| Setting | -Required? | -Value | -
|---|---|---|
FilePattern |
- Yes |
-
For example, |
-
| Setting | -Required? | -Value | -
|---|---|---|
VersionTag |
- Yes |
- The version field that will be checked. This can be "FileVersion" or "ProductVersion". The file with the highest VersionTag version determines which conflicts will be resolved based on the file's version. For example, if Myfile.txt contains FileVersion 1 and the same file on the destination computer contains FileVersion 2, the file on destination will remain. |
-
| Setting | -Required? | -Value | -
|---|---|---|
urlid |
-Yes |
-UrlID is a string identifier that uniquely identifies this .xml file. This parameter must be a no-colon-name as defined by the XML Namespaces specification. Each migration .xml file must have a unique urlid. If two migration .xml files have the same urlid, the second .xml file that is specified on the command line will not be processed. For more information about XML Namespaces, see Use XML Namespaces. |
-
Name |
-No |
-Although not required, it is good practice to use the name of the .xml file. |
-
| Helper Function | -MigXMLHelper.FileProperties (property, operator, valueToCompare) | -
|---|---|
Property |
-filesize, dateCreated, dateModified, dateAccessed |
-
Operator |
-range, neq, lte, lt, eq, gte, gt |
-
valueToCompare |
-The value we are comparing. For example: -Date: “2008/05/15-2005/05/17”, “2008/05/15” -Size: A numeral with B, KB, MB, or GB at the end. “5GB”, “1KB-1MB” |
-
| Setting | -Required? | -Value | -
|---|---|---|
type |
-Yes |
-typeID can be Registry, File, or Ini. If typeId is Ini, then you cannot have a space between Path and object. For example, the following is correct when type="Ini": -<pattern type="Ini">%WinAmp5InstPath%\Winamp.ini|WinAmp[keeponscreen]</pattern> |
-
Path [object] |
-Yes |
-A valid registry or file path pattern, followed by at least one space, followed by brackets [] that contain the object to be migrated. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
when |
-Yes |
-Indicates when the script should be run. This value can be one of the following: -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
role |
-Yes |
-Defines the role for the component. Role can be one of: -
You can either: -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-Yes, when <rules> is a child to <namedElements> -No, when <rules> is a child to any other element |
-When ID is specified, any child elements are not processed. Instead, any other <rules> elements with the same name that are declared within <namedElements> are processed. |
-
context |
-No -(default = UserAndSystem) |
-Defines the scope of this parameter — whether to process this component in the context of the specific user, across the entire operating system, or both. -The largest possible scope is set by the component element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it has a context of User. If <rules> had a context of System, it would act as though <rules> was not there. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
ScriptWithArguments |
-Yes |
-A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. -The return value that is required by <script> depends on the parent element. -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- The type of object. Can be Registry or Ini (for an .ini file). |
-
EncodedLocationPattern |
- Yes |
-
|
-
ExpandContent |
- No (default=TRUE) |
- Can be TRUE or FALSE. If FALSE, then the given location will not be expanded before it is returned. |
-
| Setting | -Required? | -Value | -
|---|---|---|
PatternSegment |
- Yes |
- The suffix of an encoded pattern. It will be concatenated with a drive specification, such as "c:", to form a complete encoded file pattern. For example, "* [*.doc]". PatternSegment cannot be an environment variable. |
-
DriveType |
- Yes |
- The drive type for which the patterns are to be generated. You can specify one of: -
|
-
| Setting | -Required? | -Value | -
|---|---|---|
ObjectType |
- Yes |
- Defines the object type. Can be File or Registry. |
-
EncodedLocationPattern |
- Yes |
- The location pattern. Environment variables are allowed. |
-
ProcessCurrentUser |
- Yes |
- Can be TRUE or FALSE. Indicates if the patterns should be generated for the current user. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ScanProgramFiles |
-No (default = FALSE) |
-Can be TRUE or FALSE. The ScanProgramFiles parameter determines whether or not the document finder scans the Program Files directory to gather registered file extensions for known applications. For example, when set to TRUE it will discover and migrate .jpg files under the Photoshop directory, if .jpg is a file extension registered to Photoshop. |
-
IncludePatterns |
-No (default = TRUE) |
-Can be TRUE or FALSE. TRUE will generate include patterns and can be added under the <include> element. FALSE will generate exclude patterns and can be added under the <exclude> element. |
-
SystemDrive |
-No (default = FALSE) |
-Can be TRUE or FALSE. If TRUE, restricts all patterns to the system drive. |
-
| Setting | -Value | -
|---|---|
NormalText |
-This is interpreted as normal text. |
-
| Setting | -Required? | -Value | -
|---|---|---|
name |
-Yes |
-ID is a string value that is the name used to reference the environment variable. We recommend that ID start with the component’s name to avoid namespace collisions. For example, if your component’s name is MyComponent, and you want a variable that is your component’s install path, you could specify |
-
remap |
-No, default = FALSE |
-Specifies whether to evaluate this environment variable as a remapping environment variable. Objects that are located in a path that is underneath this environment variable’s value are automatically moved to where the environment variable points on the destination computer. |
-
| Setting | -Required? | -Value | -
|---|---|---|
ComponentVersion |
-Yes |
-The version of the component, which can contain patterns. |
-
| Elements A-K | +Elements L-Z | +Helper functions | +
|---|---|---|
| + + + + + + + + + + + + + + + + + + + + + + + | ++ + + + + + + + + + + + + + + + + + + + + + | ++ + + + + + + | +
| Setting | +Required? | +Value | +
|---|---|---|
Content |
+Yes |
+The content depends on the type of object specified. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
string |
+No, default is No |
+Determines whether Content should be interpreted as a string or as bytes. |
+
expand |
+No (default = Yes |
+When the expand parameter is Yes, the content of the <bytes> element is first expanded in the context of the source computer and then interpreted. |
+
Content |
+Yes |
+Depends on the value of the string. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
CommandLineString |
+Yes |
+A valid command line. |
+
| Setting | +Required? | +Value | +
|---|---|---|
type |
+Yes |
+You can use the following to group settings, and define the type of the component. +
|
+
context |
+No +Default = UserAndSystem |
+Defines the scope of this parameter; that is, whether to process this component in the context of the specific user, across the entire operating system, or both. +The largest possible scope is set by the <component> element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it has a context of User. If a <rules> element has a context of System, it would act as though the <rules> element is not there. +
|
+
defaultSupported |
+No +(default = TRUE) |
+Can be any of TRUE, FALSE, YES or NO. If this parameter is FALSE (or NO), the component will not be migrated unless there is an equivalent component on the destination computer. +When type="System" and defaultSupported="FALSE" the settings will not migrate unless there is an equivalent component in the .xml files that are specified on the LoadState command line. For example, the default MigSys.xml file contains components with type="System" and defaultSupported="FALSE". If you specify this file on the ScanState command line, you must also specify the file on the LoadState command line for the settings to migrate. This is because the LoadState tool must detect an equivalent component. That is, the component must have the same migration urlid of the .xml file and an identical display name or the LoadState tool will not migrate those settings from the store. This is helpful when the source computer is running Windows XP, and you are migrating to both Windows Vista and Windows XP because you can use the same store for both destination computers. |
+
hidden |
+
|
+This parameter is for internal USMT use only. |
+
| Setting | +Required? | +Value | +
|---|---|---|
negation |
+No +Default = No |
+"Yes" reverses the True/False value of the condition. |
+
ScriptName |
+Yes |
+A script that has been defined within this migration section. |
+
| Setting | +Required? | +Value | +
|---|---|---|
OSType |
+ Yes |
+ The only valid value for this setting is NT. Note, however, that you must set this setting for the <condition> functions to work correctly. |
+
OSVersion |
+ Yes |
+ The major version, minor version, build number and corrected service diskette version separated by periods. For example, |
+
| Setting | +Required? | +Value | +
|---|---|---|
OSType |
+ Yes |
+ Can be 9x or NT. If OSType does not match the type of the current operating system, then it returns FALSE. For example, if the current operating system is Windows NT-based and OSType is “9x”, the result will be FALSE. |
+
OSVersion |
+ Yes |
+ The major version, minor version, build number, and corrected service diskette version separated by periods. For example, The IsOSLaterThan function returns TRUE if the current operating system is later than or equal to OSVersion. |
+
| Setting | +Required? | +Value | +
|---|---|---|
OSType |
+ Yes |
+ Can be 9x or NT. If OSType does not match the type of the current operating system, then it returns FALSE. For example, if the current operating system is Windows NT-based and OSType is “9x” the result will be FALSE. |
+
OSVersion |
+ Yes |
+ The major version, minor version, build number, and corrected service diskette version separated by periods. For example, The IsOSEarlierThan function returns TRUE if the current operating system is earlier than OSVersion. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ Defines the object type. Can be File or Registry. |
+
EncodedLocationPattern |
+ Yes |
+ The location pattern. Environment variables are allowed. |
+
| Setting | +Required? | +Value | +
|---|---|---|
EncodedFileLocation |
+ Yes |
+ The location pattern for the file that will be checked. Environment variables are allowed. |
+
VersionTag |
+ Yes |
+ The version tag value that will be checked. |
+
VersionValue |
+ Yes |
+ A string pattern. For example, "Microsoft*". |
+
| Setting | +Required? | +Value | +
|---|---|---|
EncodedFileLocation |
+ Yes |
+ The location pattern for the file that will be checked. Environment variables are allowed. |
+
VersionTag |
+ Yes |
+ The version tag value that will be checked. |
+
VersionValue |
+ Yes |
+ The value to compare to. You cannot specify a pattern. |
+
| Setting | +Required? | +Value | +
|---|---|---|
EncodedFileLocation |
+ Yes |
+ The location pattern for the file that will be checked. Environment variables are allowed. |
+
VersionTag |
+ Yes |
+ The version tag value that will be checked. |
+
VersionValue |
+ Yes |
+ The value to compare to. You cannot specify a pattern. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ Defines the type of object. Can be File or Registry. |
+
EncodedLocationPattern |
+ Yes |
+ The encoded location for the object that will be examined. You can specify environment variables. |
+
StringContent |
+ Yes |
+ The string that will be checked against. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ Defines the type of object. Can be File or Registry. |
+
EncodedLocationPattern |
+ Yes |
+ The encoded location for the object that will be examined. You can specify environment variables. |
+
StrToFind |
+ Yes |
+ A string that will be searched inside the content of the given object. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ Defines the type of object. Can be File or Registry. |
+
EncodedLocation1 |
+ Yes |
+ The encoded location for the first object. You can specify environment variables. |
+
EncodedLocation2 |
+ Yes |
+ The encoded location for the second object. You can specify environment variables. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType1 |
+ Yes |
+ Defines the type of the first object. Can be File or Registry. |
+
EncodedLocation1 |
+ Yes |
+ The encoded location for the first object. You can specify environment variables. |
+
ObjectType2 |
+ Yes |
+ Defines the type of the second object. Can be File or Registry. |
+
EncodedLocation2 |
+ Yes |
+ The encoded location for the second object. You can specify environment variables. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType1 |
+ Yes |
+ Defines the type of the first object. Can be File or Registry. |
+
EncodedLocation1 |
+ Yes |
+ The encoded location for the first object. You can specify environment variables. |
+
ObjectType2 |
+ Yes |
+ Defines the type of the second object. Can be File or Registry. |
+
EncodedLocation2 |
+ Yes |
+ The encoded location for the second object. You can specify environment variables. |
+
| Setting | +Required? | +Value | +
|---|---|---|
operation |
+No, default = AND |
+Defines the Boolean operation that is performed on the results that are obtained from the child elements. |
+
| Setting | +Required? | +Value | +
|---|---|---|
filter |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script is called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Separators |
+ Yes |
+ A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. You can specify NULL. |
+
PathHints |
+ Yes |
+ A list of extra paths, separated by colons (;), where the function will look for a file matching the current content. For example, if the content is "Notepad.exe" and the path is the %Path% environment variable, the function will find Notepad.exe in %windir% and returns "c:\Windows [Notepad.exe]". You can specify NULL. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Separators |
+ Yes |
+ A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. This parameter must be NULL when processing MULTI-SZ registry values. |
+
PathHints |
+ Yes |
+ A list of extra paths, separated by colons (;), where the function will look for a file matching the current content. For example, if the content is "Notepad.exe" and the path is the %Path% environment variable, the function will find Notepad.exe in %windir% and returns "c:\Windows [Notepad.exe]". You can specify NULL. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Separators |
+ No |
+ A list of possible separators that might follow the file specification in this registry value name. For example, if the content is "C:\Windows\Notepad.exe,-2", the separator is a comma. You must specify NULL when processing MULTI-SZ registry values. |
+
LevelsToTrim |
+ Yes |
+ The number of levels to delete from the end of the directory specification. Use this function to extract a root directory when you have a registry value that points inside that root directory in a known location. |
+
PatternSuffix |
+ Yes |
+ The pattern to add to the directory specification. For example, |
+
| Setting | +Required? | +Value | +
|---|---|---|
script |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
DefaultValueOnError |
+ No |
+ The value that will be written into the value name if the conversion fails. You can specify NULL, and 0 will be written if the conversion fails. |
+
| Setting | +Required? | +Value | +
|---|---|---|
DefaultValueOnError |
+ No |
+ The value that will be written into the value name if the conversion fails. You can specify NULL, and 0 will be written if the conversion fails. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Value |
+ Yes |
+ The string representation of a numeric value. It can be positive or negative. For example, |
+
| Setting | +Required? | +Value | +
|---|---|---|
SourceTable |
+ Yes |
+ A list of values separated by commas that are possible for the source registry values. |
+
DestinationTable |
+ No |
+ A list of translated values separated by commas. |
+
DefaultValueOnError |
+ No |
+ The value that will be applied to the destination computer if either 1) the value for the source computer does not match SourceTable, or 2) DestinationTable has no equivalent value. +If DefaultValueOnError is NULL, the value will not be changed on the destination computer. |
+
| Setting | +Required? | +Value | +
|---|---|---|
OptionString |
+ Yes |
+ OptionString can be Security, TimeFields, or FileAttrib:Letter. You can specify one of each type of OptionStrings. Do not specify multiple OptionStrings with the same value. If you do, the right-most option of that type will be kept. For example, do not specify ("FileAttrib:H", "FileAttrib:R") because only Read-only will be evaluated. Instead specify ("FileAttrib:HR") and both Hidden and Read-only attributes will be kept on the destination computer. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
Instruction |
+ Yes |
+ Can be one of the following: +
|
+
String |
+ Yes |
+ The string to be added or removed. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Delimiters |
+ Yes |
+ A single character that will be used to separate the content of the object that is being processed. The content will be considered as a list of elements that is separated by the Delimiters. +For example, "." will separate the string based on a period. |
+
Instruction |
+ Yes |
+ Can one of the following: +
|
+
String |
+ Yes |
+ The string to be added or removed. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ComponentDescription |
+Yes |
+The description of the component. |
+
| Setting | +Required? | +Value | +
|---|---|---|
filter |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+Yes, when <detect> is a child to <namedElements> +No, when <detect> is a child to <detects> |
+When ID is specified, any child elements are not processed. Instead, any other <detect> elements with the same name that are declared within the <namedElements> element are processed. |
+
context |
+No +(default = UserAndSystem) |
+Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. +The largest possible scope is set by the component element. For example, if a <component> element has a context of User, and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though the <rules> element were not there. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+Yes, when <detects> is a child to <namedElements> +No, when <detects> is a child to <role> or <rules> |
+When ID is specified, no child <detect> elements are processed. Instead, any other <detects> elements with the same name that are declared within the <namedElements> element are processed. |
+
context |
+No +(default = UserAndSystem) |
+Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. +The largest possible scope is set by the <component element>. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though the <rules> element were not there. +
The context parameter is ignored for <detects> elements that are inside <rules> elements. |
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+
|
+If declared, the content of the <detection> element is ignored and the content of the <detection> element with the same name that is declared in the <namedElements> element will be evaluated. |
+
context |
+No, default = UserAndSystem |
+Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
locID |
+No |
+This parameter is for internal USMT use. Do not use this parameter. |
+
ComponentName |
+Yes |
+The name for the component. |
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+Yes, when <environment> is a child of <namedElements> +No, when <environment> is a child of <role> or <component> |
+When declared as a child of the <role> or <component> elements, if ID is declared, USMT ignores the content of the <environment> element and the content of the <environment> element with the same name declared in the <namedElements> element is processed. |
+
context |
+No +(default = UserAndSystem) |
+Defines the scope of this parameter: whether to process this component in the context of the specific user, across the entire operating system, or both. +The largest possible scope is set by the <component> element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it had a context of User. If the <rules> element had a context of System, it would act as though <rules> were not there. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
filter |
+No +(default = No) |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Parameter | +Required? | +Value | +
|---|---|---|
attributes |
+Yes |
+Specifies the attributes to be excluded. You can specify one of the following, or both separated by quotes; for example,
|
+
| Setting | +Required? | +Value | +
|---|---|---|
FilenameExtension |
+Yes |
+A file name extension. |
+
| Setting | +Required? | +Value | +
|---|---|---|
when |
+Yes |
+Indicates when the command line should be run. This value can be one of the following: +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
filter |
+No. +If this parameter is not specified, then all patterns that are inside the child <ObjectSet> element will be processed. |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
StringContent |
+ Yes |
+ The string to check against. |
+
CompareType |
+ Yes |
+ A string. Use one of the following values: +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
attributes |
+Yes |
+Specifies the attributes to be included with a migrated object. You can specify one of the following, or both separated by quotes; for example,
|
+
| Setting | +Required? | +Value | +
|---|---|---|
type |
+Yes |
+typeID can be Registry or File. |
+
ObjectLocation |
+Yes |
+The location of the object. |
+
| Setting | +Required? | +Value | +
|---|---|---|
script |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the include rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectEncodedLocation |
+ Yes |
+ The destination location for all of the source objects. |
+
| Setting | +Required? | +Value | +
|---|---|---|
DestinationRoot |
+ Yes |
+ The location where the source objects will be moved. If needed, this function will create any subdirectories that were above the longest CSIDL in the source object name. |
+
| Setting | +Required? | +Value | +
|---|---|---|
SourceRoot |
+ Yes |
+ The location from where the objects will be moved. Any source objects that are enumerated by the parent <ObjectSet> element that are not in this location will not be moved. |
+
DestinationRoot |
+ Yes |
+ The location where the source objects will be moved to on the destination computer. If needed, this function will create any subdirectories that were above SourceRoot. |
+
| Setting | +Required? | +Value | +
|---|---|---|
Name |
+Yes |
+The name of the manufacturer for the component. |
+
| Setting | +Required? | +Value | +
|---|---|---|
script |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. |
+
| Setting | +Required? | +Value | +
|---|---|---|
FilePattern |
+ Yes |
+
For example, |
+
| Setting | +Required? | +Value | +
|---|---|---|
VersionTag |
+ Yes |
+ The version field that will be checked. This can be "FileVersion" or "ProductVersion". The file with the highest VersionTag version determines which conflicts will be resolved based on the file's version. For example, if Myfile.txt contains FileVersion 1 and the same file on the destination computer contains FileVersion 2, the file on destination will remain. |
+
| Setting | +Required? | +Value | +
|---|---|---|
urlid |
+Yes |
+UrlID is a string identifier that uniquely identifies this .xml file. This parameter must be a no-colon-name as defined by the XML Namespaces specification. Each migration .xml file must have a unique urlid. If two migration .xml files have the same urlid, the second .xml file that is specified on the command line will not be processed. For more information about XML Namespaces, see Use XML Namespaces. |
+
Name |
+No |
+Although not required, it is good practice to use the name of the .xml file. |
+
| Helper Function | +MigXMLHelper.FileProperties (property, operator, valueToCompare) | +
|---|---|
Property |
+filesize, dateCreated, dateModified, dateAccessed |
+
Operator |
+range, neq, lte, lt, eq, gte, gt |
+
valueToCompare |
+The value we are comparing. For example: +Date: “2008/05/15-2005/05/17”, “2008/05/15” +Size: A numeral with B, KB, MB, or GB at the end. “5GB”, “1KB-1MB” |
+
| Setting | +Required? | +Value | +
|---|---|---|
type |
+Yes |
+typeID can be Registry, File, or Ini. If typeId is Ini, then you cannot have a space between Path and object. For example, the following is correct when type="Ini": +<pattern type="Ini">%WinAmp5InstPath%\Winamp.ini|WinAmp[keeponscreen]</pattern> |
+
Path [object] |
+Yes |
+A valid registry or file path pattern, followed by at least one space, followed by brackets [] that contain the object to be migrated. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
when |
+Yes |
+Indicates when the script should be run. This value can be one of the following: +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
role |
+Yes |
+Defines the role for the component. Role can be one of: +
You can either: +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+Yes, when <rules> is a child to <namedElements> +No, when <rules> is a child to any other element |
+When ID is specified, any child elements are not processed. Instead, any other <rules> elements with the same name that are declared within <namedElements> are processed. |
+
context |
+No +(default = UserAndSystem) |
+Defines the scope of this parameter — whether to process this component in the context of the specific user, across the entire operating system, or both. +The largest possible scope is set by the component element. For example, if a <component> element has a context of User and a <rules> element had a context of UserAndSystem, then the <rules> element would act as though it has a context of User. If <rules> had a context of System, it would act as though <rules> was not there. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
ScriptWithArguments |
+Yes |
+A script followed by any number of string arguments that are separated by a comma and enclosed in parenthesis. For example The script will be called for each object that is enumerated by the object sets in the <include> rule. The filter script returns a Boolean value. If the return value is TRUE, the object will be migrated. If it is FALSE, it will not be migrated. +The return value that is required by <script> depends on the parent element. +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ The type of object. Can be Registry or Ini (for an .ini file). |
+
EncodedLocationPattern |
+ Yes |
+
|
+
ExpandContent |
+ No (default=TRUE) |
+ Can be TRUE or FALSE. If FALSE, then the given location will not be expanded before it is returned. |
+
| Setting | +Required? | +Value | +
|---|---|---|
PatternSegment |
+ Yes |
+ The suffix of an encoded pattern. It will be concatenated with a drive specification, such as "c:", to form a complete encoded file pattern. For example, "* [*.doc]". PatternSegment cannot be an environment variable. |
+
DriveType |
+ Yes |
+ The drive type for which the patterns are to be generated. You can specify one of: +
|
+
| Setting | +Required? | +Value | +
|---|---|---|
ObjectType |
+ Yes |
+ Defines the object type. Can be File or Registry. |
+
EncodedLocationPattern |
+ Yes |
+ The location pattern. Environment variables are allowed. |
+
ProcessCurrentUser |
+ Yes |
+ Can be TRUE or FALSE. Indicates if the patterns should be generated for the current user. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ScanProgramFiles |
+No (default = FALSE) |
+Can be TRUE or FALSE. The ScanProgramFiles parameter determines whether or not the document finder scans the Program Files directory to gather registered file extensions for known applications. For example, when set to TRUE it will discover and migrate .jpg files under the Photoshop directory, if .jpg is a file extension registered to Photoshop. |
+
IncludePatterns |
+No (default = TRUE) |
+Can be TRUE or FALSE. TRUE will generate include patterns and can be added under the <include> element. FALSE will generate exclude patterns and can be added under the <exclude> element. |
+
SystemDrive |
+No (default = FALSE) |
+Can be TRUE or FALSE. If TRUE, restricts all patterns to the system drive. |
+
| Setting | +Value | +
|---|---|
NormalText |
+This is interpreted as normal text. |
+
| Setting | +Required? | +Value | +
|---|---|---|
name |
+Yes |
+ID is a string value that is the name used to reference the environment variable. We recommend that ID start with the component’s name to avoid namespace collisions. For example, if your component’s name is MyComponent, and you want a variable that is your component’s install path, you could specify |
+
remap |
+No, default = FALSE |
+Specifies whether to evaluate this environment variable as a remapping environment variable. Objects that are located in a path that is underneath this environment variable’s value are automatically moved to where the environment variable points on the destination computer. |
+
| Setting | +Required? | +Value | +
|---|---|---|
ComponentVersion |
+Yes |
+The version of the component, which can contain patterns. |
+
| What's new | Windows Autopilot is always being updated with new features! Check this topic to read about the latests capabilities. - |
| Overview of Windows Autopilot | A review of Windows Autopilot is provided with a video walkthrough. Benefits and general requirements are discussed. - |
| Requirements | Detailed software, network, licensiing, and configuration requirments are provided. - |
| Scenarios and Capabilities | A summary of Windows Autopilot deployment scenarios and capabilities. - |
| Get started | Interested in trying out Autopilot? See this step-by-step walkthrough to test Windows Autopilot on a virtual machine or physical device with a free 30-day trial premium Intune account. - |
| User-driven mode | Requirements and validation steps for deploying a new Azure Active Directory (AAD) joined or hybrid AAD-joined Windows 10 device are provided. - |
| Self-deploying mode | Requirements and validation steps for deploying a new Windows 10 device with little to no user interaction are provided. - |
| Windows Autopilot Reset | Using Windows Autopilot Reset, a device can be restored to its original settings, taking it back to a business-ready state. Both local and remote reset scenarios are discussed. - |
| Windows Autopilot for white glove deployment | Requirements and procedures are described that enable additional policies and apps to be delivered to a Windows Autopilot device. - |
| Support for existing devices | This topic describes how Windows Autopilot can be used to convert Windows 7 or Windows 8.1 domain-joined computers to AAD-joined computers running Windows 10. - |
| Registering devices | The process of registering a device with the Windows Autopilot deployment service is described. - |
| Configuring device profiles | The device profile settings that specifie its behavior when it is deployed are described. - |
| Enrollment status page | Settings that are available on the Enrollment Status Page are described. - |
| Bitlocker encryption | Available options for configuring BitLocker on Windows Autopilot devices are described. - |
| Troubleshooting Windows Autopilot | Diagnotic event information and troubleshooting procedures are provided. - |
| Known issues | A list of current known issues and solutions is provided. - |
| FAQ | Frequently asked questions on several topics are provided. - |
| Support contacts | Support information is provided. - |
| Registration authorization | This article discusses how a CSP partner or OEM can obtain customer authorization to register Windows Autopilot devices. - |
| Motherboard replacement | Information about how to deal with Autopilot registration and device repair issues is provided. - |
| What's new | Windows Autopilot is always being updated with new features! Check this topic to read about the latests capabilities. + |
| Overview of Windows Autopilot | A review of Windows Autopilot is provided with a video walkthrough. Benefits and general requirements are discussed. + |
| Requirements | Detailed software, network, licensiing, and configuration requirments are provided. + |
| Scenarios and Capabilities | A summary of Windows Autopilot deployment scenarios and capabilities. + |
| Get started | Interested in trying out Autopilot? See this step-by-step walkthrough to test Windows Autopilot on a virtual machine or physical device with a free 30-day trial premium Intune account. + |
| User-driven mode | Requirements and validation steps for deploying a new Azure Active Directory (AAD) joined or hybrid AAD-joined Windows 10 device are provided. + |
| Self-deploying mode | Requirements and validation steps for deploying a new Windows 10 device with little to no user interaction are provided. + |
| Windows Autopilot Reset | Using Windows Autopilot Reset, a device can be restored to its original settings, taking it back to a business-ready state. Both local and remote reset scenarios are discussed. + |
| Windows Autopilot for white glove deployment | Requirements and procedures are described that enable additional policies and apps to be delivered to a Windows Autopilot device. + |
| Support for existing devices | This topic describes how Windows Autopilot can be used to convert Windows 7 or Windows 8.1 domain-joined computers to AAD-joined computers running Windows 10. + |
| Registering devices | The process of registering a device with the Windows Autopilot deployment service is described. + |
| Configuring device profiles | The device profile settings that specifie its behavior when it is deployed are described. + |
| Enrollment status page | Settings that are available on the Enrollment Status Page are described. + |
| BitLocker encryption | Available options for configuring BitLocker on Windows Autopilot devices are described. + |
| Troubleshooting Windows Autopilot | Diagnotic event information and troubleshooting procedures are provided. + |
| Known issues | A list of current known issues and solutions is provided. + |
| FAQ | Frequently asked questions on several topics are provided. + |
| Support contacts | Support information is provided. + |
| Registration authorization | This article discusses how a CSP partner or OEM can obtain customer authorization to register Windows Autopilot devices. + |
| Motherboard replacement | Information about how to deal with Autopilot registration and device repair issues is provided. + |