< Back
Optimize-WindowsImage
Post
NAME Optimize-WindowsImage
SYNOPSIS
Configures a Windows image with specified optimizations.
SYNTAX
Optimize-WindowsImage [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] [-SystemDrive <String>]
[-WindowsDirectory <String>] -OptimizationTarget <String> -Path <String> [<CommonParameters>]
DESCRIPTION
The Optimize-WindowsImage cmdlet performs specified configurations to an offline image.
Optimize-WindowsImage only applies to Windows 8.1 Update images that have been captured or exported as a Windows image file boot (WIMBoot) file.
Only use Optimize-WindowsImage with images that will be used for WIMBoot supported systems. If Optimize-WindowsImage is used with a non-WIMBoot
supported system image, Windows may not work as expected, after installation on a non-WIMBoot supported device.
PARAMETERS
-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
-OptimizationTarget <String>
Specifies the Windows image optimization type. The accepted values are as follows: "WIMBoot". Note: This value must be entered as a string
value.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String>
Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a
subdirectory of the root directory, -WindowsDirectory must be specified.
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
-SystemDrive [<String>]
Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than
the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsDirectory [<String>]
Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a
relative path. If not specified, the default is the Windows directory in the root of the offline image 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
Microsoft.Dism.Commands.ImageObject
OUTPUTS
Microsoft.Dism.Commands.ImageObject
Example 1: Configure an image as a WIMBoot system
PS C:\\>Optimize-WindowsImage -Path "c:\\" -OptimizationTarget "WIMBoot"
This command configures the Windows image located in the c:\\ directory as a WIMBoot system.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=389089
SYNOPSIS
Configures a Windows image with specified optimizations.
SYNTAX
Optimize-WindowsImage [-LogLevel {Errors | Warnings | WarningsInfo}] [-LogPath <String>] [-ScratchDirectory <String>] [-SystemDrive <String>]
[-WindowsDirectory <String>] -OptimizationTarget <String> -Path <String> [<CommonParameters>]
DESCRIPTION
The Optimize-WindowsImage cmdlet performs specified configurations to an offline image.
Optimize-WindowsImage only applies to Windows 8.1 Update images that have been captured or exported as a Windows image file boot (WIMBoot) file.
Only use Optimize-WindowsImage with images that will be used for WIMBoot supported systems. If Optimize-WindowsImage is used with a non-WIMBoot
supported system image, Windows may not work as expected, after installation on a non-WIMBoot supported device.
PARAMETERS
-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
-OptimizationTarget <String>
Specifies the Windows image optimization type. The accepted values are as follows: "WIMBoot". Note: This value must be entered as a string
value.
Required? true
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String>
Specifies the full path to the root directory of the offline Windows image that you will service. If the directory named Windows is not a
subdirectory of the root directory, -WindowsDirectory must be specified.
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
-SystemDrive [<String>]
Specifies the path to the location of the BootMgr files. This is necessary only when the BootMgr files are located on a partition other than
the one that you are running the command from. Use -SystemDrive to service an installed Windows image from a Windows PE environment.
Required? false
Position? named
Default value none
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-WindowsDirectory [<String>]
Specifies the path to the Windows directory relative to the image path. This cannot be the full path to the Windows directory; it should be a
relative path. If not specified, the default is the Windows directory in the root of the offline image 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
Microsoft.Dism.Commands.ImageObject
OUTPUTS
Microsoft.Dism.Commands.ImageObject
Example 1: Configure an image as a WIMBoot system
PS C:\\>Optimize-WindowsImage -Path "c:\\" -OptimizationTarget "WIMBoot"
This command configures the Windows image located in the c:\\ directory as a WIMBoot system.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/p/?linkid=389089