< Back
Set-NetEventWFPCaptureProvider
Post
NAME Set-NetEventWFPCaptureProvider
SYNOPSIS
Modifies the configuration of a WFP capture provider.
SYNTAX
Set-NetEventWFPCaptureProvider [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>] [[-CaptureLayerSet] {IPv4Inbound |
IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts] <UInt16[]>] [-AssociatedEventSession
<CimInstance>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-NetEventWFPCaptureProvider [[-SessionName] <String[]>] [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>]
[[-CaptureLayerSet] {IPv4Inbound | IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts]
<UInt16[]>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-NetEventWFPCaptureProvider [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>] [[-CaptureLayerSet] {IPv4Inbound |
IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts] <UInt16[]>] [-CimSession
<CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable <String>] [-PassThru]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Set-NetEventWFPCaptureProvider cmdlet modifies the configuration of a Windows Firewall Platform (WFP) capture provider. For more information
about the NetEventWFPCaptureProvider, see the Add-NetEventWFPCaptureProvider cmdlet.
PARAMETERS
-AssociatedEventSession [<CimInstance>]
Specifies the associated network event session, as a CIM object. To obtain the network event session, use the Get-NetEventSession cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-CaptureLayerSet [<WFPCaptureSet>]
Specifies a WFP capture set, which designates the layers and directions to filter. The acceptable values for this parameter are:
-- IPv4Inbound
-- IPv4Outbound
-- IPv6Inbound
-- IPv6Outbound
You can logically OR the direction and IP layer pairs together. For instance, you could capture incoming loopback traffic from IPv6 to avoid
seeing duplicate traffic received by the loopback interface.
Required? false
Position? 3008
Default value none
Accept pipeline input? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<ActionPreference>]
Specifies how this cmdlet responds to an informational 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 [<String>]
Specifies a variable in which to store an informationa; event.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPAddresses [<String[]>]
Specifies an array of IP addresses. The provider filters for and logs network traffic that matches the IP addresses that this parameter
specifies. The provider joins multiple addresses by using logical OR.
Required? false
Position? 3009
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Level [<Byte>]
Specifies the Event Tracing for Windows (ETW) event error levels that NetEventWFPCaptureProvider returns. Use a level of detail specifier as a
filter the type of error events that are logged. The default value for this parameter is 0x4, for informational events. 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. Lower level events up to and
including the specified level are logged.
Required? false
Position? 3004
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAllKeyword [<UInt64>]
Specifies a keyword bitmask that restricts the events that the provider logs.
Required? false
Position? 3006
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 hexadecimal values that enable the
provider to write one or more events for which it is instrumented, if a match is found. Use a set of hexadecimal values for keywords instead
of the keyword names, and apply a filter to write ETW events for keyword matches. For more information, see EnableTraceEx2 function
(http://msdn.microsoft.com/en-us/library ... s.85).aspx) in the Microsoft Developer Network library.
Required? false
Position? 3005
Default value none
Accept pipeline input? false
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
-SessionName [<String[]>]
Specifies an array of session names that are associated with the NetEventWFPCaptureProvider. This parameter has the same value as the Name
parameter for the New-NetEventSession cmdlet.
Required? false
Position? 1
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TCPPorts [<UInt16[]>]
Specifies an array of TCP ports. The provider filters and logs network traffic that matches the ports that this parameter specifies. The
provider joins multiple port numbers with logical OR.
Required? false
Position? 3010
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
-UDPPorts [<UInt16[]>]
Specifies an array of UDP ports. The provider filters and logs network traffic that matches the ports that this parameter specifies. The
provider joins multiple port numbers with logical OR.
Required? false
Position? 3011
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: Modify a WFP capture provider
PS C:\\>New-NetEventSession -Name "WFPCapture" -CaptureMode RealtimeLocal -LocalFilePath "C:\\users\\DavidChew\\Documents\\wfpdata.etl"
PS C:\\> Add-NetEventWFPCaptureProvider -SessionName "WFPCapture"
PS C:\\> Set-NetEventWFPCaptureProvider -SessionName "WFPCapture" -CaptureLayerSet IPv4Inbound, IPv6Inbound -IPAddresses "127.0.0.1", "::1"
PS C:\\> Start-NetEventSession -Name "WFPCapture"
PS C:\\> ping 127.0.0.1
PS C:\\> ping ::1
PS C:\\> Stop-NetEventSession -Name "WFPCapture"
PS C:\\> Remove-NetEventSession -Name "WFPCapture"
The first command creates a network event session by using the New-NetEventSession cmdlet. This command also assigns the name WFPCapture to the
session.
The second command uses the current cmdlet to create a WFP capture provider for the session named WFPCapture.
The third command configures the provider for capture layer directional filtering and loopback IP addresses.
The fourth command starts the session named WFPCapture.
The fifth and commands use the ping utility to test the local host address in both IPv4 and IPv6. The provider should capture both of these local
test connections.
The final two commands stop the session named WFPCapture and remove it.
RELATED LINKS
Add-NetEventWFPCaptureProvider
Get-NetEventWFPCaptureProvider
Remove-NetEventWFPCaptureProvider
SYNOPSIS
Modifies the configuration of a WFP capture provider.
SYNTAX
Set-NetEventWFPCaptureProvider [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>] [[-CaptureLayerSet] {IPv4Inbound |
IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts] <UInt16[]>] [-AssociatedEventSession
<CimInstance>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-NetEventWFPCaptureProvider [[-SessionName] <String[]>] [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>]
[[-CaptureLayerSet] {IPv4Inbound | IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts]
<UInt16[]>] [-CimSession <CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}]
[-InformationVariable <String>] [-PassThru] [-ThrottleLimit <Int32>] [<CommonParameters>]
Set-NetEventWFPCaptureProvider [[-Level] <Byte>] [[-MatchAnyKeyword] <UInt64>] [[-MatchAllKeyword] <UInt64>] [[-CaptureLayerSet] {IPv4Inbound |
IPv4Outbound | IPv6Inbound | IPv6Outbound}] [[-IPAddresses] <String[]>] [[-TCPPorts] <UInt16[]>] [[-UDPPorts] <UInt16[]>] [-CimSession
<CimSession[]>] [-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable <String>] [-PassThru]
[-ThrottleLimit <Int32>] [<CommonParameters>]
DESCRIPTION
The Set-NetEventWFPCaptureProvider cmdlet modifies the configuration of a Windows Firewall Platform (WFP) capture provider. For more information
about the NetEventWFPCaptureProvider, see the Add-NetEventWFPCaptureProvider cmdlet.
PARAMETERS
-AssociatedEventSession [<CimInstance>]
Specifies the associated network event session, as a CIM object. To obtain the network event session, use the Get-NetEventSession cmdlet.
Required? false
Position? named
Default value none
Accept pipeline input? true(ByValue)
Accept wildcard characters? false
-CaptureLayerSet [<WFPCaptureSet>]
Specifies a WFP capture set, which designates the layers and directions to filter. The acceptable values for this parameter are:
-- IPv4Inbound
-- IPv4Outbound
-- IPv6Inbound
-- IPv6Outbound
You can logically OR the direction and IP layer pairs together. For instance, you could capture incoming loopback traffic from IPv6 to avoid
seeing duplicate traffic received by the loopback interface.
Required? false
Position? 3008
Default value none
Accept pipeline input? false
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.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-InformationAction [<ActionPreference>]
Specifies how this cmdlet responds to an informational 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 [<String>]
Specifies a variable in which to store an informationa; event.
Required? false
Position? named
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-IPAddresses [<String[]>]
Specifies an array of IP addresses. The provider filters for and logs network traffic that matches the IP addresses that this parameter
specifies. The provider joins multiple addresses by using logical OR.
Required? false
Position? 3009
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-Level [<Byte>]
Specifies the Event Tracing for Windows (ETW) event error levels that NetEventWFPCaptureProvider returns. Use a level of detail specifier as a
filter the type of error events that are logged. The default value for this parameter is 0x4, for informational events. 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. Lower level events up to and
including the specified level are logged.
Required? false
Position? 3004
Default value none
Accept pipeline input? false
Accept wildcard characters? false
-MatchAllKeyword [<UInt64>]
Specifies a keyword bitmask that restricts the events that the provider logs.
Required? false
Position? 3006
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 hexadecimal values that enable the
provider to write one or more events for which it is instrumented, if a match is found. Use a set of hexadecimal values for keywords instead
of the keyword names, and apply a filter to write ETW events for keyword matches. For more information, see EnableTraceEx2 function
(http://msdn.microsoft.com/en-us/library ... s.85).aspx) in the Microsoft Developer Network library.
Required? false
Position? 3005
Default value none
Accept pipeline input? false
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
-SessionName [<String[]>]
Specifies an array of session names that are associated with the NetEventWFPCaptureProvider. This parameter has the same value as the Name
parameter for the New-NetEventSession cmdlet.
Required? false
Position? 1
Default value none
Accept pipeline input? true(ByPropertyName)
Accept wildcard characters? false
-TCPPorts [<UInt16[]>]
Specifies an array of TCP ports. The provider filters and logs network traffic that matches the ports that this parameter specifies. The
provider joins multiple port numbers with logical OR.
Required? false
Position? 3010
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
-UDPPorts [<UInt16[]>]
Specifies an array of UDP ports. The provider filters and logs network traffic that matches the ports that this parameter specifies. The
provider joins multiple port numbers with logical OR.
Required? false
Position? 3011
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: Modify a WFP capture provider
PS C:\\>New-NetEventSession -Name "WFPCapture" -CaptureMode RealtimeLocal -LocalFilePath "C:\\users\\DavidChew\\Documents\\wfpdata.etl"
PS C:\\> Add-NetEventWFPCaptureProvider -SessionName "WFPCapture"
PS C:\\> Set-NetEventWFPCaptureProvider -SessionName "WFPCapture" -CaptureLayerSet IPv4Inbound, IPv6Inbound -IPAddresses "127.0.0.1", "::1"
PS C:\\> Start-NetEventSession -Name "WFPCapture"
PS C:\\> ping 127.0.0.1
PS C:\\> ping ::1
PS C:\\> Stop-NetEventSession -Name "WFPCapture"
PS C:\\> Remove-NetEventSession -Name "WFPCapture"
The first command creates a network event session by using the New-NetEventSession cmdlet. This command also assigns the name WFPCapture to the
session.
The second command uses the current cmdlet to create a WFP capture provider for the session named WFPCapture.
The third command configures the provider for capture layer directional filtering and loopback IP addresses.
The fourth command starts the session named WFPCapture.
The fifth and commands use the ping utility to test the local host address in both IPv4 and IPv6. The provider should capture both of these local
test connections.
The final two commands stop the session named WFPCapture and remove it.
RELATED LINKS
Add-NetEventWFPCaptureProvider
Get-NetEventWFPCaptureProvider
Remove-NetEventWFPCaptureProvider