diff --git a/windows/deployment/usmt/usmt-requirements.md b/windows/deployment/usmt/usmt-requirements.md index 9134680979..5df90fe4bb 100644 --- a/windows/deployment/usmt/usmt-requirements.md +++ b/windows/deployment/usmt/usmt-requirements.md @@ -16,10 +16,8 @@ ms.topic: article # USMT Requirements - ## In This Topic - - [Supported Operating Systems](#bkmk-1) - [Windows PE](#windows-pe) - [Credentials](#credentials) @@ -30,63 +28,21 @@ ms.topic: article ## Supported Operating Systems - The User State Migration Tool (USMT) 10.0 does not have any explicit RAM or CPU speed requirements for either the source or destination computers. If your computer complies with the system requirements of the operating system, it also complies with the requirements for USMT. You need an intermediate store location large enough to hold all of the migrated data and settings, and the same amount of hard disk space on the destination computer for the migrated files and settings. The following table lists the operating systems supported in USMT. -
Operating Systems | -ScanState (source computer) | -LoadState (destination computer) | -
---|---|---|
32-bit versions of Windows 7 |
-X |
-X |
-
64-bit versions of Windows 7 |
-X |
-X |
-
32-bit versions of Windows 8 |
-X |
-X |
-
64-bit versions of Windows 8 |
-X |
-X |
-
32-bit versions of Windows 10 |
-X |
-X |
-
64-bit versions of Windows 10 |
-X |
-X |
-
Return code value | -Return code | -Error message | -Troubleshooting, mitigation, workarounds | -Category | -
---|---|---|---|---|
0 |
-USMT_SUCCESS |
-Successful run |
-Not applicable |
-Success or Cancel |
-
1 |
-USMT_DISPLAY_HELP |
-Command line help requested |
-Not applicable |
-Success or Cancel |
-
2 |
-USMT_STATUS_CANCELED |
-Gather was aborted because of an EFS file |
-Not applicable |
-- |
- | - | User chose to cancel (such as pressing CTRL+C) |
-Not applicable |
-Success or Cancel |
-
3 |
-USMT_WOULD_HAVE_FAILED |
-At least one error was skipped as a result of /c |
-Review ScanState, LoadState, or UsmtUtils log for details about command-line errors. |
-- |
11 |
-USMT_INVALID_PARAMETERS |
-/all conflicts with /ui, /ue or /uel |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /auto expects an optional parameter for the script folder |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /encrypt can't be used with /nocompress |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /encrypt requires /key or /keyfile |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /genconfig can't be used with most other options |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /genmigxml can't be used with most other options |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /hardlink requires /nocompress |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /key and /keyfile both specified |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /key or /keyfile used without enabling encryption |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /lae is only used with /lac |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /listfiles cannot be used with /p |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /offline requires a valid path to an XML file describing offline paths |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /offlinewindir requires a valid path to offline windows folder |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | /offlinewinold requires a valid path to offline windows folder |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | A command was already specified |
-Verify that the command-line syntax is correct and that there are no duplicate commands. |
-- |
- | - | An option argument is missing |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | An option is specified more than once and is ambiguous |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | By default /auto selects all users and uses the highest log verbosity level. Switches like /all, /ui, /ue, /v are not allowed. |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Command line arguments are required. Specify /? for options. |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Command line option is not valid |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | EFS parameter specified is not valid for /efs |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | File argument is invalid for /genconfig |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | File argument is invalid for /genmigxml |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Invalid space estimate path. Check the parameters and/or file system permissions |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | List file path argument is invalid for /listfiles |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Retry argument must be an integer |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Settings store argument specified is invalid |
-Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set. |
-- |
- | - | Specified encryption algorithm is not supported |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | The /efs:hardlink requires /hardlink |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | The /targetWindows7 option is only available for Windows XP, Windows Vista, and Windows 7 |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | The store parameter is required but not specified |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | The source-to-target domain mapping is invalid for /md |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | The source-to-target user account mapping is invalid for /mu |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Undefined or incomplete command line option |
-Review ScanState log or LoadState log for details about command-line errors. |
-Invalid Command Lines |
-
- | - | Use /nocompress, or provide an XML file path with /p"pathtoafile" to get a compressed store size estimate |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | User exclusion argument is invalid |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Verbosity level must be specified as a sum of the desired log options: Verbose (0x01), Record Objects (0x04), Echo to debug port (0x08) |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Volume shadow copy feature is not supported with a hardlink store |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
- | - | Wait delay argument must be an integer |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
12 |
-USMT_ERROR_OPTION_PARAM_TOO_LARGE |
-Command line arguments cannot exceed 256 characters |
-Review ScanState log or LoadState log for details about command-line errors. |
-Invalid Command Lines |
-
- | - | Specified settings store path exceeds the maximum allowed length of 256 characters |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
13 |
-USMT_INIT_LOGFILE_FAILED |
-Log path argument is invalid for /l |
-When /l is specified in the ScanState command line, USMT validates the path. Verify that the drive and other information, for example file system characters, are correct. |
-Invalid Command Lines |
-
14 |
-USMT_ERROR_USE_LAC |
-Unable to create a local account because /lac was not specified |
-When creating local accounts, the command-line options /lac and /lae should be used. |
-Invalid Command Lines |
-
26 |
-USMT_INIT_ERROR |
-Multiple Windows installations found |
-Listfiles.txt could not be created. Verify that the location you specified for the creation of this file is valid. |
-Setup and Initialization |
-
- | - | Software malfunction or unknown exception |
-Check all loaded .xml files for errors, common error when using /I to load the Config.xml file. |
-- |
- | - | Unable to find a valid Windows directory to proceed with requested offline operation; Check if offline input file is present and has valid entries |
-Verify that the offline input file is present and that it has valid entries. USMT could not find valid offline operating system. Verify your offline directory mapping. |
-- |
27 |
-USMT_INVALID_STORE_LOCATION |
-A store path can't be used because an existing store exists; specify /o to overwrite |
-Specify /o to overwrite an existing intermediate or migration store. |
-Setup and Initialization |
-
- | - | A store path is missing or has incomplete data |
-Make sure that the store path is accessible and that the proper permission levels are set. |
-- |
- | - | An error occurred during store creation |
-Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store. |
-- |
- | - | An inappropriate device such as a floppy disk was specified for the store |
-Make sure that the store path is accessible and that the proper permission levels are set. |
-- |
- | - | Invalid store path; check the store parameter and/or file system permissions |
-Invalid store path; check the store parameter and/or file system permissions |
-- |
- | - | The file layout and/or file content is not recognized as a valid store |
-Make sure that the store path is accessible and that the proper permission levels are set. Specify /o to overwrite an existing intermediate or migration store. |
-- |
- | - | The store path holds a store incompatible with the current USMT version |
-Make sure that the store path is accessible and that the proper permission levels are set. |
-- |
- | - | The store save location is read-only or does not support a requested storage option |
-Make sure that the store path is accessible and that the proper permission levels are set. |
-- |
28 |
-USMT_UNABLE_GET_SCRIPTFILES |
-Script file is invalid for /i |
-Check all specified migration .xml files for errors. This is a common error when using /i to load the Config.xml file. |
-Setup and Initialization |
-
- | - | Unable to find a script file specified by /i |
-Verify the location of your script files, and ensure that the command-line options are correct. |
-- |
29 |
-USMT_FAILED_MIGSTARTUP |
-A minimum of 250 MB of free space is required for temporary files |
-Verify that the system meets the minimum temporary disk space requirement of 250 MB. As a workaround, you can set the environment variable USMT_WORKING_DIR=<path> to redirect the temporary files working directory. |
-Setup and Initialization |
-
- | - | Another process is preventing migration; only one migration tool can run at a time |
-Check the ScanState log file for migration .xml file errors. |
-- |
- | - | Failed to start main processing, look in log for system errors or check the installation |
-Check the ScanState log file for migration .xml file errors. |
-- |
- | - | Migration failed because of an XML error; look in the log for specific details |
-Check the ScanState log file for migration .xml file errors. |
-- |
- | - | Unable to automatically map the drive letters to match the online drive letter layout; Use /offline to provide a mapping table |
-Check the ScanState log file for migration .xml file errors. |
-- |
31 |
-USMT_UNABLE_FINDMIGUNITS |
-An error occurred during the discover phase; the log should have more specific information |
-Check the ScanState log file for migration .xml file errors. |
-Setup and Initialization |
-
32 |
-USMT_FAILED_SETMIGRATIONTYPE |
-An error occurred processing the migration system |
-Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line. |
-Setup and Initialization |
-
33 |
-USMT_UNABLE_READKEY |
-Error accessing the file specified by the /keyfile parameter |
-Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line. |
-Setup and Initialization |
-
- | - | The encryption key must have at least one character |
-Check the ScanState log file for migration .xml file errors, or use online Help by typing /? on the command line. |
-- |
34 |
-USMT_ERROR_INSUFFICIENT_RIGHTS |
-Directory removal requires elevated privileges |
-Log on as Administrator, and run with elevated privileges. |
-Setup and Initialization |
-
- | - | No rights to create user profiles; log in as Administrator; run with elevated privileges |
-Log on as Administrator, and run with elevated privileges. |
-- |
- | - | No rights to read or delete user profiles; log in as Administrator, run with elevated privileges |
-Log on as Administrator, and run with elevated privileges. |
-- |
35 |
-USMT_UNABLE_DELETE_STORE |
-A reboot is required to remove the store |
-Reboot to delete any files that could not be deleted when the command was executed. |
-Setup and Initialization |
-
- | - | A store path can't be used because it contains data that could not be overwritten |
-A migration store could not be deleted. If you are using a hardlink migration store you might have a locked file in it. You should manually delete the store, or use USMTUtils /rd command to delete the store. |
-- |
- | - | There was an error removing the store |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
36 |
-USMT_ERROR_UNSUPPORTED_PLATFORM |
-Compliance check failure; please check the logs for details |
-Investigate whether there is an active temporary profile on the system. |
-Setup and Initialization |
-
- | - | Use of /offline is not supported during apply |
-The /offline command was not used while running in the Windows Preinstallation Environment (WinPE). |
-- |
- | - | Use /offline to run gather on this platform |
-The /offline command was not used while running in WinPE. |
-- |
37 |
-USMT_ERROR_NO_INVALID_KEY |
-The store holds encrypted data but the correct encryption key was not provided |
-Verify that you have included the correct encryption /key or /keyfile. |
-Setup and Initialization |
-
38 |
-USMT_ERROR_CORRUPTED_NOTENCRYPTED_STORE |
-An error occurred during store access |
-Review ScanState log or LoadState log for details about command-line errors. Make sure that the store path is accessible and that the proper permission levels are set. |
-Setup and Initialization |
-
39 |
-USMT_UNABLE_TO_READ_CONFIG_FILE |
-Error reading Config.xml |
-Review ScanState log or LoadState log for details about command-line errors in the Config.xml file. |
-Setup and Initialization |
-
- | - | File argument is invalid for /config |
-Check the command line you used to load the Config.xml file. You can use online Help by typing /? on the command line. |
-- |
40 |
-USMT_ERROR_UNABLE_CREATE_PROGRESS_LOG |
-Error writing to the progress log |
-The Progress log could not be created. Verify that the location is valid and that you have write access. |
-Setup and Initialization |
-
- | - | Progress log argument is invalid for /progress |
-The Progress log could not be created. Verify that the location is valid and that you have write access. |
-- |
41 |
-USMT_PREFLIGHT_FILE_CREATION_FAILED |
-Can't overwrite existing file |
-The Progress log could not be created. Verify that the location is valid and that you have write access. |
-Setup and Initialization |
-
- | - | Invalid space estimate path. Check the parameters and/or file system permissions |
-Review ScanState log or LoadState log for details about command-line errors. |
-- |
42 |
-USMT_ERROR_CORRUPTED_STORE |
-The store contains one or more corrupted files |
-Review UsmtUtils log for details about the corrupted files. For information on how to extract the files that are not corrupted, see Extract Files from a Compressed USMT Migration Store. |
-- |
61 |
-USMT_MIGRATION_STOPPED_NONFATAL |
-Processing stopped due to an I/O error |
-USMT exited but can continue with the /c command-line option, with the optional configurable <ErrorControl> section or by using the /vsc command-line option. |
-Non-fatal Errors |
-
71 |
-USMT_INIT_OPERATING_ENVIRONMENT_FAILED |
-A Windows Win32 API error occurred |
-Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details. |
-Fatal Errors |
-
- | - | An error occurred when attempting to initialize the diagnostic mechanisms such as the log |
-Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
- | - | Failed to record diagnostic information |
-Data transfer has begun, and there was an error during the creation of migration store or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
- | - | Unable to start. Make sure you are running USMT with elevated privileges |
-Exit USMT and log in again with elevated privileges. |
-- |
72 |
-USMT_UNABLE_DOMIGRATION |
-An error occurred closing the store |
-Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
-Fatal Errors |
-
- | - | An error occurred in the apply process |
-Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
- | - | An error occurred in the gather process |
-Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
- | - | Out of disk space while writing the store |
-Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
- | - | Out of temporary disk space on the local system |
-Data transfer has begun, and there was an error during migration-store creation or during the apply phase. Review the ScanState log or LoadState log for details. |
-- |
Command-Line Option | -Description | -
---|---|
StorePath |
-Indicates a folder where files and settings will be saved. Note that StorePath cannot be C:\. You must specify the StorePath option in the ScanState command, except when using the /genconfig option. You cannot specify more than one StorePath location. |
-
/apps |
-Scans the image for apps and includes them and their associated registry settings. |
-
/ppkg [<FileName>] |
-Exports to a specific file location. |
-
/o |
-Required to overwrite any existing data in the migration store or Config.xml file. If not specified, the ScanState command will fail if the migration store already contains data. You cannot use this option more than once on a command line. |
-
/vsc |
-This option enables the volume shadow-copy service to migrate files that are locked or in use. This command-line option eliminates most file-locking errors that are typically encountered by the <ErrorControl> section. -This option can be used only with the ScanState executable file and cannot be combined with the /hardlink option. |
-
/hardlink |
-Enables the creation of a hard-link migration store at the specified location. The /nocompress option must be specified with the /hardlink option. |
-
/encrypt [{/key:<KeyString> | /keyfile:<file>]} |
-Encrypts the store with the specified key. Encryption is disabled by default. With this option, you will need to specify the encryption key-in one of the following ways: -
We recommend that KeyString be at least eight characters long, but it cannot exceed 256 characters. The /key and /keyfile options cannot be used on the same command line. The /encrypt and /nocompress options cannot be used on the same command line. -
-Important
-You should use caution with this option, because anyone who has access to the ScanState command-line script will also have access to the encryption key. -
-
-
-The following example shows the ScanState command and the /key option: -
|
-
/encrypt:<EncryptionStrength> |
-The /encrypt option accepts a command-line parameter to define the encryption strength to be used for encryption of the migration store. For more information about supported encryption algorithms, see Migration Store Encryption. |
-
/nocompress |
-Disables compression of data and saves the files to a hidden folder named "File" at StorePath\USMT. Compression is enabled by default. Combining the /nocompress option with the /hardlink option generates a hard-link migration store. You can use the uncompressed store to view what USMT stored, troubleshoot a problem, or run an antivirus utility against the files. You should use this option only in testing environments, because we recommend that you use a compressed store during your actual migration, unless you are combining the /nocompress option with the /hardlink option. -The /nocompress and /encrypt options cannot be used together in one statement on the command line. However, if you do choose to migrate an uncompressed store, the LoadState command will migrate each file directly from the store to the correct location on the destination computer without a temporary location. -For example: -
|
-
Command-Line Option | -Definition | -
---|---|
/offline:"path to an offline.xml file" |
-This option is used to define a path to an offline .xml file that might specify other offline migration options, for example, an offline Windows directory or any domain or folder redirection required in your migration. |
-
/offlinewindir:"path to a Windows directory" |
-This option specifies the offline Windows directory that the ScanState command gathers user state from. The offline directory can be Windows.old when you run the ScanState command in Windows or a Windows directory when you run the ScanState command in WinPE. |
-
/offlinewinold:"Windows.old directory" |
-This command-line option enables the offline migration mode and starts the migration from the location specified. It is only intended to be used in Windows.old migration scenarios, where the migration is occurring from a Windows.old directory. |
-
Command-Line Option | -Description | -||||||||
---|---|---|---|---|---|---|---|---|---|
/i:[Path]FileName |
-(include) -Specifies an .xml file that contains rules that define what user, application, or system state to migrate. You can specify this option multiple times to include all of your .xml files (MigApp.xml, MigDocs.xml, and any custom .xml files that you create). Path can be either a relative or full path. If you do not specify the Path variable, then FileName must be located in the current directory. For more information about which files to specify, see the "XML Files" section of the Frequently Asked Questions topic. |
-||||||||
/genconfig:[Path]FileName |
-(Generate Config.xml) -Generates the optional Config.xml file, but does not create a migration store. To ensure that this file contains every component, application and setting that can be migrated, you should create this file on a source computer that contains all the components, applications, and settings that will be present on the destination computers. In addition, you should specify the other migration .xml files, using the /i option, when you specify this option. -After you create this file, you will need to make use of it with the ScanState command using the /config option. -The only options that you can specify with this option are the /i, /v, and /l options. You cannot specify StorePath, because the /genconfig option does not create a store. Path can be either a relative or full path. If you do not specify the Path variable, then FileName will be created in the current directory. -Examples: -
|
-||||||||
/config:[Path</em>]FileName |
-Specifies the Config.xml file that the ScanState command should use to create the store. You cannot use this option more than once on the command line. Path can be either a relative or full path. If you do not specify the Path variable, then FileName must be located in the current directory. -The following example creates a store using the Config.xml file, MigDocs.xml, and MigApp.xml files: -
The following example migrates the files and settings to the destination computer using the Config.xml, MigDocs.xml, and MigApp.xml files: -
|
-||||||||
/auto:path to script files |
-This option enables you to specify the location of the default .xml files and then begin the migration. If no path is specified, USMT will reference the directory where the USMT binaries are located. The /auto option has the same effect as using the following options: /i: MigDocs.xml /i:MigApp.xml /v:5. |
-||||||||
/genmigxml:path to a file |
-This option specifies that the ScanState command should use the document finder to create and export an .xml file that defines how to migrate all of the files on the computer on which the ScanState command is running. |
-||||||||
/targetwindows8 |
-Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 8 or Windows 8.1 instead of Windows 10. You should use this command-line option in the following scenarios: -
|
-||||||||
/targetwindows7 |
-Optimizes Scanstate.exe when using USMT 10.0 to migrate a user state to Windows 7 instead of Windows 10. You should use this command-line option in the following scenarios: -
|
-||||||||
/localonly |
-Migrates only files that are stored on the local computer, regardless of the rules in the .xml files that you specify on the command line. You should use this option when you want to exclude the data from removable drives on the source computer, such as USB flash drives (UFDs), some external hard drives, and so on, and when there are network drives mapped on the source computer. If the /localonly option is not specified, then the ScanState command will copy files from these removable or network drives into the store. -Anything that is not considered a fixed drive by the OS will be excluded by /localonly. In some cases large external hard drives are considered fixed drives. These drives can be explicitly excluded from migration by using a custom.xml file. For more information about how to exclude all files on a specific drive, see Exclude Files and Settings. -The /localonly command-line option includes or excludes data in the migration as identified in the following table: -
|
-
Command-Line Option | -Description | -||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
/listfiles:<FileName> |
-You can use the /listfiles command-line option with the ScanState command to generate a text file that lists all of the files included in the migration. |
-||||||||||||||||||
/l:[Path]FileName |
-Specifies the location and name of the ScanState log. -You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then the log will be created in the current directory. You can use the /v option to adjust the amount of output. -If you run the ScanState or LoadState commands from a shared network resource, you must specify this option or USMT will fail with the following error: "USMT was unable to create the log file(s)". To fix this issue, use the /l: scan.log command. |
-||||||||||||||||||
/v:<VerbosityLevel> |
-(Verbosity) -Enables verbose output in the ScanState log file. The default value is 0. -You can set the VerbosityLevel to one of the following levels: -
- For example: -
|
-||||||||||||||||||
/progress:[Path</em>]FileName |
-Creates the optional progress log. You cannot store any of the log files in StorePath. Path can be either a relative or full path. If you do not specify the Path variable, then FileName will be created in the current directory. -For example: -
|
-||||||||||||||||||
/c |
-When this option is specified, the ScanState command will continue to run, even if non-fatal errors occur. Any files or settings that cause an error are logged in the progress log. For example, if there is a large file that will not fit in the store, the ScanState command will log an error and continue with the migration. In addition, if a file is open or in use by an application, USMT may not be able to migrate the file and will log an error. Without the /c option, the ScanState command will exit on the first error. -You can use the new <ErrorControl> section in the Config.xml file to specify which file or registry read/write errors can be safely ignored and which might cause the migration to fail. This enables the /c command-line option to safely skip all input/output (I/O) errors in your environment. In addition, the /genconfig option now generates a sample <ErrorControl> section that is enabled by specifying error messages and desired behaviors in the Config.xml file. |
-||||||||||||||||||
/r:<TimesToRetry> |
-(Retry) -Specifies the number of times to retry when an error occurs while saving the user state to a server. The default is three times. This option is useful in environments where network connectivity is not reliable. -While storing the user state, the /r option will not be able to recover data that is lost due to a network-hardware failure, such as a faulty or disconnected network cable, or when a virtual private network (VPN) connection fails. The retry option is intended for large, busy networks where connectivity is satisfactory, but communication latency is a problem. |
-||||||||||||||||||
/w:<SecondsBeforeRetry> |
-(Wait) -Specifies the time to wait, in seconds, before retrying a network file operation. The default is 1 second. |
-||||||||||||||||||
/p:<pathToFile> |
-When the ScanState command runs, it will create an .xml file in the path specified. This .xml file includes improved space estimations for the migration store. The following example shows how to create this .xml file: -
For more information, see Estimate Migration Store Size. -To preserve the functionality of existing applications or scripts that require the previous behavior of USMT, you can use the /p option, without specifying "pathtoafile", in USMT. If you specify only the /p option, the storage space estimations are created in the same manner as with USMT3.x releases. |
-||||||||||||||||||
/? or /help |
-Displays Help at the command line. |
-
Command-Line Option | -Description | -
---|---|
/all |
-Migrates all of the users on the computer. -USMT migrates all user accounts on the computer, unless you specifically exclude an account with either the /ue or /uel options. For this reason, you do not need to specify this option on the command line. However, if you choose to specify the /all option, you cannot also use the /ui, /ue or /uel options. |
-
/ui:<DomainName>\<UserName> -or -/ui:<ComputerName>\<LocalUserName> |
-(User include) -Migrates the specified users. By default, all users are included in the migration. Therefore, this option is helpful only when used with the /ue or /uel options. You can specify multiple /ui options, but you cannot use the /ui option with the /all option. DomainName and UserName can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you will need to surround it with quotation marks. -
-Note
-If a user is specified for inclusion with the /ui option, and also is specified to be excluded with either the /ue or /uel options, the user will be included in the migration. -
-
-
-For example: -
To include only User2 from the Fabrikam domain, type: -
To migrate all users from the Fabrikam domain, and only the user accounts from other domains that have been active or otherwise modified in the last 30 days, type: -
In this example, a user account from the Contoso domain that was last modified two months ago will not be migrated. -For more examples, see the descriptions of the /ue and /ui options in this table. |
-
/uel:<NumberOfDays> -or -/uel:<YYYY/MM/DD> -or -/uel:0 |
-(User exclude based on last logon) -Migrates the users that logged on to the source computer within the specified time period, based on the Last Modified date of the Ntuser.dat file on the source computer. The /uel option acts as an include rule. For example, the /uel:30 option migrates users who logged on, or whose account was modified, within the last 30 days from the date when the ScanState command is run. -You can specify a number of days or you can specify a date. You cannot use this option with the /all option. USMT retrieves the last logon information from the local computer, so the computer does not need to be connected to the network when you run this option. In addition, if a domain user has logged on to another computer, that logon instance is not considered by USMT. -
-Note
-The /uel option is not valid in offline migrations. -
-
-
-
For example: -
|
-
/ue:<DomainName>\<UserName> --or- - -/ue:<ComputerName>\<LocalUserName> |
-(User exclude) -Excludes the specified users from the migration. You can specify multiple /ue options. You cannot use this option with the /all option. <DomainName> and <UserName> can contain the asterisk () wildcard character. When you specify a user name that contains spaces, you need to surround it with quotation marks. -For example: -
|
-
Behavior | -Command | -
---|---|
Exclude the user named User One in the Fabrikam domain. |
-
|
-
Exclude the user named User1 in the Fabrikam domain. |
-
|
-
Exclude the local user named User1. |
-
|
-
Exclude all domain users. |
-
|
-
Exclude all local users. |
-
|
-
Exclude users in all domains named User1, User2, and so on. |
-
|
-
Behavior | -Command | -
---|---|
Include only User2 from the Fabrikam domain and exclude all other users. |
-
|
-
Include only the local user named User1 and exclude all other users. |
-
|
-
Include only the domain users from Contoso, except Contoso\User1. |
-This behavior cannot be completed using a single command. Instead, to migrate this set of users, you will need to specify the following: -
|
-
Include only local (non-domain) users. |
-
|
-
Command-Line Option | -Explanation | -
---|---|
/efs:hardlink |
-Creates a hard link to the EFS file instead of copying it. Use only with the /hardlink and the /nocompress options. |
-
/efs:abort |
-Causes the ScanState command to fail with an error code, if an Encrypting File System (EFS) file is found on the source computer. Enabled by default. |
-
/efs:skip |
-Causes the ScanState command to ignore EFS files. |
-
/efs:decryptcopy |
-Causes the ScanState command to decrypt the file, if possible, before saving it to the migration store, and to fail if the file cannot be decrypted. If the ScanState command succeeds, the file will be unencrypted in the migration store, and once you run the LoadState command, the file will be copied to the destination computer. |
-
/efs:copyraw |
-Causes the ScanState command to copy the files in the encrypted format. The files will be inaccessible on the destination computer until the EFS certificates are migrated. EFS certificates will be automatically migrated; however, by default USMT fails if an encrypted file is found, unless you specify an /efs option. Therefore you should specify the /efs:copyraw option with the ScanState command to migrate the encrypted file. Then, when you run the LoadState command, the encrypted file and the EFS certificate will be automatically migrated. -For example: -
-Important
-All files must be encrypted if the parent folder is encrypted. If the encryption attribute on a file inside an encrypted folder has been removed, the file will be encrypted during the migration using the credentials of the account used to run the LoadState tool. For more information, see Migrate EFS Files and Certificates. -
-
- |
-
Command-Line Option | -/keyfile | -/nocompress | -/genconfig | -/all | -
---|---|---|---|---|
/i |
-- | - | - | - |
/o |
-- | - | - | - |
/v |
-- | - | - | - |
/nocompress |
-- | - | - | N/A |
-
/localonly |
-- | - | X |
-- |
/key |
-X |
-- | X |
-- |
/encrypt |
-Required* |
-X |
-X |
-- |
/keyfile |
-N/A |
-- | X |
-- |
/l |
-- | - | - | - |
/progress |
-- | - | X |
-- |
/r |
-- | - | X |
-- |
/w |
-- | - | X |
-- |
/c |
-- | - | X |
-- |
/p |
-- | - | X |
-N/A |
-
/all |
-- | - | X |
-- |
/ui |
-- | - | X |
-X |
-
/ue |
-- | - | X |
-X |
-
/uel |
-- | - | X |
-X |
-
/efs:<option> |
-- | - | X |
-- |
/genconfig |
-- | - | N/A |
-- |
/config |
-- | - | X |
-- |
<StorePath> |
-- | - | X |
-- |
- | Find troubleshooting solutions for common problems in USMT. |
-
- | Find answers to questions about how to use USMT. |
-
- | Learn how to enable logging to help you troubleshoot issues in USMT. |
-
- | Learn how to use return codes to identify problems in USMT. |
-
- | Find more information and support for using USMT. |
-
Command-line Option | -Description | -
---|---|
/ec |
-Returns a list of supported cryptographic algorithms (AlgIDs) on the current system. You can use this on a destination computer to determine which algorithm to use with the /encrypt command before you run the ScanState tool on the source computer. |
-
/rd<storeDir> |
-Removes the directory path specified by the <storeDir> argument on the computer. You can use this command to delete hard-link migration stores that cannot otherwise be deleted at a command prompt due to a sharing lock. If the migration store spans multiple volumes on a given drive, it will be deleted from all of these volumes. -For example: -
|
-
/y |
-Overrides the accept deletions prompt when used with the /rd option. When you use the /y option with the /rd option, you will not be prompted to accept the deletions before USMT deletes the directories. |
-
/verify |
-Returns information on whether the compressed migration store is intact or whether it contains corrupted files or a corrupted catalog. -See Verify Options for syntax and options to use with /verify. |
-
/extract |
-Recovers files from a compressed USMT migration store. -See Extract Options for syntax and options to use with /extract. |
-
Command-line Option | -Description | -||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<reportType> |
-Specifies whether to report on all files, corrupted files only, or the status of the catalog. -
|
-||||||||||||||||||
/l:
- <logfilePath> |
-Specifies the location and name of the log file. |
-||||||||||||||||||
/v:<VerbosityLevel> |
-(Verbosity) -Enables verbose output in the UsmtUtils log file. The default value is 0. -You can set the VerbosityLevel to one of the following levels: -
|
-||||||||||||||||||
/decrypt<AlgID>/:<KeyString> -or -/decrypt<AlgID>/:<“Key String”> -or -/decrypt:<AlgID>/keyfile:<FileName> |
-Specifies that the /encrypt option was used to create the migration store with the ScanState tool. To decrypt the migration store, specify a /key or /keyfile option as follows: -
For more information about supported encryption algorithms, see Migration Store Encryption |
-
Command-line Option | -Description | -||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
<filePath> |
-Path to the USMT migration store. -For example: -
|
-||||||||||||||||||
<destinationPath> |
-Path to the folder where the tool puts the individual files. |
-||||||||||||||||||
/i:<includePattern> |
-Specifies a pattern for files to include in the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use /i: <includePattern> and /e: <excludePattern> options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns. |
-||||||||||||||||||
/e:<excludePattern> |
-Specifies a pattern for files to omit from the extraction. You can specify more than one pattern. Separate patterns with a comma or a semicolon. You can use /i: <includePattern> and /e: <excludePattern> options in the same command. When both include and exclude patterns are used on the command line, include patterns take precedence over exclude patterns. |
-||||||||||||||||||
/l:<logfilePath> |
-Specifies the location and name of the log file. |
-||||||||||||||||||
/v:<VerbosityLevel> |
-(Verbosity) -Enables verbose output in the UsmtUtils log file. The default value is 0. -You can set the VerbosityLevel to one of the following levels: -
|
-||||||||||||||||||
/decrypt<AlgID>/key:<KeyString> -or -/decrypt<AlgID>/:<“Key String”> -or -/decrypt:<AlgID>/keyfile:<FileName> |
-Specifies that the /encrypt option was used to create the migration store with the ScanState tool. To decrypt the migration store, you must also specify a /key or /keyfile option as follows: -
For more information about supported encryption algorithms, see Migration Store Encryption. |
-||||||||||||||||||
/o |
-Overwrites existing output files. |
-
Product | -Version | -
---|---|
Adobe Acrobat Reader |
-9 |
-
AOL Instant Messenger |
-6.8 |
-
Adobe Creative Suite |
-2 |
-
Adobe Photoshop CS |
-8, 9 |
-
Adobe ImageReady CS |
-- |
Apple iTunes |
-6, 7, 8 |
-
Apple QuickTime Player |
-5, 6, 7 |
-
Apple Safari |
-3.1.2 |
-
Google Chrome |
-beta |
-
Google Picasa |
-3 |
-
Google Talk |
-beta |
-
IBM Lotus 1-2-3 |
-9 |
-
IBM Lotus Notes |
-6,7, 8 |
-
IBM Lotus Organizer |
-5 |
-
IBM Lotus WordPro |
-9.9 |
-
Intuit Quicken Deluxe |
-2009 |
-
Money Plus Business |
-2008 |
-
Money Plus Home |
-2008 |
-
Mozilla Firefox |
-3 |
-
Microsoft Office |
-2003, 2007, 2010 |
-
Microsoft Office Access® |
-2003, 2007, 2010 |
-
Microsoft Office Excel® |
-2003, 2007, 2010 |
-
Microsoft Office FrontPage® |
-2003, 2007, 2010 |
-
Microsoft Office OneNote® |
-2003, 2007, 2010 |
-
Microsoft Office Outlook® |
-2003, 2007, 2010 |
-
Microsoft Office PowerPoint® |
-2003, 2007, 2010 |
-
Microsoft Office Publisher |
-2003, 2007, 2010 |
-
Microsoft Office Word |
-2003, 2007, 2010 |
-
Opera Software Opera |
-9.5 |
-
Microsoft Outlook Express |
-(only mailbox file) |
-
Microsoft Project |
-2003, 2007 |
-
Microsoft Office Visio® |
-2003, 2007 |
-
RealPlayer Basic |
-11 |
-
Sage Peachtree |
-2009 |
-
Skype |
-3.8 |
-
Windows Live Mail |
-12, 14 |
-
Windows Live Messenger |
-8.5, 14 |
-
Windows Live MovieMaker |
-14 |
-
Windows Live Photo Gallery |
-12, 14 |
-
Windows Live Writer |
-12, 14 |
-
Windows Mail |
-(Windows 7 and 8) |
-
Microsoft Works |
-9 |
-
Yahoo Messenger |
-9 |
-
Microsoft Zune™ Software |
-3 |
-
Elements A-K | -Elements L-Z | -Helper functions | -
---|---|---|
- - - - - - - - - - - - - - - - - - - - - - - | -- - - - - - - - - - - - - - - - - - - - - - | -- - - - - - - | -