Cmdlets

Choose a cmdlet from the list on the left or search for a specific cmdlet. Choose a cmdlet from the list or search for a specific cmdlet.
About Help  Providers
 

Add-NetEventVmSwitch

Add-NetEventVmSwitch

msft_neteventnetworkadapter.cdxml, msft_neteventpacketcaptureprovider.cdxml, msft_neteventprovider.cdxml, msft_neteventsession.cdxml, msft_neteventvmnetworkadatper.cdxml, msft_neteventvmswitch.cdxml

Synopsis

Adds a Hyper-V virtual switch as a filter on a provider.

Syntax

Add-NetEventVmSwitch [-Name] [-CimSession] [-ThrottleLimit] [-Confirm] [-WhatIf] [<CommonParameters>]

Detailed Description

The Add-NetEventVmSwitch cmdlet adds a Hyper-V virtual switch as a filter on a Remote Packet Capture provider. Use this cmdlet multiple times to add multiple Hyper-V virtual switches. To get existing Hyper-V virtual switches, use the Get-NetEventVmSwitch cmdlet.

The protocol stack uses multiple layers to transmit, receive, and process network traffic as packets. The provider logs network traffic as Event Tracing for Windows (ETW) events.

Parameters

-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.

Aliases

Session

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Name <String>

Specifies a name for the Hyper-V virtual switch.

Aliases

none

Required?

true

Position

1

Default value

none

Accept pipeline input?

True (ByPropertyName)

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.

Aliases

none

Required?

false

Position

named

Default value

none

Accept pipeline input?

false

Accept wildcard characters?

false

-Confirm <SwitchParameter>

Prompts you for confirmation before running the cmdlet.Prompts you for confirmation before running the cmdlet.

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

-WhatIf <SwitchParameter>

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

Aliases

None

Required?

false

Position

named

Default value

false

Accept pipeline input?

false

Accept wildcard characters?

false

Input Type


Return Type


Notes

None

Examples

Example 1: Add a Hyper-V virtual switch on a provider

This example adds a Hyper-V virtual switch as a filter on the Remote Packet Capture provider for a network session. After you complete these commands to configure the network session, you can start and stop the event and packet capture for the network session by using the Start-NetEventSession and Stop-NetEventSession cmdlets.

The first command uses the New-NetEventSession cmdlet to create a network session named NESession01.

The second command uses the Add-NetEventPacketCaptureProvider cmdlet to add a Remote Packet Capture provider for the session named NESession01.

The third command adds a Hyper-V virtual switch as a filter on the Remote Packet Capture provider.

PS C:\>New-NetEventSession -Name "NESession01"
PS C:\> Add-NetEventPacketCaptureProvider -SessionName "NESession01"
PS C:\> Add-NetEventVMSwitch -Name “Network Adapter 2 - Virtual Switch"

Online Version
Get-NetEventVmSwitch
Remove-NetEventVmSwitch