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
 

Add-NetEventProvider

Add-NetEventProvider

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

Synopsis

Adds an ETW provider to a session.

Syntax

Add-NetEventProvider [-Name] [-SessionName] [-Level] [-MatchAnyKeyword] [-MatchAllKeyword] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-NetEventProvider cmdlet adds an Event Tracing for Windows (ETW) provider to a session.

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

-Level <Byte>

Specifies the level of Event Tracing for Windows (ETW) events for the provider. Use the level of detail for the event to filter the events that are logged. The default value for this parameter is 0x4. Acceptable values for this parameter are: -- 0x5. Verbose -- 0x4. Informational -- 0x3. Warning -- 0x2. Error -- 0x1. Critical -- 0x0. LogAlways

The provider must log the event if the value of the event is less than or equal to the value of this parameter.

Aliases

none

Required?

false

Position

3

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-MatchAllKeyword <UInt64>

Specifies a bitmask that restricts the events that the provider logs.

Aliases

none

Required?

false

Position

5

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-MatchAnyKeyword <UInt64>

Specifies keywords as a set of hexadecimal values. Keywords are flags that you can combine to generate values. Use a set of hexadecimal values of the keywords instead of the keyword names, and apply a filter to write ETW events for keyword matches.

Aliases

none

Required?

false

Position

4

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies a name that identifies an ETW provider.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-SessionName <String>

Specifies the name of the session associated with the packet capture provider.

Aliases

none

Required?

true

Position

2

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: Add an ETW provider to a session

This example adds an ETW provider to a session.

The first command uses the New-NetEventSession cmdlet to create a new session named Session01.

The second command adds an ETW provider named Microsoft-Windows-TCPIP to the session named Session01.

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

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