Windows PowerShell command on Get-command Add-NetEventNetworkAdapter

NAME

Add-NetEventNetworkAdapter

SYNOPSIS

Adds a network adapter as a filter on a provider.

SYNTAX

Add-NetEventNetworkAdapter [-Name] [[-PromiscuousMode] ] [-CimSession ]

[-InformationAction {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend}] [-InformationVariable

] [-ThrottleLimit ] []

DESCRIPTION

The Add-NetEventNetworkAdapter cmdlet adds a network adapter as a filter on a Remote Packet Capture provider. The

protocol stack uses multiple layers to transmit, receive, and process network traffic, or packets. The provider logs network traffic as Event Tracing for Windows (ETW) events. Use this cmdlet multiple times to add several adapters. To see which adapters currently belong to a provider, use

the Get-NetEventNetworkAdapter cmdlet.

When you add an adapter to provider in a session that is currently running, stop and start the session for your

changes to take effect. Use the Stop-NetEventSession cmdlet to stop a session and the Start-NetEventSession cmdlet

to restart it.

PARAMETERS

-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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-InformationAction []

Specifies how this cmdlet responds to an information event. The acceptable values for this parameter are:

-- SilentlyContinue

-- Stop

-- Continue

-- Inquire

-- Ignore

-- Suspend

Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-InformationVariable []

Specifies a variable in which to store an information event message. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false

-Name

Specifies the name of a network adapter to add. Required? true Position? 1 Default value none

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false

-PromiscuousMode []

Specifies whether the network adapter uses promiscuous mode. Required? false Position? 2 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. Required? false Position? named Default value none Accept pipeline input? false Accept wildcard characters? false This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

OUTPUTS

Example 1: Add a network adapter

PS C:\>New-NetEventSession -Name "Session38"

PS C:\> Add-NetEventPacketCaptureProvider -SessionName "Session38"

PS C:\> Add-NetEventNetworkAdapter -Name "Ethernet01"

This example creates a network event session, adds a provider, and then adds a network adapter.

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

The second command adds a provider to the session named Session38 by using the Add-NetEventPacketCaptureProvider

cmdlet. A session must have a provider in order to capture packets. The third command adds a network adapter. After you create and configure the session, use the

Start-NetEventSession cmdlet to start capturing packets.