Creates a virtual machine switch provider for network events.
Networking / Security · Risk: High · Documentation Verified
Last verified: 2026-10-26
Microsoft NetEventPacketCapture reference: Creates a virtual machine switch provider for network events. 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-NetEventVmSwitchProvider. 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.
-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.
-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.
-MatchAllKeywords
Specifies a bitmask that restricts the events that the provider logs.
-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.
-PortIds
Specifies port numbers.
-SessionName (required)
Specifies the name of the session that is associated with the NetEventVMSwitchProvider. This parameter has the same value as the Name parameter for the New-NetEventSession cmdlet.
-SwitchName
Specifies the switch for this virtual machine switch 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.
-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.
The first command creates a network event session named Session01 by using the New-NetEventSession cmdlet. The second command creates a virtual machine switch by using the Add-NetEventVMSwitch cmdlet. The third command creates a virtual machine switch provider for the specified switch. Source: Microsoft, CC BY 4.0; transcript prompt/output removed. This example was not executed.