Add-NetEventVmSwitchProvider

Creates a virtual machine switch provider for network events.

Syntax

Add-NetEventVmSwitchProvider
   [-SessionName] <String>
   [[-Level] <Byte>]
   [[-MatchAllKeywords] <UInt64>]
   [[-MatchAnyKeyword] <UInt64>]
   [[-SwitchName] <String>]
   [[-PortIds] <UInt32[]>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Add-NetEventVmSwitchProvider cmdlet creates a virtual machine switch provider for network events.

Examples

Example 1: Add a virtual machine switch provider

New-NetEventSession -Name "Session01"
Add-NetEventVMSwitch -Name "Network Adapter 2 - Virtual Switch"
Add-NetEventVmSwitchProvider -SessionName "Session01" -SwitchName "Network Adapter 2 - Virtual Switch"

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.

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
Accept pipeline input:False
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
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
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:1
Default value:None
Accept pipeline input:False
Accept wildcard characters:False

-MatchAllKeywords

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

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

-PortIds

Specifies port numbers.

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

-SessionName

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.

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

-SwitchName

Specifies the switch for this virtual machine switch provider.

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

Inputs

None

Outputs

Object