Start-Net Event Session

Module:
neteventpacketcapture
Starts event and packet capture for a network event session.

Syntax 

Start-NetEventSession
     [-Name] <String[]>
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]
Start-NetEventSession
     -InputObject <CimInstance[]>
     [-CimSession <CimSession[]>]
     [-ThrottleLimit <Int32>]
     [-AsJob]
     [-PassThru]
     [-WhatIf]
     [-Confirm]
     [<CommonParameters>]

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.

Examples

Example 1: Start a session 

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

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.

Required Parameters

-InputObject

Specifies the input object that is used in a pipeline command.

Type: CimInstance[]
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Name

Specifies an array of names of sessions to start.

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

Optional 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
Accept pipeline input: False
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
Accept pipeline input: False
Accept wildcard characters: False
-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Aliases: cf
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-PassThru

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

Type: SwitchParameter
Position: Named
Default value: None
Accept pipeline input: False
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
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf

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

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