Set-NetEventVFPProvider

Module:

NetEventPacketCapture

Modifies a VFP provider for network events.

Syntax

Set-NetEventVFPProvider
   [[-SessionName] <String[]>]
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [[-VFPFlowDirection] <VFPFlowDirection>]
   [[-DestinationMACAddresses] <String[]>]
   [[-TCPPorts] <UInt16[]>]
   [[-UDPPorts] <UInt16[]>]
   [[-SourceMACAddresses] <String[]>]
   [[-VLANIds] <UInt16[]>]
   [[-GREKeys] <UInt32[]>]
   [[-TenantIds] <UInt32[]>]
   [[-SourceIPAddresses] <String[]>]
   [[-DestinationIPAddresses] <String[]>]
   [[-IPProtocols] <Byte[]>]
   [[-SwitchName] <String>]
   [[-PortIds] <UInt32[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetEventVFPProvider
   [-AssociatedEventSession <CimInstance>]
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [[-VFPFlowDirection] <VFPFlowDirection>]
   [[-DestinationMACAddresses] <String[]>]
   [[-TCPPorts] <UInt16[]>]
   [[-UDPPorts] <UInt16[]>]
   [[-SourceMACAddresses] <String[]>]
   [[-VLANIds] <UInt16[]>]
   [[-GREKeys] <UInt32[]>]
   [[-TenantIds] <UInt32[]>]
   [[-SourceIPAddresses] <String[]>]
   [[-DestinationIPAddresses] <String[]>]
   [[-IPProtocols] <Byte[]>]
   [[-SwitchName] <String>]
   [[-PortIds] <UInt32[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Set-NetEventVFPProvider
   -InputObject <CimInstance[]>
   [[-Level] <Byte>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-MatchAllKeyword] <UInt64>]
   [[-VFPFlowDirection] <VFPFlowDirection>]
   [[-DestinationMACAddresses] <String[]>]
   [[-TCPPorts] <UInt16[]>]
   [[-UDPPorts] <UInt16[]>]
   [[-SourceMACAddresses] <String[]>]
   [[-VLANIds] <UInt16[]>]
   [[-GREKeys] <UInt32[]>]
   [[-TenantIds] <UInt32[]>]
   [[-SourceIPAddresses] <String[]>]
   [[-DestinationIPAddresses] <String[]>]
   [[-IPProtocols] <Byte[]>]
   [[-SwitchName] <String>]
   [[-PortIds] <UInt32[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NetEventVFPProvider cmdlet modifies a Virtual Filtering Platform (VFP) provider for network events.

Examples

Example 1: Modify a VFP provider

New-NetEventSession -Name "Session01"
Add-NetEventVFPProvider -SessionName "Session01"
Set-NetEventVFPProvider -SessionName "Session01" -SourceIPAddresses 182.168.0.1 -IPProtocols 6

The first command creates a network event session named Session01 by using the New-NetEventSession cmdlet.

The second command creates a VFP provider for the specified session.

The third command modifies the VFP provider with the specified source IP address and IP protocol.

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
Required:	False
Accept pipeline input:	False
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
Required:	False
Accept pipeline input:	True
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
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DestinationIPAddresses

Specifies destination IP addresses.

Type:	String[]
Position:	3012
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DestinationMACAddresses

Specifies destination MAC addresses.

Type:	String[]
Position:	3006
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GREKeys

Specifies Generic Routing Encapsulation (GRE) keys.

Type:	UInt32[]
Position:	3010
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-InputObject

Specifies the input object that is used in a pipeline command.

Type:	CimInstance[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-IPProtocols

Specifies an array of one or more IP protocols, such as TCP or UDP, on which to filter. The packet capture provider logs network traffic that matches this filter.

Type:	Byte[]
Position:	3013
Default value:	None
Required:	False
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:	3003
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-MatchAllKeyword

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

Type:	UInt64
Position:	3005
Default value:	None
Required:	False
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.

Type:	UInt64
Position:	3004
Default value:	None
Required:	False
Accept pipeline input:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-PortIds

Specifies port numbers.

Type:	UInt32[]
Position:	3018
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SessionName

Specifies the name of the session that is associated with the NetEventVFPProvider. This parameter has the same value as the Name parameter for the New-NetEventSession cmdlet.

Type:	String[]
Position:	0
Default value:	None
Required:	False
Accept pipeline input:	True
Accept wildcard characters:	False

-SourceIPAddresses

Specifies source IP addresses.

Type:	String[]
Position:	3011
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SourceMACAddresses

Specifies source MAC addresses.

Type:	String[]
Position:	3007
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SwitchName

Specifies the switch for this VFW provider.

Type:	String
Position:	3017
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TCPPorts

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.

Type:	UInt16[]
Position:	3014
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-TenantIds

Specifies tenant IDs.

Type:	UInt32[]
Position:	3009
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-UDPPorts

Specifies an array of UDP ports. The provider filters for and logs network traffic that matches the ports that this parameter specifies. The provider joins multiple port numbers with logical ORs.

Type:	UInt16[]
Position:	3015
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VFPFlowDirection

Specifies the WFP flow direction.

Type:	VFPFlowDirection
Accepted values:	Inbound, Outbound, InboundAndOutbound
Position:	3016
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-VLANIds

Specifies virtual local area network IDs.

Type:	UInt16[]
Position:	3008
Default value:	None
Required:	False
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
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

String[]

CimInstance

CimInstance[]

Outputs

CimInstance

CimInstance

Related Links

• Add-NetEventVFPProvider
• New-NetEventSession
• Get-NetEventVFPProvider
• Remove-NetEventVFPProvider