Add-NetEventNetworkAdapter
Add-NetEventNetworkAdapter
Adds a network adapter as a filter on a provider.
Syntax
Parameter Set: cim:CreateInstance0
Add-NetEventNetworkAdapter [-Name] <String> [[-PromiscuousMode] <System.Boolean> ] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]
Detailed 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<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 the name of a network adapter to add.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PromiscuousMode<System.Boolean>
Specifies whether the network adapter uses promiscuous mode. Promiscuous mode starts when the packet capture session starts. When the packet capture session stops, the network adapter is restored to its original setting for promiscuous mode.
This cmdlet supports this parameter for the Windows 8.1 operating system and the Windows Server 2012 R2 operating system only. You must install the hotfix in the topic Promiscuous mode is not set on network adapter to monitor network traffic in Windows Server 2012 R2 (https://support.microsoft.com/en-us/kb/3047154) in the Microsoft Support library.
Aliases |
none |
Required? |
false |
Position? |
2 |
Default Value |
none |
Accept Pipeline Input? |
false |
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
Prompts you for confirmation before running the cmdlet.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Required? |
false |
Position? |
named |
Default Value |
false |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
<WorkflowParameters>
This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see about_WorkflowCommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
Example 1: Add a network adapter
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.
PS C:\> New-NetEventSession -Name "Session38"
PS C:\> Add-NetEventPacketCaptureProvider -SessionName "Session38"
PS C:\> Add-NetEventNetworkAdapter -Name "Ethernet01"