OSImage

2019-01-18

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

Child Elements

Setting	Description
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

Share via