< Back
Export-WindowsImage
Post
NAME Export-WindowsImage
SYNOPSIS
Exports a copy of the specified image to another image file.
SYNTAX
Export-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-DestinationName <String>] [-LogLevel {Errors | Warnings | WarningsInfo}]
[-LogPath <String>] [-ScratchDirectory <String>] [-Setbootable] [-SplitImageFilePattern <String>] [-WIMBoot] -DestinationImagePath <String>
-SourceImagePath <String> -SourceIndex <UInt32> [<CommonParameters>]
Export-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-DestinationName <String>] [-LogLevel {Errors | Warnings | WarningsInfo}]
[-LogPath <String>] [-ScratchDirectory <String>] [-Setbootable] [-SplitImageFilePattern <String>] [-WIMBoot] -DestinationImagePath <String>
-SourceImagePath <String> -SourceName <String> [<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.
PARAMETERS
-CheckIntegrity [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CompressionType [<String>]
dep_dism_ps_compression_type
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestinationImagePath <String>
Specifies the location of the exported image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestinationName [<String>]
Specifies the name of the exported image in the exported image file.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LogLevel [<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
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LogPath [<String>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScratchDirectory [<String>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Setbootable [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceImagePath <String>
Specifies the location of the source image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceIndex <UInt32>
Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceName <String>
Specifies the name of the source image in the source image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SplitImageFilePattern [<String>]
Specifies the location and name of the base split image file.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WIMBoot [<SwitchParameter>]
Specifies that the image will be formatted to install on a Windows image file boot (WIMBoot) system.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String[]
Microsoft.Dism.Commands.ImageObject
Microsoft.Dism.Commands.ImageObjectWithState
OUTPUTS
Microsoft.Dism.Commands.OfflineImageObject
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273949
Dismount-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
New-WindowsImage
Remove-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage
SYNOPSIS
Exports a copy of the specified image to another image file.
SYNTAX
Export-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-DestinationName <String>] [-LogLevel {Errors | Warnings | WarningsInfo}]
[-LogPath <String>] [-ScratchDirectory <String>] [-Setbootable] [-SplitImageFilePattern <String>] [-WIMBoot] -DestinationImagePath <String>
-SourceImagePath <String> -SourceIndex <UInt32> [<CommonParameters>]
Export-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-DestinationName <String>] [-LogLevel {Errors | Warnings | WarningsInfo}]
[-LogPath <String>] [-ScratchDirectory <String>] [-Setbootable] [-SplitImageFilePattern <String>] [-WIMBoot] -DestinationImagePath <String>
-SourceImagePath <String> -SourceName <String> [<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.
PARAMETERS
-CheckIntegrity [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-CompressionType [<String>]
dep_dism_ps_compression_type
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestinationImagePath <String>
Specifies the location of the exported image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DestinationName [<String>]
Specifies the name of the exported image in the exported image file.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LogLevel [<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
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-LogPath [<String>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ScratchDirectory [<String>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Setbootable [<SwitchParameter>]
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.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceImagePath <String>
Specifies the location of the source image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceIndex <UInt32>
Specifies the index number of a Windows image in a WIM or VHD file. For a VHD file, the Index must be 1.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SourceName <String>
Specifies the name of the source image in the source image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SplitImageFilePattern [<String>]
Specifies the location and name of the base split image file.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WIMBoot [<SwitchParameter>]
Specifies that the image will be formatted to install on a Windows image file boot (WIMBoot) system.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
System.String[]
Microsoft.Dism.Commands.ImageObject
Microsoft.Dism.Commands.ImageObjectWithState
OUTPUTS
Microsoft.Dism.Commands.OfflineImageObject
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273949
Dismount-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
New-WindowsImage
Remove-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage