Skip to content

Latest commit

 

History

History
337 lines (261 loc) · 10.1 KB

Optimize-Offline-help.md

File metadata and controls

337 lines (261 loc) · 10.1 KB
Raw
external help file Module Name online version schema
Optimize-Offline-help.xml
Optimize-Offline
2.0.0

Optimize-Offline

SYNOPSIS

Offline optimization framework for Windows 10 image versions 1803-to-2004 with 64-bit architectures contained within WIM and ESD files.

SYNTAX

Optimize-Offline [-SourcePath] <FileInfo> [[-WindowsApps] <String>] [-SystemApps] [-Capabilities] [-Packages]
 [-Features] [-DeveloperMode] [-WindowsStore] [-MicrosoftEdge] [-Win32Calc] [-Dedup] [[-DaRT] <String[]>]
 [-Registry] [[-Additional] <Hashtable>] [-ComponentCleanup] [[-ISO] <String>] [<CommonParameters>]

DESCRIPTION

The Optimize-Offline module enables the offline optimization of Windows 10 image (WIM/SWM/ESD) files to customize runtime environments.

Optimize-Offline expands the user experience by eliminating unnecessary bloat, enhancing privacy, improving aesthetics and increasing system performance.

Image optimization is configurable using the Configuration.json file in the module root directory.

All images are optimized independently - without the need for 3rd party programs - by utilizing custom module resources.

EXAMPLES

EXAMPLE 1

.\Start-Optimize.ps1

This command automatically starts optimizing an image by importing the configuration JSON file into the module.

EXAMPLE 2

Optimize-Offline -SourcePath "D:\Images\Windows 10 1903\18362.1.190318-1202.19H1_RELEASE_CLIENTMULTI_X64FRE_EN-US.iso" -WindowsApps "Select" -SystemApps -Capabilities -Packages -Features -Win32Calc -Dedup -DaRT "Setup" -Registry -Additional @{ Setup = $true; RegistryTemplates = $true; LayoutModification = $true; Drivers = $true } -ISO "No-Prompt"

This command starts optimizing an image by manually passing parameters to the module.

PARAMETERS

-SourcePath

The full path to a Windows 10 Installation Media ISO, or a Windows 10 WIM, SWM or ESD file.

Type: FileInfo
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-WindowsApps

Selectively or automatically deprovisions Windows Apps and removes their associated provisioning packages (.appx or .appxbundle). The acceptable values for this parameter are: Select, Whitelist and All.

  • Select: Populates and outputs a Gridview list of all Provisioned Windows App Packages for selective removal.
  • Whitelist: Automatically removes all Provisioned Windows App Packages NOT found in the AppxWhiteList.json file.
  • All: Automatically removes all Provisioned Windows App Packages found in the image.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-SystemApps

Populates and outputs a Gridview list of System Apps for selective removal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Capabilities

Populates and outputs a Gridview list of Capability Packages for selective removal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Packages

Populates and outputs a Gridview list of Windows Cabinet File Packages for selective removal.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Features

Populates and outputs a Gridview list of Windows Optional Features for selective disabling and enabling.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DeveloperMode

Integrates the Developer Mode Feature into the image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-WindowsStore

Integrates the Microsoft Windows Store and its required dependencies into the image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-MicrosoftEdge

Integrates the Microsoft Edge HTML or Chromium Browser into the image.

For Windows 10 Enterprise LTSC 2019, the Microsoft Edge HTML Browser will be integrated into the image. For non-LTSC Windows 10 builds 18362-to-19041, the Microsoft Edge Chromium Browser will be integrated into the image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Win32Calc

Integrates the traditional Win32 Calculator into the image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Dedup

Integrates the Windows Server Data Deduplication Feature into the image.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-DaRT

Integrates the Microsoft Diagnostic and Recovery Toolset (DaRT 10) and Windows 10 Debugging Tools into Windows Setup and Windows Recovery. This parameter accepts one or two values allowing for integration into a single environment or both environments. The acceptable values for this parameter are: Setup and Recovery.

  • Setup: Integrates DaRT 10 and Windows 10 Debugging Tools into Windows Setup only.
  • Recovery: Integrates DaRT 10 and Windows 10 Debugging Tools into Windows Recovery only.
  • Setup, Recovery: Integrates DaRT 10 and Windows 10 Debugging Tools into both Windows Setup and Windows Recovery.
Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Registry

Applies optimized settings to the image registry hives.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-Additional

Integrates user-specific content added to the "Content/Additional" directory into the image when enabled within the hashtable. The acceptable parameters for this hashtable are: Setup, Wallpaper, SystemLogo, LockScreen, RegistryTemplates, LayoutModification, Unattend, Drivers and NetFx3.

  • Setup: Integrates Windows Setup files, scripts or content into the image.
  • Wallpaper: Integrates custom wallpaper into the image.
  • SystemLogo: Integrates a custom system logo into the image.
  • LockScreen: Converts and integrates a custom lockscreen into the image.
  • RegistryTemplates: Imports custom registry template (.reg) files into the registry hives of the image.
  • LayoutModification: Imports a custom LayoutModification.xml to provision the Start layout.
  • Unattend: Applies an answer file directly to the image.
  • Drivers: Injects driver packages into the image.
  • NetFx3: Integrates the .NET Framework 3 payload packages into the image and enables the NetFx3 optional feature.
Type: Hashtable
Parameter Sets: (All)
Aliases:

Required: False
Position: 4
Default value: @{ Setup = $false; Wallpaper = $false; SystemLogo = $false; LockScreen = $false; RegistryTemplates = $false; LayoutModification = $false; Unattend = $false; Drivers = $false; NetFx3 = $false }
Accept pipeline input: False
Accept wildcard characters: False

-ComponentCleanup

Performs a clean-up of the Component Store by compressing all superseded components.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ISO

Creates a new bootable Windows Installation Media ISO. The acceptable values for this parameter are: Prompt and No-Prompt.

  • Prompt: The efisys.bin binary bootcode is written to the ISO which requires a key press when booted to begin Windows Setup.
  • No-Prompt: The efisys_noprompt.bin binary bootcode is written to the ISO which does not require a key press when booted and will begin Windows Setup automatically.
Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This module supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.IO.FileInfo, System.Collections.Specialized.OrderedDictionary

You can pipe a System.IO.FileInfo object to this module.

OUTPUTS

None

This module does not generate any output.

NOTES

Integration of Microsoft Windows Store and the Microsoft Edge HTML Browser are only applicable to Windows 10 Enterprise LTSC 2019. Integration of the Microsoft Edge Chromium Browser is only applicable to Windows 10 non-LTSC builds 18362-to-19041. When the Microsoft Edge Browser (HTML or Chromium) is integrated into the image, its permanence is set to 'permanent' by default. NetFx3 integration is only applicable if a Windows Installation Media ISO is used as the source image. Bootable ISO media creation is only applicable if a Windows Installation Media ISO is used as the source image.

RELATED LINKS

ReadMe

Help Topics

ChangeLog