MetaData

  • Article

MetaData specifies unique data in a Windows image (.wim) file. You can use the MetaData setting to select a specific data image in a .wim that matches one or more values specified by the Metadata setting.

The value for MetaData must match the value of the Index, the Name, or the Description of the Windows image. For example, rather than specifying an index number, you can select a data image, by using the Name metadata. For example, you can choose to install the data image with the name "FabrikamDriverFiles", by specifying the Key and Value pair for this data image.

When you create a Windows image, you can specify unique metadata for that image. You can view the metadata for a .wim file, by using the imagex /info command. You can update the Name and Description metadata fields of your images, by using the imagex command. For more information, see the ImageX Technical Reference.

The following examples show how the Key and Value settings in Metadata are combined to describe metadata information.

Sample .wim metadata output:

<WIM>
   <IMAGE INDEX="1">
      <NAME>FabrikamDriverFiles</NAME>
      <DESCRIPTION>FabrikamOutOfBoxDrivers</DESCRIPTION>
   </IMAGE>
</WIM>

The following table shows the Key and Value pairs that should be used to correspond to the metadata in the sample .wim file output.

Key Value

/IMAGE/INDEX

1

/IMAGE/NAME

FabrikamDriverFiles

/IMAGE/DESCRIPTION

FabrikamOutOfBoxDrivers

Child Elements

Key

Specifies the absolute hierarchical path to a key specified as part of the metadata for an image in a .wim file.

Value

Specifies the value of the Key element for the data image.

Valid Passes

windowsPE

Parent Hierarchy

Microsoft-Windows-Setup | ImageInstall | DataImage | InstallFrom | MetaData

Applies To

For the list of the supported Windows editions and architectures that this component supports, see Microsoft-Windows-Setup.

XML Example

The following XML output shows how to set the ImageInstall setting to install both an operating system image and a data image.

<ImageInstall>
    <OSImage>
        <InstallFrom>
            <Credentials>
                <Domain>FabrikamDomain</Domain>
                <Password>MyPassword</Password>
                <Username>MyUsername</Username>
            </Credentials>
            <Path>\\networkshare\share\install.wim</Path>
            <MetaData wcm:action="add">
                <Key>/IMAGE/NAME</Key>
                <Value>FabrikamCustomOSImage</Value>
            </MetaData>
        </InstallFrom>
        <InstallTo>
            <DiskID>0</DiskID>
            <PartitionID>1</PartitionID>
        </InstallTo>
        <WillShowUI>OnError</WillShowUI>
        <InstallToAvailablePartition>false</InstallToAvailablePartition>
    </OSImage>
    <DataImage wcm:action="add">
        <InstallTo>
            <DiskID>0</DiskID>
            <PartitionID>2</PartitionID>
        </InstallTo>
        <InstallFrom>
            <Credentials>
                <Domain>FabrikamDomain</Domain>
                <Password>MyPassword</Password>
                <Username>MyUsername</Username>
            </Credentials>
            <Path>\\networkshare\share\data.wim</Path>
            <MetaData wcm:action="add">
                <Key>/IMAGE/NAME</Key>
                <Value>FabrikamData</Value>
            </MetaData>
        </InstallFrom>
        <Order>1</Order>
    </DataImage>
</ImageInstall>

See Also

Concepts

InstallFrom