Table of contents
TOC
Collapse the table of content
Expand the table of content

OSImage

Last Updated: 12/12/2016

OSImage specifies the path and the destination of a Windows image (.wim) file that contains the image to install.

Child Elements

Compact

Specifies whether the Windows image should be applied with compression enabled during installation. If set to true, files written to the disk during installation are compressed individually, which allows Windows to take up less disk space.

InstallFrom

Specifies the path of the .wim file.

InstallTo

Specifies the disk and the partition to install the image to.

InstallToAvailablePartition

Specifies whether to install to the first available bootable partition on a computer that does not already have an installation of Windows.

WillShowUI

Specifies in what circumstances to show the user interface (UI).

Valid Configuration Passes

windowsPE

Parent Hierarchy

microsoft-windows-setup- | ImageInstall | OSImage

Applies To

For a 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>

ImageInstall

Send comments about this topic to Microsoft

© 2017 Microsoft