< Back
Start-NetEventSession
Post
NAME Start-NetEventSession
SYNOPSIS
Starts event and packet capture for a network event session.
SYNTAX
Start-NetEventSession [-Name] <String[]> [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore |
Suspend}] [-InformationVariable <System.String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Start-NetEventSession [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <System.String>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<System.Management.Automation.ActionPreference>]
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:
-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationVariable [<System.String>]
Specifies a variable in which to store an information event message.
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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=294405
Get-NetEventSession
New-NetEventSession
Remove-NetEventSession
Set-NetEventSession
Stop-NetEventSession
SYNOPSIS
Starts event and packet capture for a network event session.
SYNTAX
Start-NetEventSession [-Name] <String[]> [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore |
Suspend}] [-InformationVariable <System.String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Start-NetEventSession [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <System.String>] [-PassThru] [-ThrottleLimit <Int32>] [<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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<System.Management.Automation.ActionPreference>]
Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:
-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationVariable [<System.String>]
Specifies a variable in which to store an information event message.
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.
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.
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
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.
RELATED LINKS
Online Version: http://go.microsoft.com/fwlink/?LinkID=294405
Get-NetEventSession
New-NetEventSession
Remove-NetEventSession
Set-NetEventSession
Stop-NetEventSession