Get-WindowsImage
Get-WindowsImage
Gets information about a Windows image in a WIM or VHD file.
Syntax
Parameter Set: InputByFilePath
Get-WindowsImage -ImagePath <String> [-LogLevel <LogLevel> {Errors | Warnings | WarningsInfo} ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Parameter Set: InputByFilePathAndIndex
Get-WindowsImage -ImagePath <String> -Index <UInt32> [-LogLevel <LogLevel> {Errors | Warnings | WarningsInfo} ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Parameter Set: InputByFilePathAndName
Get-WindowsImage -ImagePath <String> -Name <String> [-LogLevel <LogLevel> {Errors | Warnings | WarningsInfo} ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Parameter Set: InputByMounted
Get-WindowsImage -Mounted [-LogLevel <LogLevel> {Errors | Warnings | WarningsInfo} ] [-LogPath <String> ] [-ScratchDirectory <String> ] [ <CommonParameters>]
Detailed Description
The Get-WindowsImage cmdlet gets information about a Windows image in a WIM or VHD file.
Use the Mounted parameter to get information about any Windows images that are mapped to directories on the local computer.
Use the ImagePath parameter to get information about images in a specific WIM or VHD file.
Use the Index or Name parameter to get detailed information about a specific image in a WIM or VHD file. For a VHD file, the Index must be 1.
Parameters
-ImagePath<String>
Specifies the location of a WIM or VHD 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 |
none |
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 |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
true(ByPropertyName) |
Accept Wildcard Characters? |
false |
-Mounted
Gets information, including the mount path, for all images mapped to a directories on the local computer.
Aliases |
none |
Required? |
true |
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 or VHD 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
Outputs
The output type is the type of the objects that the cmdlet emits.
- Microsoft.Dism.Commands.ImageInfoObject
- Microsoft.Dism.Commands.MountedImageInfoObject
- Microsoft.Dism.Commands.WimImageInfoObject
- Microsoft.Dism.Commands.BasicImageInfoObject
Examples
Example 1: Get information about all mounted images
This command gets information, including mount path, about all of the Windows images mounted on the local computer.
PS C:\> Get-WindowsImage -Mounted
Example 2: Get information about a specific mounted image
This command gets detailed information about the Windows image named Ultimate in the install.wim file at c:\imagestore.
PS C:\> Get-WindowsImage –ImagePath "c:\imagestore\install.wim" –Name "Ultimate"
Example 3: Get information about a specific image
This command gets basic information about the Windows image in the install.vhd file at c:\imagestore.
PS C:\> Get-WindowsImage –ImagePath "c:\imagestore\install.vhd"