MetaData (microsoft-windows-setup-imageinstall-dataimage-installfrom-metadata)
MetaData specifies a data image in a Windows image (.wim) file.
Use the MetaData\Key and MetaData\Value settings together to select an image based on the index, the name, or the description of the data image.
To determine what images are available to be installed
Use the DISM /Get-WimInfo command to determine which images and editions are included on your data image (.wim) file, such as in the following example:
DISM /Get-WimInfo /WimFile:N:\Drivers\FNBDrivers.wim
Information about the available images will be displayed; for example:
Deployment Image Servicing and Management tool
Version: 6.1.7108.0
Details for image : N:\Drivers\FNBDrivers.wim
Index : 1
Name : FNB1Drivers
Description : FabriKam Model FNB1 Drivers
Size : 1,234,567 bytes
Index : 2
Name : FNB2Drivers
Description : FabriKam Model FNB2 Drivers
Size : 2,234,567 bytes
Index : 3
Name : FNB3Drivers
Description : FabriKam Model FNB3 Drivers
Size : 3,234,567 bytes
Child Elements
| Setting | Description |
|---|---|
| Key | Required. Specifies whether the image index, name, or description is used to specify the metadata for an image in a .wim file. |
| Value | Required. Specifies the value of the Key element for the data image. |
Valid Configuration Passes
windowsPE
Parent Hierarchy
Microsoft-Windows-Setup | ImageInstall | DataImage | InstallFrom | MetaData
Applies To
For a list of the Windows editions and architectures that this component supports, see Microsoft-Windows-Setup.
XML Examples
The following XML output shows how to configure the DataImage setting to install a specific data image from a custom .wim file located on a network share using the image index value.
<ImageInstall>
<DataImage>
<InstallFrom>
<Credentials>
<Domain>FabrikamDomain</Domain>
<Password>MyPassword</Password>
<Username>MyUsername</Username>
</Credentials>
<Path>\\networkshare\share\Drivers\FNBDrivers.wim </Path>
<MetaData wcm:action="add">
<Key>/IMAGE/INDEX</Key>
<Value>1</Value>
</MetaData>
</InstallFrom>
<InstallTo>
<DiskID>0</DiskID>
<PartitionID>3</PartitionID>
</InstallTo>
<WillShowUI>OnError</WillShowUI>
</DataImage>
</ImageInstall>
The following XML output shows how to configure the MetaData setting to install a specific data image using the image name.
<ImageInstall>
<DataImage>
<InstallFrom>
<Credentials>
<Domain>FabrikamDomain</Domain>
<Password>MyPassword</Password>
<Username>MyUsername</Username>
</Credentials>
<Path>\\networkshare\share\Drivers\FNBDrivers.wim </Path>
<MetaData wcm:action="add">
<Key>/IMAGE/NAME</Key>
<Value>FNB2Drivers</Value>
</MetaData>
</InstallFrom>
<InstallTo>
<DiskID>0</DiskID>
<PartitionID>3</PartitionID>
</InstallTo>
<WillShowUI>OnError</WillShowUI>
</DataImage>
</ImageInstall>
The following XML output shows how to configure the MetaData setting to install a specific data image from a custom .wim file located on a network share using the image description.
<ImageInstall>
<OSImage>
<InstallFrom>
<Credentials>
<Domain>FabrikamDomain</Domain>
<Password>MyPassword</Password>
<Username>MyUsername</Username>
</Credentials>
<Path>\\networkshare\share\Drivers\FNBDrivers.wim </Path>
<MetaData wcm:action="add">
<Key>/IMAGE/DESCRIPTION</Key>
<Value>FabriKam Model FNB3 Drivers</Value>
</MetaData>
</InstallFrom>
<InstallTo>
<DiskID>0</DiskID>
<PartitionID>3</PartitionID>
</InstallTo>
<WillShowUI>OnError</WillShowUI>
<InstallToAvailablePartition>false</InstallToAvailablePartition>
</OSImage>
</ImageInstall>