Set-NetEventPacketCaptureProvider

Article
06/30/2015

Set-NetEventPacketCaptureProvider

Modifies the configuration for a Remote Packet Capture provider.

Syntax

Parameter Set: BySessionName
Set-NetEventPacketCaptureProvider [[-SessionName] <String[]> ] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [[-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} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: BySessionOfTheProvider
Set-NetEventPacketCaptureProvider [-AssociatedEventSession <CimInstance> ] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [[-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} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: ByTargetOfTheProvider
Set-NetEventPacketCaptureProvider [-AssociatedCaptureTarget <CimInstance> ] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [[-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} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Set-NetEventPacketCaptureProvider [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [[-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} ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Detailed Description

The Set-NetEventPacketCaptureProvider cmdlet modifies the configuration for a Remote Packet Capture provider.

Parameters

-AssociatedCaptureTarget<CimInstance>

Specifies the associated capture target as a CIM object. The capture target is one of the three following objects:

-- MSFT_NetEventNetworkAdapter
-- MSFT_NetEventVmNetworkAdapter
-- MSFT_NetEventVmSwitch

To obtain a capture target, use the Get-NetEventNetworkAdapter cmdlet, the Get-NetEventVmNetworkAdapter cmdlet, or the Get-NetEventVmSwitch cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-AssociatedEventSession<CimInstance>

Specifies the associated network event session, as a CIM object. To obtain the network event session, use the Get-NetEventSession cmdlet.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	True (ByValue)
Accept Wildcard Characters?	false

-CaptureType<CaptureType>

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

Aliases	none
Required?	false
Position?	4008
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-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

-EtherType<UInt16[]>

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

Aliases	none
Required?	false
Position?	4011
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-IpAddresses<String[]>

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

Aliases	none
Required?	false
Position?	4012
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	4013
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	4005
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	4010
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MatchAllKeyword<UInt64>

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

Aliases	none
Required?	false
Position?	4007
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

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

Aliases	none
Required?	false
Position?	4006
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-MultiLayer<Boolean>

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

Aliases	none
Required?	false
Position?	4009
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.

Aliases	none
Required?	false
Position?	named
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-SessionName<String[]>

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

Aliases	none
Required?	false
Position?	1
Default Value	none
Accept Pipeline Input?	True (ByPropertyName)
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

-TruncationLength<UInt16>

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

Aliases	none
Required?	false
Position?	4014
Default Value	none
Accept Pipeline Input?	false
Accept Wildcard Characters?	false

-VmCaptureDirection<VmCaptureDirection>

Specifies the direction of network traffic for a Virtual Machine (VM) capture. The acceptable values for this parameter are:

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

Aliases	none
Required?	false
Position?	4015
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: Modify a packet capture provider

This example modifies a packet capture provider.

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

The second command uses the Add-NetEventProvider cmdlet to add a TCP/IP Net provider to the session.

The third command uses the Add-NetEventPacketCaptureProvider cmdlet to add a packet capture provider to a session named Session01.

The fourth command modifies the packet capture provider settings.

PS C:\> New-NetEventSession -SessionName "Session01"
PS C:\> Add-NetEventProvider -Name "Microsoft-Windows-TCPIP" -SessionName "Session01"
PS C:\> Add-NetEventPacketCaptureProvider -SessionName "Session01"
PS C:\> Set-NetEventPacketCaptureProvider -SessionName "Session01" -IpAddresses 182.168.0.1 -IpProtocol 6