Edit

Share via

Get-SbecLogSession

  • Reference
Module:
BootEventCollector

Gets the running log sessions.

Syntax

Get-SbecLogSession
   [[-Name] <String>]
   [-KdOnly]
   [[-SimulateError] <Int32>]
   [<CommonParameters>]

Description

The Get-SbecLogSession cmdlet gets the ETW log sessions that are currently running. This operation does not get log sessions defined in the registry for AutoLogger.

This cmdlet returns the SbecEtwTrace.TraceSessionInfo objects, whose properties contain most of the interesting information. More details are available in the Trace property.

Parameters

-KdOnly

Indicates that this operation gets only log sessions that are configured to forward events through the kernel transport to the collector.

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

-Name

Specifies the name of a log session.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-SimulateError

Simulate a Windows error, and cause the function to throw. You can specify this parameter to test error handling.

Type:Int32
Position:1
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None.

Outputs

SbecEtwTrace.TraceSessionInfo

The SbecEtwTrace.TraceSessionInfo class is defined in $PsHome\Modules\BootEventCollector\SbecTraceHelpers.psm1.