< Back
New-WindowsImage
Post
NAME New-WindowsImage
SYNOPSIS
Captures an image of a drive to a new WIM file.
SYNTAX
New-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-ConfigFilePath <String>] [-Description <String>] [-LogLevel {Errors | Warnings |
WarningsInfo}] [-LogPath <String>] [-NoRpFix] [-ScratchDirectory <String>] [-Setbootable] [-Verify] [-WIMBoot] -CapturePath <String> -ImagePath
<String> -Name <String> [<CommonParameters>]
DESCRIPTION
The New-WindowsImage cmdlet captures an image of a drive to a new WIM file. Captured directories include all subfolders and data. You cannot
capture an empty directory. A directory must contain at least one file.
This cmdlet does not apply to virtual hard disk (VHD) files.
PARAMETERS
-CapturePath <String>
Specifies the drive or path to the Windows operating system that is to be captured to an image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-ConfigFilePath [<String>]
Specifies the location of a configuration file that lists exclusions for image capture commands and compress commands. For more information,
see DISM Configuration List and WimScript.ini Files, http://go.microsoft.com/fwlink/?LinkID=313768
(http://go.microsoft.com/fwlink/?LinkID=313768) in the TechNet Library.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Description [<String>]
Specifies the description of the image to be captured.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ImagePath <String>
Specifies the location of a WIM file.
Required? true
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
-Name <String>
Specifies the name of an image in a WIM file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NoRpFix [<SwitchParameter>]
Disables the reparse point tag fix. A reparse point is a file that contains a link to another file on the file system. If the parameter is not
specified, reparse points that resolve to paths outside of the value specified by the ImagePath parameter will not be captured.
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
-Verify [<SwitchParameter>]
Checks for errors and file duplication.
During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked
against the image file to verify they are both equal.
During a capture operation, for example, when using the New-WindowsImage cmdlet, after the files is captured into a Windows image, the file
is written to a temporary file and compared on a bit-by-bit basis with the original 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 Format 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: Capture an image of a drive for a WIM file
PS C:\\>New-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -CapturePath "d:\\" -Name "Drive D"
This command captures the Drive D image in the WIM file located on d:\\ and save to the file c:\\imagestore\\custom.wim.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273951
Dismount-WindowsImage
Expand-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
Remove-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage
SYNOPSIS
Captures an image of a drive to a new WIM file.
SYNTAX
New-WindowsImage [-CheckIntegrity] [-CompressionType <String>] [-ConfigFilePath <String>] [-Description <String>] [-LogLevel {Errors | Warnings |
WarningsInfo}] [-LogPath <String>] [-NoRpFix] [-ScratchDirectory <String>] [-Setbootable] [-Verify] [-WIMBoot] -CapturePath <String> -ImagePath
<String> -Name <String> [<CommonParameters>]
DESCRIPTION
The New-WindowsImage cmdlet captures an image of a drive to a new WIM file. Captured directories include all subfolders and data. You cannot
capture an empty directory. A directory must contain at least one file.
This cmdlet does not apply to virtual hard disk (VHD) files.
PARAMETERS
-CapturePath <String>
Specifies the drive or path to the Windows operating system that is to be captured to an image file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-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
-ConfigFilePath [<String>]
Specifies the location of a configuration file that lists exclusions for image capture commands and compress commands. For more information,
see DISM Configuration List and WimScript.ini Files, http://go.microsoft.com/fwlink/?LinkID=313768
(http://go.microsoft.com/fwlink/?LinkID=313768) in the TechNet Library.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Description [<String>]
Specifies the description of the image to be captured.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ImagePath <String>
Specifies the location of a WIM file.
Required? true
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
-Name <String>
Specifies the name of an image in a WIM file.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-NoRpFix [<SwitchParameter>]
Disables the reparse point tag fix. A reparse point is a file that contains a link to another file on the file system. If the parameter is not
specified, reparse points that resolve to paths outside of the value specified by the ImagePath parameter will not be captured.
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
-Verify [<SwitchParameter>]
Checks for errors and file duplication.
During an apply operation, for example, using the Add-WindowsImage cmdlet, the size and the hash of the file being applied are checked
against the image file to verify they are both equal.
During a capture operation, for example, when using the New-WindowsImage cmdlet, after the files is captured into a Windows image, the file
is written to a temporary file and compared on a bit-by-bit basis with the original 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 Format 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: Capture an image of a drive for a WIM file
PS C:\\>New-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -CapturePath "d:\\" -Name "Drive D"
This command captures the Drive D image in the WIM file located on d:\\ and save to the file c:\\imagestore\\custom.wim.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273951
Dismount-WindowsImage
Expand-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
Remove-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage