Edit

Get-NetEventVmNetworkAdapter

  • Reference
Module:
NetEventPacketCapture

Gets virtual network adapters from a provider.

Syntax

Get-NetEventVmNetworkAdapter
   [[-Name] <String[]>]
   [-ShowInstalled]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]
Get-NetEventVmNetworkAdapter
   [-AssociatedPacketCaptureProvider <CimInstance>]
   [-ShowInstalled]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [<CommonParameters>]

Description

The Get-NetEventVmNetworkAdapter cmdlet gets network adapters of a virtual machine from a Remote Packet Capture provider. Specify the names of the virtual network adapters.

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.

Examples

Example 1: Get a virtual network adapter from the provider

PS C:\>New-NetEventSession -Name "NESession01"
PS C:\> Add-NetEventPacketCaptureProvider -SessionName "NESession01"
PS C:\> Add-NetEventVMNetworkAdapter -Name "LargeGuid"
PS C:\> Add-NetEventVMNetworkAdapter -Name "LargeGuid02"
PS C:\> Get-NetEventVMNetworkAdapter

This example gets a virtual network adapter from 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 uses the Add-NetEventVmNetworkAdapter cmdlet to add the virtual network adapter named LargeGuid as a filter on the Remote Packet Capture provider.

The fourth command uses the Add-NetEventVmNetworkAdapter cmdlet to add the virtual network adapter named LargeGuid02 as a filter on the Remote Packet Capture provider.

The fifth command gets the virtual network adapters from the Remote Packet Capture provider.

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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-AssociatedPacketCaptureProvider

Specifies the associated packet capture provider as a CIM object. To obtain the packet capture provider, use the Get-NetEventPacketCaptureProvider cmdlet.

Type:CimInstance
Position:Named
Default value:None
Required:False
Accept pipeline input:True
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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Name

Specifies an array of names of virtual network adapters.

Type:String[]
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False

-ShowInstalled

Indicates that the cmdlet displays all network adapters that are installed on the computer.

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