PowerShell Commands

Mount-WindowsImage

Mount-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>][-Optimize] [-ReadOnly] [-ScratchDirectory <String>] -ImagePath* <String> -Index* <UInt32> -Path* <String>[<CommonParameters>]
Mount-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>][-Optimize] [-ReadOnly] [-ScratchDirectory <String>] -ImagePath* <String> -Name* <String> -Path* <String>[<CommonParameters>]
Mount-WindowsImage [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>]-Path* <String> -Remount* [<CommonParameters>]

The Mount-WindowsImage cmdlet maps a Windows image in a WIM or VHD file to the specified directory so that it is accessible for servicing.

The Path parameter specifies the location where you want to mount the Windows image.

The ImagePath parameter specifies the location of the WIM or VHD file containing the Windows image you want to mount.

Use the Index or Name parameter to specify which image in a WIM or VHD file that you want to mount. For a VHD file, the Index must be 1.

The Optimize parameter reduces the amount of time it takes to initially mount the image. However, processes that are ordinarily performed during a mount will instead be completed the first time that you access a directory. As a result, there may be an increase in the time that is required to access a directory for the first time after mounting an image using the Optimize parameter.

The Remount parameter mounts an image in a WIM or VHD file that was already mounted at the specified Path, but has become inaccessible for servicing.

The CheckIntegrity parameter detects and tracks .wim file corruption. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet.

The CheckIntegrity parameter does not apply to virtual hard disk (VHD) files.

Parameters

-CheckIntegrity [<SwitchParameter>]

  • Accepts pipeline input ByPropertyName

Detects and tracks .wim file corruption when used with the Dismount-WindowsImage or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Mount-WindowsImage cmdlet. The CheckIntegrity parameter does not apply to virtual hard disk (VHD) files.

-ImagePath <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the location of the WIM or VHD file containing the Windows image you want to mount.

-Index <UInt32>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1.

-LogLevel [<LogLevel>]

  • Accepts pipeline input ByPropertyName

Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows:1 = Errors only2 = Errors and warnings3 = Errors, warnings, and information4 = All of the information listed previously, plus debug output

-LogPath [<String>]

  • Accepts pipeline input ByPropertyName

Specifies the full path and file name to log to. If not set, the default is %WINDIR%\Logs\Dism\dism.log.In Windows PE, the default directory is the RAMDISK scratch space which can be as low as 32 MB. The log file will automatically be archived. The archived log file will be saved with .bak appended to the file name and a new log file will be generated. Each time the log file is archived the .bak file will be overwritten. When using a network share that is not joined to a domain, use the net use command together with domain credentials to set access permissions before you set the log path for the DISM log.

-Name <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the name of an image in a WIM or VHD file.

-Optimize [<SwitchParameter>]

  • Accepts pipeline input ByPropertyName

Reduces the amount of time it takes to initially mount the image. However, processes that are ordinarily performed during a mount will instead be completed the first time that you access a directory. As a result, there may be an increase in the time that is required to access a directory for the first time after mounting an image using the Optimize parameter.

-Path <String>

  • This value is required
  • Accepts pipeline input ByPropertyName

Specifies the location on your local computer where you want to mount the Windows image.

-ReadOnly [<SwitchParameter>]

  • Accepts pipeline input ByPropertyName

Specifies that the image should be mounted with read-only permissions.

-Remount <SwitchParameter>

  • This value is required
  • Accepts pipeline input ByPropertyName

Mounts an image in a WIM or VHD file that was already mounted at the specified Path, but has become inaccessible for servicing.

-ScratchDirectory [<String>]

  • Accepts pipeline input ByPropertyName

Specifies a temporary directory that will be used when extracting files for use during servicing. The directory must exist locally. If not specified, the \Windows\%Temp% directory will be used, with a subdirectory name of a randomly generated hexadecimal value for each run of DISM. Items in the scratch directory are deleted after each operation. You should not use a network share location as a scratch directory to expand a package (.cab or .msu file) for installation. The directory used for extracting files for temporary usage during servicing should be a local directory.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs
System.String[]
Microsoft.Dism.Commands.ImageObject Microsoft.Dism.Commands.ImageInfoObject
Outputs
Microsoft.Dism.Commands.ImageObject
Examples
  1. Mount an image from the install.vhd file to a directory:
    PS C:\> Mount-WindowsImage -ImagePath "c:\imagestore\install.vhd" -Index 1 -Path "c:\offline"
    

    This command mounts the Windows image contained in the install.vhd file to the c:\offline directory.

  2. Mount an image at an index of a file with read-only privileges:
    PS C:\> Mount-WindowsImage -ImagePath "c:\imagestore\install.wim" -Index 2 -Path "c:\offline" -ReadOnly
    

    This command mounts the Windows image at index 2 of the install.wim file to the c:\offline ddirectory with read-only privileges.

  3. Mount an image at an index of a file:
    PS C:\> Mount-WindowsImage -ImagePath "c:\imagestore\install.wim" -Index 2 -Path "c:\offline" -Optimize
    

    This command mounts the Windows image at index 2 of the install.wim file to the c:\offline directory with a quicker initial mount time. Additional operations may be slower.

  4. Remounts an image previously mounted to a directory that is inaccessible:
    PS C:\> Mount-WindowsImage -Path "c:\offline" -Remount
    

    This command remounts a Windows image that has already been mounted to the c:\offline directory but has become inaccessible for servicing.

This work is licensed under a Creative Commons Attribution 4.0 International. It is attributed to Microsoft Corporation and can be found here.

PowerShell Commands