Edit

Share via

Get-SbecLogSession

Module:
BootEventCollector Module

Gets the running log sessions.

Syntax

Default (Default) 

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.

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

-Name

Specifies the name of a log session.

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:0
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SimulateError

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

Parameter properties

Type:Int32
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

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.

Inputs

None.

Outputs

SbecEtwTrace.TraceSessionInfo

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