Windows PowerShell command on Get-command Expand-WindowsImage

NAME

Expand-WindowsImage

SYNOPSIS

Applies an image to a specified location.

SYNTAX

Expand-WindowsImage [-CheckIntegrity] [-Compact] [-ConfirmTrustedFile] [-LogLevel {Errors | Warnings |

WarningsInfo}] [-LogPath ] [-NoRpFix] [-ScratchDirectory ] [-SplitImageFilePattern ]

[-Verify] [-WIMBoot] -ApplyPath -ImagePath -Index []

Expand-WindowsImage [-CheckIntegrity] [-Compact] [-ConfirmTrustedFile] [-LogLevel {Errors | Warnings |

WarningsInfo}] [-LogPath ] [-NoRpFix] [-ScratchDirectory ] [-SplitImageFilePattern ]

[-Verify] [-WIMBoot] -ApplyPath -ImagePath -Name []

DESCRIPTION

The Expand-WindowsImage cmdlet applies an image to a specified location.

This cmdlet does not apply to virtual hard disk (VHD) files.

PARAMETERS

-ApplyPath

Specifies the location where the image is to be applied. Required? true Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-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.

Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Compact []

Indicates that this cmdlet applies the operating system image to the specified drive with individual operating system files compressed. If you do not specify this parameter, this cmdlet lays down all of the files in the image without compression. Required? false Position? named Default value none

Accept pipeline input? true(ByPropertyName)

Accept wildcard characters? false

-ConfirmTrustedFile []

Specifies that this cmdlet validates the image for Trusted Desktop on a Windowsr 8 or Windowsr 8.1. This option can only be run on a computer running at least Windowsr Preinstallation Environment (Windows PE) 4.0. Required? false Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-ImagePath

Specifies the location of a WIM file. Required? true Position? named Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-Index

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 []

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 []

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

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 []

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 []

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

-SplitImageFilePattern []

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

-Verify []

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 []

Specifies that the offline image to be added 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 This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

System.String[] Microsoft.Dism.Commands.ImageObject

Microsoft.Dism.Commands.ImageObjectWithState

OUTPUTS

Microsoft.Dism.Commands.OfflineImageObject

Example 1: Apply an image in a file to a partion

PS C:\>Expand-WindowsImage -ImagePath "c:\imagestore\custom.wim" -ApplyPath "d:\" -Index 1

This command applies an image at index 1 in the c:\imagestore\custom.wim file to partition d:.

Example 2: Apply a split image

PS C:\>Expand-WindowsImage -ImagePath "c:\imagestore\split\custom.swm" -SplitImageFilePattern

"c:\imagestore\split\custom*.swm" -ApplyPath "d:\" -Name "Windows Pro" -Verify

This command applies the split image with a name that matches c:\imagestore\split\custom*.swm with a name of

Windows Pro to partition d:. Check for errors and file duplication while applying the image.