Set-Net Event Packet Capture Provider

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

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

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.

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

Specifies the capture type. The acceptable values for this parameter are:

• SaveToFile. Writes events to a local .etl file.
• RealtimeRPC. Creates a real-time capture session and forwards the events to a remote host as they are recorded.
• RealtimeLocal. Creates a real-time capture session and forwards the events to a local Event Tracing for Windows (ETW) listener as they are recorded.

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.

Prompts you for confirmation before running the cmdlet.

Specifies an array of ether types. The most common ether types and their values are IPv4 (0800), IPv6 (86DD) and ARP (0806).

Specifies an array of IP addresses. The provider logs network traffic that matches the addresses that this cmdlet specifies. The provider joins multiple addresses by using logical OR.

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.

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.

Specifies an array of link layer, or Media Access Control (MAC), addresses. The packet capture provider logs network traffic that matches this filter.

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

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.

Indicates whether the capture should occur at various layers in the stack. By default, this parameter has a value of $False.

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Specifies an array of names of sessions associated with packet capture providers.

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.

Specifies the display length of each captured packet. The default size is 128 bytes.

Specifies the direction of network traffic for a virtual machine capture. The acceptable values for this parameter are:

• Ingress. Network traffic from a virtual machine to a virtual switch.
• Egress. Network traffic from a virtual switch to a virtual machine.

Shows what would happen if the cmdlet runs. The cmdlet is not run.