Edit

Get-NetEventSession

  • Reference
Module:
NetEventPacketCapture

Gets network event sessions.

Syntax

Get-NetEventSession
   [[-Name] <String[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetEventSession
   [-AssociatedEventProvider <CimInstance>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NetEventSession cmdlet gets network event sessions. A session controls how the computer logs events and, optionally, network traffic, or packets.

Use this cmdlet to display configuration settings for the session. The configuration settings include the following:

  • Whether the session writes logs to a local file or sends events to live display.
  • For local file logging, the maximum size and location of the .etl file.
  • The maximum number of buffers and size of a buffer.

You can also use this cmdlet to see whether the session is running, such as after you run the Start-NetEventSession cmdlet.

Examples

Example 1: Display settings for a session

PS C:\>Get-NetEventSession -Name "Session38"

This command displays the settings of the session named Session38.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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

-AssociatedEventProvider

Specifies the associated network event provider as a CIM object. To obtain the network event provider, use the Get-NetEventProvider cmdlet.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of names of sessions to get.

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

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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