mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-15 10:23:37 +00:00
Updated-5548201
Converted HTML tables to Markdown tables in the following topics Offline Migration Reference Understanding Migration XML Files Choose a Migration Store Type User State Migration Tool (USMT) Command-line Syntax Config.xml File Conflicts and Precedence Custom XML Examples Determine What to Migrate Hard-Link Migration Store LoadState Syntax Log Files Migration Store Encryption Plan Your Migration Recognized Environment Variables User State Migration Toolkit (USMT) Reference
This commit is contained in:
Benzy Dharmanayagam
@ -16,7 +16,6 @@ ms.topic: article
|
||||
|
||||
# Log Files
|
||||
|
||||
|
||||
You can use User State Migration Tool (USMT) 10.0 logs to monitor your migration and to troubleshoot errors and failed migrations. This topic describes the available command-line options to enable USMT logs, and new XML elements that configure which types of errors are fatal and should halt the migration, which types are non-fatal and should be skipped so that the migration can continue.
|
||||
|
||||
[Log Command-Line Options](#bkmk-commandlineoptions)
|
||||
@ -31,66 +30,25 @@ You can use User State Migration Tool (USMT) 10.0 logs to monitor your migratio
|
||||
|
||||
## <a href="" id="bkmk-commandlineoptions"></a>Log Command-Line Options
|
||||
|
||||
|
||||
The following table describes each command-line option related to logs, and it provides the log name and a description of what type of information each log contains.
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col width="33%" />
|
||||
<col width="33%" />
|
||||
<col width="33%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="header">
|
||||
<th align="left">Command line Option</th>
|
||||
<th align="left">File Name</th>
|
||||
<th align="left">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="odd">
|
||||
<td align="left"><p><strong>/l</strong><em>[Path]FileName</em></p></td>
|
||||
<td align="left"><p>Scanstate.log or LoadState.log</p></td>
|
||||
<td align="left"><p>Specifies the path and file name of the ScanState.log or LoadState log.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p><strong>/progress</strong><em>[Path]FileName</em></p></td>
|
||||
<td align="left"><p>Specifies the path and file name of the Progress log.</p></td>
|
||||
<td align="left"><p>Provides information about the status of the migration, by percentage complete.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p><strong>/v</strong><em>[VerbosityLevel]</em></p></td>
|
||||
<td align="left"><p>Not applicable</p></td>
|
||||
<td align="left"><p>See the "Monitoring Options" section in <a href="usmt-scanstate-syntax.md" data-raw-source="[ScanState Syntax](usmt-scanstate-syntax.md)">ScanState Syntax</a>.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p><strong>/listfiles</strong><em>[Path]FileName</em></p></td>
|
||||
<td align="left"><p>Specifies the path and file name of the Listfiles log.</p></td>
|
||||
<td align="left"><p>Provides a list of the files that were migrated.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>Set the environment variable MIG_ENABLE_DIAG to a path to an XML file.</p></td>
|
||||
<td align="left"><p>USMTDiag.xml</p></td>
|
||||
<td align="left"><p>The diagnostic log contains detailed system environment information, user environment information, and information about the migration units (migunits) being gathered and their contents.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|Command line Option|File Name|Description|
|
||||
|--- |--- |--- |
|
||||
|**/l** *[Path]FileName*|Scanstate.log or LoadState.log|Specifies the path and file name of the ScanState.log or LoadState log.|
|
||||
|**/progress** *[Path]FileName*|Specifies the path and file name of the Progress log.|Provides information about the status of the migration, by percentage complete.|
|
||||
|**/v** *[VerbosityLevel]*|Not applicable|See the "Monitoring Options" section in [ScanState Syntax](usmt-scanstate-syntax.md).|
|
||||
|**/listfiles** *[Path]FileName*|Specifies the path and file name of the Listfiles log.|Provides a list of the files that were migrated.|
|
||||
|Set the environment variable MIG_ENABLE_DIAG to a path to an XML file.|USMTDiag.xml|The diagnostic log contains detailed system environment information, user environment information, and information about the migration units (migunits) being gathered and their contents.|
|
||||
|
||||
**Note**
|
||||
You cannot store any of the log files in *StorePath*. If you do, the log will be overwritten when USMT is run.
|
||||
|
||||
|
||||
|
||||
## <a href="" id="bkmk-scanloadstatelogs"></a>ScanState and LoadState Logs
|
||||
|
||||
|
||||
ScanState and LoadState logs are text files that are create when you run the ScanState and LoadState tools. You can use these logs to help monitor your migration. The content of the log depends on the command-line options that you use and the verbosity level that you specify. For more information about verbosity levels, see Monitoring Options in [ScanState Syntax](usmt-scanstate-syntax.md).
|
||||
|
||||
## <a href="" id="bkmk-progresslog"></a>Progress Log
|
||||
|
||||
|
||||
You can create a progress log using the **/progress** option. External tools, such as Microsoft System Center Operations Manager 2007, can parse the progress log to update your monitoring systems. The first three fields in each line are fixed as follows:
|
||||
|
||||
- **Date:** Date, in the format of *day* *shortNameOfTheMonth* *year*. For example: 08 Jun 2006.
|
||||
@ -101,137 +59,34 @@ You can create a progress log using the **/progress** option. External tools, su
|
||||
|
||||
The remaining fields are key/value pairs as indicated in the following table.
|
||||
|
||||
<table>
|
||||
<colgroup>
|
||||
<col width="50%" />
|
||||
<col width="50%" />
|
||||
</colgroup>
|
||||
<thead>
|
||||
<tr class="header">
|
||||
<th align="left">Key</th>
|
||||
<th align="left">Value</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>program</p></td>
|
||||
<td align="left"><p>ScanState.exe or LoadState.exe.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>productVersion</p></td>
|
||||
<td align="left"><p>The full product version number of USMT.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>computerName</p></td>
|
||||
<td align="left"><p>The name of the source or destination computer on which USMT was run.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>commandLine</p></td>
|
||||
<td align="left"><p>The full command used to run USMT.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>PHASE</p></td>
|
||||
<td align="left"><p>Reports that a new phase in the migration is starting. This can be one of the following:</p>
|
||||
<ul>
|
||||
<li><p>Initializing</p></li>
|
||||
<li><p>Scanning</p></li>
|
||||
<li><p>Collecting</p></li>
|
||||
<li><p>Saving</p></li>
|
||||
<li><p>Estimating</p></li>
|
||||
<li><p>Applying</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>detectedUser</p></td>
|
||||
<td align="left"><ul>
|
||||
<li><p>For the ScanState tool, these are the users USMT detected on the source computer that can be migrated.</p></li>
|
||||
<li><p>For the LoadState tool, these are the users USMT detected in the store that can be migrated.</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>includedInMigration</p></td>
|
||||
<td align="left"><p>Defines whether the user profile/component is included for migration. Valid values are Yes or No.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>forUser</p></td>
|
||||
<td align="left"><p>Specifies either of the following:</p>
|
||||
<ul>
|
||||
<li><p>The user state being migrated.</p></li>
|
||||
<li><p><em>This Computer</em>, meaning files and settings that are not associated with a user.</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>detectedComponent</p></td>
|
||||
<td align="left"><p>Specifies a component detected by USMT.</p>
|
||||
<ul>
|
||||
<li><p>For ScanState, this is a component or application that is installed on the source computer.</p></li>
|
||||
<li><p>For LoadState, this is a component or application that was detected in the store.</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>totalSizeInMBToTransfer</p></td>
|
||||
<td align="left"><p>Total size of the files and settings to migrate in megabytes (MB).</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>totalPercentageCompleted</p></td>
|
||||
<td align="left"><p>Total percentage of the migration that has been completed by either ScanState or LoadState.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>collectingUser</p></td>
|
||||
<td align="left"><p>Specifies which user ScanState is collecting files and settings for.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>totalMinutesRemaining</p></td>
|
||||
<td align="left"><p>Time estimate, in minutes, for the migration to complete.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>error</p></td>
|
||||
<td align="left"><p>Type of non-fatal error that occurred. This can be one of the following:</p>
|
||||
<ul>
|
||||
<li><p><strong>UnableToCopy</strong>: Unable to copy to store because the disk on which the store is located is full.</p></li>
|
||||
<li><p><strong>UnableToOpen</strong>: Unable to open the file for migration because the file is opened in non-shared mode by another application or service.</p></li>
|
||||
<li><p><strong>UnableToCopyCatalog</strong>: Unable to copy because the store is corrupted.</p></li>
|
||||
<li><p><strong>UnableToAccessDevice</strong>: Unable to access the device.</p></li>
|
||||
<li><p><strong>UnableToApply</strong>: Unable to apply the setting to the destination computer.</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>objectName</p></td>
|
||||
<td align="left"><p>The name of the file or setting that caused the non-fatal error.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>action</p></td>
|
||||
<td align="left"><p>Action taken by USMT for the non-fatal error. The values are:</p>
|
||||
<ul>
|
||||
<li><p><strong>Ignore</strong>: Non-fatal error ignored and the migration continued because the <strong>/c</strong> option was specified on the command line.</p></li>
|
||||
<li><p><strong>Abort</strong>: Stopped the migration because the <strong>/c</strong> option was not specified.</p></li>
|
||||
</ul></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>errorCode</p></td>
|
||||
<td align="left"><p>The errorCode or return value.</p></td>
|
||||
</tr>
|
||||
<tr class="even">
|
||||
<td align="left"><p>numberOfIgnoredErrors</p></td>
|
||||
<td align="left"><p>The total number of non-fatal errors that USMT ignored.</p></td>
|
||||
</tr>
|
||||
<tr class="odd">
|
||||
<td align="left"><p>message</p></td>
|
||||
<td align="left"><p>The message corresponding to the errorCode.</p></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
| Key | Value |
|
||||
|-----|-------|
|
||||
| program | ScanState.exe or LoadState.exe. |
|
||||
| productVersion | The full product version number of USMT. |
|
||||
| computerName | The name of the source or destination computer on which USMT was run. |
|
||||
| commandLine | The full command used to run USMT. |
|
||||
| PHASE | Reports that a new phase in the migration is starting. This can be one of the following:<ul><li>Initializing</li><li>Scanning</li><li>Collecting</li><li>Saving</li><li>Estimating</li><li>Applying</li></ul> |
|
||||
| detectedUser | <ul><li>For the ScanState tool, these are the users USMT detected on the source computer that can be migrated.</li><li>For the LoadState tool, these are the users USMT detected in the store that can be migrated.</li></ul> |
|
||||
| includedInMigration | Defines whether the user profile/component is included for migration. Valid values are Yes or No. |
|
||||
| forUser | Specifies either of the following:<ul><li>The user state being migrated.</li><li>*This Computer*, meaning files and settings that are not associated with a user.</li></ul> |
|
||||
| detectedComponent | Specifies a component detected by USMT.<ul><li>For ScanState, this is a component or application that is installed on the source computer.</li><li>For LoadState, this is a component or application that was detected in the store.</li></ul> |
|
||||
| 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:<ul><li>**UnableToCopy**: Unable to copy to store because the disk on which the store is located is full.</li><li>**UnableToOpen**: Unable to open the file for migration because the file is opened in non-shared mode by another application or service.</li><li>**UnableToCopyCatalog**: Unable to copy because the store is corrupted.</li><li>**UnableToAccessDevice**: Unable to access the device.</li><li>**UnableToApply**: Unable to apply the setting to the destination computer.</li></ul> |
|
||||
| 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:<ul><li>**Ignore**: Non-fatal error ignored and the migration continued because the **/c** option was specified on the command line.</li><li>**Abort**: Stopped the migration because the **/c** option was not specified.</li></ul> |
|
||||
| errorCode | The errorCode or return value. |
|
||||
| numberOfIgnoredErrors | The total number of non-fatal errors that USMT ignored. |
|
||||
| message | The message corresponding to the errorCode. |
|
||||
|
||||
## <a href="" id="bkmk-listfileslog"></a>List Files Log
|
||||
|
||||
|
||||
The List files log (Listfiles.txt) provides a list of the files that were migrated. This list can be used to troubleshoot XML issues or can be retained as a record of the files that were gathered into the migration store. The List Files log is only available for ScanState.exe.
|
||||
|
||||
## <a href="" id="bkmk-diagnosticlog"></a>Diagnostic Log
|
||||
|
||||
|
||||
You can obtain the diagnostic log by setting the environment variable MIG\_ENABLE\_DIAG to a path to an XML file.
|
||||
|
||||
The diagnostic log contains:
|
||||
@ -244,7 +99,6 @@ The diagnostic log contains:
|
||||
|
||||
## Using the Diagnostic Log
|
||||
|
||||
|
||||
The diagnostic log is essentially a report of all the migration units (migunits) included in the migration. A migunit is a collection of data that is identified by the component it is associated with in the XML files. The migration store is made up of all the migunits in the migration. The diagnostic log can be used to verify which migunits were included in the migration and can be used for troubleshooting while authoring migration XML files.
|
||||
|
||||
The following examples describe common scenarios in which you can use the diagnostic log.
|
||||
|
||||
Reference in New Issue
Block a user