mirror of
https://github.com/MicrosoftDocs/windows-itpro-docs.git
synced 2025-06-21 05:13:40 +00:00
Metadata update deployment/usmt 5
This commit is contained in:
Frank Rojas
@ -13,8 +13,6 @@ ms.technology: itpro-deploy
|
||||
|
||||
# Config.xml File
|
||||
|
||||
## Config.xml File
|
||||
|
||||
The `Config.xml` file is an optional User State Migration Tool (USMT) 10.0 file that you can create using the `/genconfig` option with the ScanState tool. If you want to include all of the default components, and don't want to change the default store-creation or profile-migration behavior, you don't need to create a `Config.xml` file.
|
||||
|
||||
However, if you're satisfied with the default migration behavior defined in the `MigApp.xml`, `MigUser.xml` and `MigDocs.xml` files, but you want to exclude certain components, you can create and modify a `Config.xml` file and leave the other .xml files unchanged. For example, you must create and modify the `Config.xml` file if you want to exclude any of the operating-system settings that are migrated. It's necessary to create and modify this file if you want to change any of the default store-creation or profile-migration behavior.
|
||||
@ -23,7 +21,7 @@ The `Config.xml` file has a different format than the other migration .xml files
|
||||
|
||||
For more information about using the `Config.xml` file with other migration files, such as the `MigDocs.xml` and `MigApps.xml` files, see [Understanding Migration XML Files](understanding-migration-xml-files.md).
|
||||
|
||||
> [!Note]
|
||||
> [!NOTE]
|
||||
> To exclude a component from the `Config.xml` file, set the **migrate** value to **no**. Deleting the XML tag for the component from the `Config.xml` file will not exclude the component from your migration.
|
||||
|
||||
## In this topic
|
||||
@ -64,21 +62,21 @@ In USMT there are new migration policies that can be configured in the `Config.x
|
||||
|
||||
[Sample Config.xml File](#bkmk-sampleconfigxjmlfile)
|
||||
|
||||
## <a href="" id="bkmk-policies"></a><Policies>
|
||||
## <a href="" id="bkmk-policies"></a> <Policies>
|
||||
|
||||
The **<Policies>** element contains elements that describe the policies that USMT follows while creating a migration store. Valid children of the **<Policies>** element are **<ErrorControl>** and **<HardLinkStoreControl>**. The **<Policies>** element is a child of **<Configuration>**.
|
||||
|
||||
Syntax: `<Policies>` `</Policies>`
|
||||
|
||||
## <a href="" id="bkmk-errorcontrol"></a><ErrorControl>
|
||||
## <a href="" id="bkmk-errorcontrol"></a> <ErrorControl>
|
||||
|
||||
The **<ErrorControl>** element is an optional element you can configure in the `Config.xml` file. The configurable **<ErrorControl>** rules support only the environment variables for the operating system that is running and the currently logged-on user. As a workaround, you can specify a path using the (\*) wildcard character.
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: The **<Policies>** element
|
||||
- **Parent elements**: The **<Policies>** element
|
||||
|
||||
- **Child elements**: The **<fileError>** and **<registryError>** element
|
||||
- **Child elements**: The **<fileError>** and **<registryError>** element
|
||||
|
||||
Syntax: `<ErrorControl>` `</ErrorControl>`
|
||||
|
||||
@ -101,15 +99,15 @@ Additionally, the order in the **<ErrorControl>** section implies priority
|
||||
> [!IMPORTANT]
|
||||
> The configurable **<ErrorControl>** rules support only the environment variables for the operating system that is running and the currently logged-on user. As a workaround, you can specify a path using the (\*) wildcard character.
|
||||
|
||||
### <a href="" id="bkmk-fatal"></a><fatal>
|
||||
### <a href="" id="bkmk-fatal"></a> <fatal>
|
||||
|
||||
The **<fatal>** element isn't required.
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: **<fileError>** and **<registryError>**
|
||||
- **Parent elements**: **<fileError>** and **<registryError>**
|
||||
|
||||
- **Child elements**: None.
|
||||
- **Child elements**: None.
|
||||
|
||||
Syntax: `<fatal errorCode="any">` *<pattern>* `</fatal>`
|
||||
|
||||
@ -119,29 +117,29 @@ Syntax: `<fatal errorCode="any">` *<pattern>* `</fatal>`
|
||||
|
||||
You use the **<fatal>** element to specify that errors matching a specific pattern should cause USMT to halt the migration.
|
||||
|
||||
## <a href="" id="bkmk-fileerror"></a><fileError>
|
||||
## <a href="" id="bkmk-fileerror"></a> <fileError>
|
||||
|
||||
The **<fileError>** element isn't required.
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: **<ErrorControl>**
|
||||
- **Parent elements**: **<ErrorControl>**
|
||||
|
||||
- **Child elements**: **<nonFatal>** and **<fatal>**
|
||||
- **Child elements**: **<nonFatal>** and **<fatal>**
|
||||
|
||||
Syntax: `<fileError>` `</fileError>`
|
||||
|
||||
You use the **<fileError>** element to represent the behavior associated with file errors.
|
||||
|
||||
## <a href="" id="bkmk-nonfatal"></a><nonFatal>
|
||||
## <a href="" id="bkmk-nonfatal"></a> <nonFatal>
|
||||
|
||||
The **<nonFatal>** element isn't required.
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: The **<fileError>** and **<registryError>** elements.
|
||||
- **Parent elements**: The **<fileError>** and **<registryError>** elements.
|
||||
|
||||
- **Child elements**: None.
|
||||
- **Child elements**: None.
|
||||
|
||||
Syntax: `<nonfatal errorCode="any">` *<pattern>* `</nonFatal>`
|
||||
|
||||
@ -151,15 +149,15 @@ Syntax: `<nonfatal errorCode="any">` *<pattern>* `</nonFatal>`
|
||||
|
||||
You use the **<nonFatal>** element to specify that errors matching a specific pattern shouldn't cause USMT to halt the migration.
|
||||
|
||||
## <a href="" id="bkmk-registryerror"></a><registryError>
|
||||
## <a href="" id="bkmk-registryerror"></a> <registryError>
|
||||
|
||||
The <strong><registryError></strong> element isn't required.
|
||||
The **<registryError>** element isn't required.
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: **<ErrorControl>**
|
||||
- **Parent elements**: **<ErrorControl>**
|
||||
|
||||
- **Child elements**: **<nonfatal>** and **<fatal>**
|
||||
- **Child elements**: **<nonfatal>** and **<fatal>**
|
||||
|
||||
Syntax: `<registryError>` `</registryError>`
|
||||
|
||||
@ -169,17 +167,17 @@ Syntax: `<registryError>` `</registryError>`
|
||||
|
||||
You use the **<registryError>** element to specify that errors matching a specific pattern shouldn't cause USMT to halt the migration.
|
||||
|
||||
## <a href="" id="bkmk-hardlinkstorecontrol"></a><HardLinkStoreControl>
|
||||
## <a href="" id="bkmk-hardlinkstorecontrol"></a> <HardLinkStoreControl>
|
||||
|
||||
The **<HardLinkStoreControl>** element contains elements that describe how to handle files during the creation of a hard-link migration store. Its only valid child is **<fileLocked>**.
|
||||
|
||||
Syntax: `<HardLinkStoreControl>` `</HardLinkStoreControl>`
|
||||
|
||||
- **Number of occurrences**: Once for each component
|
||||
- **Number of occurrences**: Once for each component
|
||||
|
||||
- **Parent elements**: **<Policies>**
|
||||
- **Parent elements**: **<Policies>**
|
||||
|
||||
- **Child elements**: **<fileLocked>**
|
||||
- **Child elements**: **<fileLocked>**
|
||||
|
||||
Syntax: `<HardLinkStoreControl>` `</HardLinkStoreControl>`
|
||||
|
||||
@ -202,43 +200,43 @@ The **<HardLinkStoreControl>** sample code below specifies that hard links
|
||||
</Policy>
|
||||
```
|
||||
|
||||
## <a href="" id="bkmk-filelock"></a><fileLocked>
|
||||
## <a href="" id="bkmk-filelock"></a> <fileLocked>
|
||||
|
||||
The **<fileLocked>** element contains elements that describe how to handle files that are locked for editing. The rules defined by the **<fileLocked>** element are processed in the order in which they appear in the XML file.
|
||||
|
||||
Syntax: `<fileLocked>` `</fileLocked>`
|
||||
|
||||
## <a href="" id="bkmk-createhardlink"></a><createHardLink>
|
||||
## <a href="" id="bkmk-createhardlink"></a> <createHardLink>
|
||||
|
||||
The **<createHardLink>** element defines a standard MigXML pattern that describes file paths where hard links should be created, even if the file is locked for editing by another application.
|
||||
|
||||
Syntax: `<createHardLink>` *<pattern>* `</createHardLink>`
|
||||
|
||||
## <a href="" id="bkmk-errorhardlink"></a><errorHardLink>
|
||||
## <a href="" id="bkmk-errorhardlink"></a> <errorHardLink>
|
||||
|
||||
The **<errorHardLink>** element defines a standard MigXML pattern that describes file paths where hard links shouldn't be created if the file is locked for editing by another application. USMT will attempt to copy files under these paths into the migration store. However, if that isn't possible, **Error\_Locked** is thrown. This error is a standard Windows application programming interface (API) error that can be captured by the **<ErrorControl>** section to either cause USMT to skip the file or abort the migration.
|
||||
|
||||
Syntax: `<errorHardLink>` *<pattern>* `</errorHardLink>`
|
||||
|
||||
## <a href="" id="bkmk-profilecontrol"></a><ProfileControl>
|
||||
## <a href="" id="bkmk-profilecontrol"></a> <ProfileControl>
|
||||
|
||||
This element is used to contain other elements that establish rules for migrating profiles, users, and policies around local group membership during the migration. **<ProfileMigration>** is a child of **<Configuration>**.
|
||||
|
||||
Syntax: <`ProfileControl>` `</ProfileControl>`
|
||||
|
||||
## <a href="" id="bkmk-localgroups"></a><localGroups>
|
||||
## <a href="" id="bkmk-localgroups"></a> <localGroups>
|
||||
|
||||
This element is used to contain other elements that establish rules for how to migrate local groups. **<localGroups>** is a child of **<ProfileControl>**.
|
||||
|
||||
Syntax: `<localGroups>` `</localGroups>`
|
||||
|
||||
## <a href="" id="bkmk-mappings"></a><mappings>
|
||||
## <a href="" id="bkmk-mappings"></a> <mappings>
|
||||
|
||||
This element is used to contain other elements that establish mappings between groups.
|
||||
|
||||
Syntax: `<mappings>` `</mappings>`
|
||||
|
||||
## <a href="" id="bkmk-changegrou"></a><changeGroup>
|
||||
## <a href="" id="bkmk-changegrou"></a> <changeGroup>
|
||||
|
||||
This element describes the source and destination groups for a local group membership change during the migration. It's a child of **<localGroups>**. The following parameters are defined:
|
||||
|
||||
@ -252,19 +250,19 @@ The valid and required children of **<changeGroup>** are **<include>
|
||||
|
||||
Syntax: `<changeGroup From="Group1" To= "Group2">` `</changeGroup>`
|
||||
|
||||
## <a href="" id="bkmk-include"></a><include>
|
||||
## <a href="" id="bkmk-include"></a> <include>
|
||||
|
||||
This element specifies that its required child, *<pattern>*, should be included in the migration.
|
||||
|
||||
Syntax: `<include>` `</include>`
|
||||
|
||||
## <a href="" id="bkmk-exclude"></a><exclude>
|
||||
## <a href="" id="bkmk-exclude"></a> <exclude>
|
||||
|
||||
This element specifies that its required child, *<pattern>*, should be excluded from the migration.
|
||||
|
||||
Syntax: `<exclude>` `</exclude>`
|
||||
|
||||
## <a href="" id="bkmk-sampleconfigxjmlfile"></a>Sample Config.xml File
|
||||
## <a href="" id="bkmk-sampleconfigxjmlfile"></a> Sample Config.xml File
|
||||
|
||||
Refer to the following sample `Config.xml` file for more details about items you can choose to exclude from a migration.
|
||||
<br>
|
||||
@ -467,4 +465,4 @@ Refer to the following sample `Config.xml` file for more details about items you
|
||||
|
||||
## Related articles
|
||||
|
||||
[USMT XML Reference](usmt-xml-reference.md)
|
||||
[USMT XML Reference](usmt-xml-reference.md)
|
||||
|
||||
Reference in New Issue
Block a user