Share via


Key

Applies To: Windows 7, Windows 8, Windows 8.1, Windows Server 2008, Windows Server 2008 R2, Windows Server 2012, Windows Server 2012 R2, Windows Vista

Key is used with the setting: Value to choose which Windows image to install from a Windows image file (.wim). Windows image files may contain multiple Windows images. A Windows image may be selected by its index number, its name, or its description.

Values

Values for Key Description

/IMAGE/INDEX

Uses the index number to select the image to install.

/IMAGE/NAME

Uses the index name to select the image to install.

/IMAGE/DESCRIPTION

Uses the index description to select the image to install.

This string type does not support empty elements. Do not create an empty value for this setting.

Valid Configuration Passes

windowsPE

Parent Hierarchy

Microsoft-Windows-Setup | ImageInstall | OSImage | InstallFrom | MetaData | Key

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 MetaData setting to install a specific Windows image using the image index value.

            <MetaData wcm:action="add">
                <Key>/IMAGE/INDEX</Key>
                <Value>2</Value>
            </MetaData>

The following XML output shows how to configure the MetaData setting to install a specific Windows image using the image name.

            <MetaData wcm:action="add">
                <Key>/IMAGE/NAME</Key>
                <Value>Model FNB1</Value>
            </MetaData>

The following XML output shows how to configure the MetaData setting to install a specific Windows image from a custom .wim file using the image description.

            <MetaData wcm:action="add">
                <Key>/IMAGE/DESCRIPTION</Key>
                <Value>Model FNB1</Value>
            </MetaData>

See Also

Concepts

MetaData
Value