windows-itpro-docs/windows/deploy/provisioning-multivariant.md

title, description, ms.prod, ms.mktglfcycl, ms.sitesec, author, localizationpriority

title	description	ms.prod	ms.mktglfcycl	ms.sitesec	author	localizationpriority
Create a provisioning package with multivariant settings (Windows 10)	Create a provisioning package with multivariant settings to customize the provisioned settings.	w10	deploy	library	jdeckerMS	high

Create a provisioning package with multivariant settings

Applies to

• Windows 10
• Windows 10 Mobile

Multivariant provisioning packages enable you to create a single provisioning package that can work for multiple locales.

To provision multivariant settings, you must create a provisioning package with defined Conditions and Settings that are tied to these conditions. When you install this package on a Windows 10 device, the provisioning engine applies the matching condition settings at every event and triggers provisioning.

The following events trigger provisioning on Windows 10 devices:

Event	Windows 10 Mobile	Windows 10 for desktop editions (Home, Pro, Enterprise, and Education)
System boot	Supported	Supported
Operating system update	Supported	Planned
Package installation during device first run experience	Supported	Supported
Detection of SIM presence or update	Supported	Not supported
Package installation at runtime	Supported	Supported
Roaming detected	Supported	Not supported

Target, TargetState, Condition, and priorities

Targets describe keying for a variant and must be described or pre-declared before being referenced by the variant.

• You can define multiple Target child elements for each Id that you need for the customization setting.

• Within a Target you can define multiple TargetState elements.

• Within a TargetState element you can create multiple Condition elements.

• A Condition element defines the matching type between the condition and the specified value.

The following table shows the conditions supported in Windows 10 provisioning:

Note

You can use any of these supported conditions when defining your TargetState.

Condition Name	Condition priority	Windows 10 Mobile	Windows 10 for desktop editions	Value type	Value description
MNC	P0	Supported	N/A	Digit string	Use to target settings based on the Mobile Network Code (MNC) value.
MCC	P0	Supported	N/A	Digit string	Use to target settings based on the Mobile Country Code (MCC) value.
SPN	P0	Supported	N/A	String	Use to target settings based on the Service Provider Name (SPN) value.
PNN	P0	Supported	N/A	String	Use to target settings based on public land mobile network (PLMN) Network Name value.
GID1	P0	Supported	N/A	Digit string	Use to target settings based on the Group Identifier (level 1) value.
ICCID	P0	Supported	N/A	Digit string	Use to target settings based on the Integrated Circuit Card Identifier (ICCID) value.
Roaming	P0	Supported	N/A	Boolean	Use to specify roaming. Set the value to 1 (roaming) or 0 (non-roaming).
UICC	P0	Supported	N/A	Enumeration	Use to specify the UICC state. Set the value to one of the following: - 0 - Empty - 1 - Ready - 2 - Locked
UICCSLOT	P0	Supported	N/A	Digit string	Use to specify the UICC slot. Set the value one of the following: - 0 - Slot 0 - 1 - Slot 1
ProcessorType	P1	Supported	Supported	String	Use to target settings based on the processor type.
ProcessorName	P1	Supported	Supported	String	Use to target settings based on the processor name.
AoAc	P1	Supported	Supported	Boolean	Set the value to 0 or 1.
PowerPlatformRole	P1	Supported	Supported	Enumeration	Indicates the preferred power management profile. Set the value based on the POWER_PLATFORM_ROLE enumeration.
Architecture	P1	Supported	Supported	String	Matches the PROCESSOR_ARCHITECTURE environment variable.
Server	P1	Supported	Supported	Boolean	Set the value to 0 or 1.
Region	P1	Supported	Supported	Enumeration	Use to target settings based on country/region.
Lang	P1	Supported	Supported	Enumeration	Use to target settings based on language code.
ROMLANG	P1	Supported	N/A	Digit string	Use to specify the PhoneROMLanguage that's set for DeviceTargeting. This condition is used primarily to detect variants for China. For example, you can use this condition and set the value to "0804".

The matching types supported in Windows 10 are:

Matching type	Syntax	Example
Straight match	Matching type is specified as-is	<Condition Name="ProcessorName" Value="Barton" />
Regex match	Matching type is prefixed by "Pattern:"	<Condition Name="ProcessorName" Value="Pattern:.Celeron." />
Numeric range match	Matching type is prefixed by "!Range:"	<Condition Name="MNC" Value="!Range:400, 550" />

• When all Condition elements are TRUE, TargetState is TRUE (AND logic).

• If any of the TargetState elements is TRUE, Target is TRUE (OR logic), and Id can be used for the setting customization.

You can define more than one TargetState within a provisioning package to apply variant settings that match device conditions. When the provisioning engine evalues each TargetState, more than one TargetState may fit current device conditions. To determine the order in which the variant settings are applied, the system assigns a priority to every TargetState.

A variant setting that matches a TargetState with a lower priority is applied before the variant that matches a TargetState with a higher priority. Variant settings that match more than one TargetState with equal priority are applied according to the order that each TargetState is defined in the provisioning package.

The TargetState priority is assigned based on the conditions priority and the priority evaluation rules are as followed:

1. TargetState with P0 conditions is higher than TargetState without P0 conditions.

2. TargetState with P1 conditions is higher than TargetState without P0 and P1 conditions.

3. If N₁>N₂>0, the TargetState priority with N₁ P0 conditions is higher than the TargetState with N₂ P1 conditions.

4. For TargetState without P0 conditions, if N₁>N₂>0 TargetState with N₁ P1 conditions is higher than the TargetState with N₂ P1 conditions.

5. For TargetState without P0 and P1 conditions, if N₁>N₂>0 TargetState priority with N₁ P2 conditions is higher than the TargetState with N₂ P2 conditions.

6. For rules 3, 4, and 5, if N₁=N₂, TargetState priorities are considered equal.

Create a provisioning package with multivariant settings

Follow these steps to create a provisioning package with multivariant capabilities.

1. Build a provisioning package and configure the customizations you need to apply during certain conditions. For more information, see Create a provisioning package.

2. After you've configured the settings, save the project.

3. Open the project folder and copy the customizations.xml file.

4. Use an XML or text editor to open the customizations.xml file.

   The customizations.xml file holds the package metadata (including the package owner and rank) and the settings that you configured when you created your provisioning package. The Customizations node contains a Common section, which contains the customization settings.

   The following example shows the contents of a sample customizations.xml file.

{6aaa4dfa-00d7-4aaa-8adf-73c6a7e2501e} My Provisioning Package 1.0 OEM 50 0 0 0 0 ```

4. Edit the customizations.xml file and create a Targets section to describe the conditions that will handle your multivariant settings.

   The following example shows the customizations.xml, which has been modified to include several conditions including ProcessorName, ProcessorType, MCC, and MNC.

   <?xml version="1.0" encoding="utf-8"?> 
   

{6aaa4dfa-00d7-4aaa-8adf-73c6a7e2501e} My Provisioning Package 1.0 OEM 50 0 0 0 0 ```

5. In the customizations.xml file, create a Variant section for the settings you need to customize. To do this:

   a. Define a child TargetRefs element.

   b. Within the TargetRefs element, define a TargetRef element. You can define multiple TargetRef elements for each Id that you need to apply to customized settings.

   c. Move compliant settings from the Common section to the Variant section.

   If any of the TargetRef elements matches the Target, all settings in the Variant are applied (OR logic).

   Note

   You can define multiple Variant sections. Settings that reside in the Common section are applied unconditionally on every triggering event.

   The following example shows the customizations.xml updated to include a Variant section and the moved settings that will be applied if the conditions for the variant are met.

{6aaa4dfa-00d7-4aaa-8adf-73c6a7e2501e} My Provisioning Package 1.0 OEM 50 1 1 1 1 ```

6. Save the updated customizations.xml file and note the path to this updated file. You will need the path as one of the values for the next step.

7. Use the Windows ICD command-line interface to create a provisioning package using the updated customizations.xml.

   For example:

   icd.exe /Build-ProvisioningPackage /CustomizationXML:"C:\CustomProject\customizations.xml" /PackagePath:"C:\CustomProject\output.ppkg" /StoreFile:C:\Program Files (x86)\Windows Kits\10\Assessment and Deployment Kit\Imaging and Configuration Designer\x86\Microsoft-Common-Provisioning.dat"
   

In this example, the StoreFile corresponds to the location of the settings store that will be used to create the package for the required Windows edition.

Note

The provisioning package created during this step will contain the multivariant settings. You can use this package either as a standalone package that you can apply to a Windows device or use it as the base when starting another project.

Related topics

• Provisioning packages for Windows 10
• How provisioning works in Windows 10
• Install Windows Imaging and Configuration Designer
• Create a provisioning package
• Apply a provisioning package
• Settings changed when you uninstall a provisioning package
• Provision PCs with common settings for initial deployment (simple provisioning)
• Provision PCs with apps and certificates for initial deployments (advanced provisioning)
• Use a script to install a desktop app in provisioning packages
• NFC-based device provisioning
• Windows ICD command-line interface (reference)