Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft NetEventPacketCapture reference: Adds a Remote Packet Capture provider. The syntax and selected example below are adapted from the pinned Windows Server 2025 reference. Module availability, target configuration and delegated permissions determine whether it can run in your environment. Documentation and parameter text: Microsoft, CC BY 4.0; formatting adapted by Cmdlet World. No execution testing is claimed.
Use an account with the target resource permissions documented for Add-NetEventPacketCaptureProvider. Modifying administrative cmdlets may require elevation or delegated administration. This catalog does not assert that ordinary users can execute the command.
Supported environments
Windows / NetEventPacketCapture · Windows Server 2025 documentation; feature/module prerequisites apply
Parameters
-AsJob
Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.
-CaptureType
Specifies whether the packet capture is enabled for physical network adapters, virtual switches, or both. The acceptable values for this parameter are: The acceptable values for this parameter are: - Physical. Captures packets from physical network adapters. - Switch. Captures packets from the virtual machine switch(es) on Hyper-V hosts. - BothPhysicalAndSwitch. Captures packets from both the physical network adapters and the virtual machine switch(es).
-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.
-Confirm
Prompts you for confirmation before running the cmdlet.
-EtherType
Specifies an array of ether types. The most common ether types and their values are IPv4 (0800), IPv6 (86DD) and ARP (0806).
-IpAddresses
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.
-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.
-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.
-LinkLayerAddress
Specifies an array of link layer, or Media Access Control (MAC), addresses. The packet capture provider logs network traffic that matches this filter.
-MatchAllKeyword
Specifies a bitmask that restricts the events that the provider logs. Set the MatchAnyKeyword parameter value to 0 (zero) to match all keywords.
-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 EnableTraceEx2 function) in the Microsoft Developer Network library.
-MultiLayer
Indicates whether the capture occurs at various layers of the stack. By default, this parameter has a value of $False.
-SessionName (required)
Specifies the name of the session associated with the packet capture provider.
-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.
-TruncationLength
Specifies the display length of each captured packet. The default size is 128 bytes.
-VmCaptureDirection
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.
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Prerequisites
Windows with the NetEventPacketCapture module and the Windows feature or management tools that provide it. Confirm target connectivity and version compatibility using the linked Microsoft reference.
Security considerations
This cmdlet changes system state. Review every target and parameter in the official reference, test outside production, and prepare an appropriate backup or rollback. Do not execute the example automatically.
This example adds a Remote Packet Capture provider to a session. The first command uses the New-NetEventSession cmdlet to create a new session named Session01. The second command adds a provider named Microsoft-Windows-TCPIP to the session named Session01 by using the Add-NetEventProvider cmdlet. The third command adds a packet capture provider to the session. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.