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
 

Set-NetEventProvider

Set-NetEventProvider

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

Synopsis

Modifies settings for an ETW provider.

Syntax

Set-NetEventProvider [-Name] [-Level] [-MatchAnyKeyword] [-MatchAllKeyword] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetEventProvider [-Level] [-MatchAnyKeyword] [-MatchAllKeyword] [-AssociatedCaptureTarget] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetEventProvider [-Level] [-MatchAnyKeyword] [-MatchAllKeyword] [-AssociatedEventSession] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Set-NetEventProvider [-Level] [-MatchAnyKeyword] [-MatchAllKeyword] [-CimSession] [-PassThru] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Set-NetEventProvider cmdlet modifies settings for an Event Tracing for Windows (ETW) provider.

Parameters

-AssociatedCaptureTarget <CimInstance>

Specifies the associated capture target as a CIM object. The capture target is one of the three following objects: -- MSFT_NetEventNetworkAdapter -- MSFT_NetEventVmNetworkAdapter -- MSFT_NetEventVmSwitch To obtain a capture target, use the Get-NetEventNetworkAdapter cmdlet, the Get-NetEventVmNetworkAdapter cmdlet, or the Get-NetEventVmSwitch cmdlet.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-AssociatedEventSession <CimInstance>

Specifies the associated network event session, as a CIM object. To obtain the network event session, use the Get-NetEventSession cmdlet.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

True (ByValue)

Accept wildcard characters?

false

-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. The 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. Set the MatchAnyKeyword parameter value to 0 (zero) to match all keywords.

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. For more information, see HYPERLINK "http://msdn.microsoft.com/en-us/library/ff357720.aspxhttp://msdn.microsoft.com/en-us/library/ff357720.aspx" http://msdn.microsoft.com/en-us/library/ff357720.aspx in the Microsoft Developer Library.

Aliases

none

Required?

false

Position

4

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String[]>

Specifies an array of names that identify ETW providers.

Aliases

none

Required?

false

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: Modify an ETW provider

This example modifies an ETW provider.

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

The second command uses the Add-NetEventProvider cmdlet to add a provider named Microsoft-Windows-TCPIP to the session named Session01.

The third command modifies the logging level for the provider named Microsoft-Windows-TCPIP.

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

Online Version
Add-NetEventProvider
Get-NetEventProvider
New-NetEventSession
Remove-NetEventProvider
Get-NetEventNetworkAdapter
Get-NetEventVmNetworkAdapter
Get-NetEventVmSwitch
Get-NetEventSession