Remove-WindowsImage
Remove-WindowsImage
Deletes the specified volume image from a WIM file that has multiple volume images.
Syntax
Parameter Set: InputByFilePathAndIndex
Remove-WindowsImage -ImagePath <String> -Index <UInt32> [-CheckIntegrity] [-LogLevel <LogLevel> ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Parameter Set: InputByFilePathAndName
Remove-WindowsImage -ImagePath <String> -Name <String> [-CheckIntegrity] [-LogLevel <LogLevel> ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Detailed 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
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.
Aliases |
none |
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.
Aliases |
none |
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.
Aliases |
none |
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 only2 = Errors and warnings3 = Errors, warnings, and information4 = All of the information listed previously, plus debug output
Aliases |
LL |
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.
Aliases |
LP |
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.
Aliases |
none |
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.
Aliases |
none |
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, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
- System.String[]
- Microsoft.Dism.Commands.ImageObject
- Microsoft.Dism.Commands.ImageObjectWithState
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Dism.Commands.ImageObject
Examples
Example 1
This command removes the first image in c:\imagestore\custom.wim.
PS C:\> Remove-WindowsImage -ImagePath c:\imagestore\custom.wim -Index 1 -CheckIntegrity
Example 2
This command removes the image named Starter that is located in c:\imagestore\custom.wim.
PS C:\> Remove-WindowsImage -ImagePath c:\imagestore\custom.wim -Name "Starter" -CheckIntegrity