Enable-SbecBootImage
Enables AutoLogger settings in offline WinPE Setup images.
Syntax
Default (Default)
Enable-SbecBootImage
[-Path] <String[]>
[[-Logger] <String[]>]
[[-PermLogger] <String[]>]
[-NoDefaultLoggers]
[[-DismLogPath] <String>]
[<CommonParameters>]
Description
The Enable-SbecBootImage cmdlet enables the AutoLogger settings and creates the Winpeshl.ini files in offline WinPE Setup images to forward events to the Setup and Boot Event Collector.
The default event log sessions that are configured for sending events to the Boot Event Collector are NT Kernel Logger, EventLog-System, and SetupPlatform. You can configure other loggers with the parameters Logger and PermLogger. Loggers are always switched to real-time mode, regardless of whether they previously wrote to a file.
The AutoLogger settings enable event forwarding during the first stage of Setup when it boots from the WinPE image. The Winpeshl.ini files facilitate the configuration of events on the HDD image through Unattend.xml.
Examples
Example 1: Enable Boot Event Collector in a WIM image
PS C:\> Enable-SbecBootImage -Path "C:\Images\Boot.wim"
This command enables the Boot Event Collector for the Boot.wim image.
Parameters
-DismLogPath
Specifies the path of the Deployment Image Servicing and Management (DISM) log file to use when mounting images.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Logger
Specifies the AutoLogger sessions for which to enable forwarding. The forwarding on these sessions auto-disables after the operating system starts. Specifying a session explicitly in Logger or PermLogger overrides the defaults for it.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-NoDefaultLoggers
Indicates that this operation does not automatically add the default set of logger sessions.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
Specifies an array of full paths to the offline Windows image (WIM or VHD) files to which to apply the settings. If a WIM file contains multiple images, all of them are modified.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 0 |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PermLogger
Specifies the AutoLogger sessions for which to enable forwarding. The forwarding on these sessions remains enabled after the operating system starts. Specifying a session explicitly in Logger or PermLogger overrides the defaults for it.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.