Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Start-NetEventSession

Start-NetEventSession

msft_neteventpacketcaptureprovider.cdxml, msft_neteventnetworkadapter.cdxml, msft_neteventvmswitch.cdxml, msft_neteventvmnetworkadatper.cdxml, msft_neteventsession.cdxml, msft_neteventprovider.cdxml

Synopsis

Starts event and packet capture for a network event session.

Syntax

Start-NetEventSession [-Name] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Start-NetEventSession [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Start-NetEventSession cmdlet starts event and packet capture for a network event session. A session controls how the computer logs events and, optionally, network traffic, or packets. Use the New-NetEventSession cmdlet to create a session. Before you can start logging, add network event providers to a session. A network event provider logs events and network traffic as Event Tracing for Windows (ETW) events.

If a session is currently running, you cannot start it. Use the Get-NetEventSession cmdlet to see session status.

Parameters

-CimSession <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.

Aliases

Session

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies an array of names of sessions to start.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

True (ByPropertyName)

Accept wildcard characters?

false

-PassThru <SwitchParameter>

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-ThrottleLimit <Int32>

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.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

Shows what would happen if the cmdlet runs. The cmdlet is not run.Shows what would happen if the cmdlet runs. The cmdlet is not run.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Start a session

This example creates a session, adds a provider to it, and then starts the session.

The first command creates a session named Session38 by using the New-NetEventSession cmdlet.

The second command adds a provider to the session by using the Add-NetEventProvider cmdlet. A session must have a provider in order to log events.

The third command starts the session named Session38.

PS C:\>New-NetEventSession -Name "Session38"
PS C:\> Add-NetEventProvider -Name "Microsoft-Windows-TCPIP" -SessionName "Session38"
PS C:\> Start-NetEventSession -Name "Session38"

Online Version
Get-NetEventSession
New-NetEventSession
Remove-NetEventSession
Set-NetEventSession
Stop-NetEventSession