< Back
Remove-WindowsImage
Post
NAME Remove-WindowsImage
SYNOPSIS
Deletes the specified volume image from a WIM file that has multiple volume images.
SYNTAX
Remove-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] -ImagePath
<String> -Index <UInt32> [<CommonParameters>]
Remove-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] -ImagePath
<String> -Name <String> [<CommonParameters>]
DESCRIPTION
The Remove-WindowsImage cmdlet deletes the specified volume image from a WIM file that has multiple volume images. This cmdlet deletes only the
metadata entries and XML entries. It does not delete the stream data and does not optimize the WIM file.
This command-line option 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
-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
-Index <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
-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
-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
<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.ImageObject
Example 1: Remove the first image from a WIM file
PS C:\\>Remove-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -Index 1 -CheckIntegrity
This command removes the first image in c:\\imagestore\\custom.wim.
Example 2: Remove an image from a WIM file by name
PS C:\\>Remove-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -Name "Starter" -CheckIntegrity
This command removes the image named Starter that is located in c:\\imagestore\\custom.wim.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273952
Add-WindowsImage
Dismount-WindowsImage
Expand-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
New-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage
SYNOPSIS
Deletes the specified volume image from a WIM file that has multiple volume images.
SYNTAX
Remove-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] -ImagePath
<String> -Index <UInt32> [<CommonParameters>]
Remove-WindowsImage [-CheckIntegrity] [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] -ImagePath
<String> -Name <String> [<CommonParameters>]
DESCRIPTION
The Remove-WindowsImage cmdlet deletes the specified volume image from a WIM file that has multiple volume images. This cmdlet deletes only the
metadata entries and XML entries. It does not delete the stream data and does not optimize the WIM file.
This command-line option 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
-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
-Index <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
-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
-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
<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.ImageObject
Example 1: Remove the first image from a WIM file
PS C:\\>Remove-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -Index 1 -CheckIntegrity
This command removes the first image in c:\\imagestore\\custom.wim.
Example 2: Remove an image from a WIM file by name
PS C:\\>Remove-WindowsImage -ImagePath "c:\\imagestore\\custom.wim" -Name "Starter" -CheckIntegrity
This command removes the image named Starter that is located in c:\\imagestore\\custom.wim.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=273952
Add-WindowsImage
Dismount-WindowsImage
Expand-WindowsImage
Export-WindowsImage
Get-WindowsImage
Dismount-WindowsImage
New-WindowsImage
Repair-WindowsImage
Save-WindowsImage
Split-WindowsImage