Set-Net Event Provider

Module:
neteventpacketcapture
Modifies settings for an ETW provider.

Syntax 

Set-NetEventProvider
   [[-Name] <String[]>]
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetEventProvider
   [-AssociatedEventSession <CimInstance>]
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetEventProvider
   [-AssociatedCaptureTarget <CimInstance>]
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NetEventProvider
   -InputObject <CimInstance[]>
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Examples

Example 1: Modify an ETW provider 

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

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.

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

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
-AssociatedCaptureTarget

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.

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

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

Type: CimInstance
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
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
-Level

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.

Type: Byte
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MatchAllKeyword

Specifies a bitmask that restricts the events that the provider logs. Set the MatchAnyKeyword parameter value to 0 (zero) to match all keywords.

Type: UInt64
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-MatchAnyKeyword

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 CLR ETW Keywords and Levels in the Microsoft Developer Network library.

Type: UInt64
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Name

Specifies an array of names that identify ETW providers.

Type: String[]
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
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