Add-NetEventPacketCaptureProvider

Add-NetEventPacketCaptureProvider

Adds a Remote Packet Capture provider.

Syntaxe

Parameter Set: cim:CreateInstance0
Add-NetEventPacketCaptureProvider [-SessionName] <String> [[-Level] <Byte> ] [[-MatchAnyKeyword] <UInt64> ] [[-MatchAllKeyword] <UInt64> ] [[-CaptureType] <CaptureType> {Physical | Switch | BothPhysicalAndSwitch} ] [[-MultiLayer] <Boolean> ] [[-LinkLayerAddress] <String[]> ] [[-EtherType] <UInt16[]> ] [[-IpAddresses] <String[]> ] [[-IpProtocols] <Byte[]> ] [[-TruncationLength] <UInt16> ] [[-VmCaptureDirection] <VmCaptureDirection> {Ingress | Egress | IngressAndEgress} ] [-CimSession <CimSession[]> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Description détaillée

The Add-NetEventPacketCaptureProvider cmdlet adds a Remote Packet Capture provider. You can only use one packet capture provider at a time and you must remove an existing provider before you use this cmdlet to add a new provider. To remove an existing Remote Packet Capture provider, use the Remove-NetEventPacketCaptureProvider cmdlet.

Paramètres

-CaptureType<CaptureType>

Specifies a capture type. Acceptable values for this parameter are:

-- SaveToFile. Writes events to a local .etl file.
-- RealtimeRPC. Creates a real-time capture session and forwards the events to a remote host as they are recorded.
-- RealtimeLocal. Creates a real-time capture session and forwards the events to a local Event Tracing for Windows (ETW) listener as they are recorded.

-CimSession<CimSession[]>

Exécute l’applet de commande dans une session à distance ou sur un ordinateur distant. Entrez un nom d’ordinateur ou un objet de session, comme la sortie d’une applet de commande New-CimSession ou Get-CimSession. La valeur par défaut est la session active sur l’ordinateur local.

-EtherType<UInt16[]>

Specifies an array of ether types. The most common ether types and their values are IPv4 (0800), IPv6 (86DD) and ARP (0806).

-IpAddresses<String[]>

Specifies an array of IP addresses on which to filter. The packet capture provider logs network traffic that matches this filter.

-IpProtocols<Byte[]>

Specifies an array of one or more IP protocols, such as TCP or UDP, on which to filter. The packet capture provider logs network traffic that matches this filter.

-Level<Byte>

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

-LinkLayerAddress<String[]>

Specifies an array of link layer, or Media Access Control (MAC), addresses. The packet capture provider logs network traffic that matches this filter.

-MatchAllKeyword<UInt64>

Specifies a bitmask that restricts the events that the provider logs. Set the MatchAnyKeyword parameter value to 0 (zero) to match all keywords.

-MatchAnyKeyword<UInt64>

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. For more information, see https://msdn.microsoft.com/en-us/library/windows/desktop/dd392305(v=vs.85).aspx in the Microsoft Developer Library.

-MultiLayer<Boolean>

Indicates whether the capture occurs at various layers of the stack. This setting has a value of $False by default.

-SessionName<String>

Specifies the name of the session associated with the packet capture provider.

-ThrottleLimit<Int32>

Spécifie le nombre maximal d’opérations simultanées qui peuvent être établies pour exécuter cette applet de commande. Si ce paramètre est omis ou si la valeur 0 est entrée, Windows PowerShell ® calcule une limitation optimale pour l’applet de commande en fonction du nombre d’applets de commande CIM qui s’exécutent sur l’ordinateur. La limitation s’applique seulement à l’applet de commande actuelle, et non pas à la session ni à l’ordinateur.

-TruncationLength<UInt16>

Specifies the display length of each captured packet. The default size is 128 bytes.

-VmCaptureDirection<VmCaptureDirection>

Specifies the direction of network traffic for a Virtual Machine (VM) capture. Les valeurs acceptables pour ce paramètre sont :

-- Ingress. Network traffic from a VM to a virtual switch.
-- Egress. Network traffic from a virtual switch to a VM.

-Confirm

Votre confirmation sera requise avant l’exécution de l’applet de commande.

-WhatIf

Présente les conséquences éventuelles de l’exécution de l’applet de commande. L’applet de commande n’est pas exécutée.

<CommonParameters>

Cette applet de commande prend en charge les paramètres courants : -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer et -OutVariable. Pour plus d’informations, consultez about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

Cette applet de commande prend en charge les paramètres de workflow courants suivants : -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName et –InputObject. Pour plus d’informations, consultez  about_WorkflowCommonParameters.

Entrées

Le type d’entrée correspond au type des objets que vous pouvez transmettre à l’applet de commande.

Sorties

Le type de sortie est le type des objets émis par l’applet de commande.

Exemples

Example 1: Add a packet capture provider

This example adds a Remote Packet Capture provider to a session.

The first command uses the New-NetEventSession cmdlet to create a new session named Session01.

The second command adds a provider named Microsoft-Windows-TCPIP to the session named Session01 by using the Add-NetEventProvider cmdlet.

The third command adds a packet capture provider to the session.

PS C:\> New-NetEventSession -SessionName "Session01"
PS C:\> Add-NetEventProvider -Name "Microsoft-Windows-TCPIP" -SessionName "Session01"
PS C:\> Add-NetEventPacketCaptureProvider -SessionName "Session01"

Rubriques connexes

Add-NetEventProvider

Get-NetEventPacketCaptureProvider

New-NetEventSession

Remove-NetEventPacketCaptureProvider

Set-NetEventPacketCaptureProvider