Export-WindowsImage
Exports a copy of the specified image to another image file.
Syntax
Export-WindowsImage
[-CheckIntegrity]
[-CompressionType <String>]
-DestinationImagePath <String>
[-DestinationName <String>]
[-Setbootable]
-SourceImagePath <String>
-SourceName <String>
[-SplitImageFilePattern <String>]
[-WIMBoot]
[-LogPath <String>]
[-ScratchDirectory <String>]
[-LogLevel <LogLevel>]
[<CommonParameters>] Export-WindowsImage
[-CheckIntegrity]
[-CompressionType <String>]
-DestinationImagePath <String>
[-DestinationName <String>]
[-Setbootable]
-SourceImagePath <String>
-SourceIndex <UInt32>
[-SplitImageFilePattern <String>]
[-WIMBoot]
[-LogPath <String>]
[-ScratchDirectory <String>]
[-LogLevel <LogLevel>]
[<CommonParameters>] Description
The Export-WindowsImage cmdlet exports a copy of the specified image to another image file. The source and destination files must use the same compression type.
You can also optimize an image by exporting to a new image file with Export-WindowsImage. When you modify an image, DISM stores additional resource files that increase the overall size of the image. Exporting the image will remove unnecessary resource files.
This cmdlet does not apply to virtual hard disk (VHD) files.
Examples
Example 1: Export an image
PS C:\> Export-WindowsImage -SourceImagePath C:\imagestore\custom.wim -SourceIndex 1 -DestinationImagePath c:\imagestore\export.wim -DestinationName "Exported Image"This command exports the image at Index 1 of the file C:\imagestore\custom.wim to the file c:\imagestore\export.wim with the name Exported Image.
Parameters
-CheckIntegrity
Detects and tracks .wim file corruption when used with the Add-WindowsImage, Dismount-WindowsImage, or Save-WindowsImage cmdlet. CheckIntegrity stops the operation if DISM detects that the .wim file is corrupted when used with the Expand-WindowsImage or Mount-WindowsImage cmdlet.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CompressionType
Specifies the type of compression used for the initial capture operation. Acceptable values are:
- "max" or "maximum": Provides the high compression, but takes more time to capture the image
- "fast:" Provides faster image compression, but the resulting files are larger than those compressed by using the maximum option.
- "none": No compression is used at all. This is the default.
Note
This cmdlet does not support the "recovery" compression type. Use dism.exe instead.
the CompressionType parameter does not apply when you export an image to an existing .wim file, you can only use this CompressionType when you export an image to a new .wim file.
| Type: | String |
| Position: | Named |
| Default value: | "none" |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DestinationImagePath
Specifies the location of the exported image file.
| Type: | String |
| Aliases: | DIP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DestinationName
Specifies the name of the exported image in the exported image file.
| Type: | String |
| Aliases: | DN |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LogLevel
Specifies the maximum output level shown in the logs. The default log level is 3. The accepted values are as follows:
- 1 = Errors only
- 2 = Errors and warnings
- 3 = Errors, warnings, and information
- 4 = All of the information listed previously, plus debug output
| Type: | LogLevel |
| Aliases: | LL |
| Accepted values: | Errors, Warnings, WarningsInfo |
| Position: | Named |
| Default value: | 3 |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LogPath
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.
| Type: | String |
| Aliases: | LP |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ScratchDirectory
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Setbootable
Marks a volume image as being a bootable image. This argument is available only for Windows PE images. Only one volume image can be marked as bootable in a .wim file.
| Type: | SwitchParameter |
| Aliases: | SB |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceImagePath
Specifies the location of the source image file. Must be used in conjunction with -SourceIndex or -SourceName. If the source file is a SWM file, -SplitImageFilePattern is also required.
| Type: | String |
| Aliases: | SIP |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceIndex
Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1.
| Type: | UInt32 |
| Aliases: | SI |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceName
Specifies the name of the source image in the source image file.
| Type: | String |
| Aliases: | SN |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SplitImageFilePattern
Specifies the location and name of the base split image file.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-WIMBoot
Specifies that the image will be formatted to install on a Windows image file boot (WIMBoot) system.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Inputs
String[]
Microsoft.Dism.Commands.ImageObject
Microsoft.Dism.Commands.ImageObjectWithState
Outputs
Microsoft.Dism.Commands.OfflineImageObject