PowerShell Logo Small

New-NetEventSession



This is the built-in help made by Microsoft for the command 'New-NetEventSession', in PowerShell version 5 - as retrieved from Windows version 'Microsoft Windows Server 2012 R2 Standard' PowerShell help files on 2016-06-23.

For PowerShell version 3 and up, where you have Update-Help, this command was run just before creating the web pages from the help files.

SYNOPSIS

Creates a network event session.

SYNTAX


New-NetEventSession [-Name] <String> [-CaptureMode {RealtimeRPC | SaveToFile | RealtimeLocal}] [-CimSession [<CimSession[]>]] [-LocalFilePath [<String>]] [-MaxFileSize
[<UInt32>]] [-MaxNumberOfBuffers [<Byte>]] [-ThrottleLimit [<Int32>]] [-TraceBufferSize [<UInt32>]] [-Confirm] [-WhatIf] [<CommonParameters>]



Search powershellhelp.space

DESCRIPTION


The New-NetEventSession cmdlet creates a network event session. A session controls how the computer logs events and, optionally, network traffic, or packets. Add network
event providers to a session. A network event provider logs events and network traffic as Event Tracing for Windows (ETW) events. The session stores these events in an .etl
file or provides them to an application that displays them.


Assign a name for the session. Only one session can exist at a time. Remove an existing session by using the Remove-NetEventSession cmdlet. You can specify the maximum
number of buffers in a session and the size of the trace buffer.


You can also specify whether to use an.etl file and, if you do, specify its location and maximum size. Instead of an .etl file, you can select a type of live display.


After you create a session, you can use the Set-NetEventSession cmdlet to modify the session settings. After you create a session, add one or more providers to it by using
the Add-NetEventProvider cmdlet. Use the Start-NetEventSession and Stop-NetEventSession cmdlets to start and stop logging.



<

RELATED LINKS

Online Version: http://go.microsoft.com/fwlink/?LinkID=294394
Get-NetEventSession
Remove-NetEventSession
Set-NetEventSession
Start-NetEventSession
Stop-NetEventSession
Add-NetEventProvider

REMARKS

<

Examples


Example 1: Create a session

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



This command creates session named Session38. Use the Add-NetEventProvider cmdlet to add a provider for the session.