Set-NetEventPacketCaptureProvider

Artículo
11/16/2015

Set-NetEventPacketCaptureProvider

Modifies the configuration for a Remote Packet Capture provider.

Sintaxis

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

Descripción detallada

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

Parámetros

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

Alias	none
¿Requerido?	false
¿Posición?	named
Valor predeterminado	none
¿Aceptar canalización?	True (ByValue)
¿Aceptar caracteres comodín?	false

-AssociatedEventSession<CimInstance>

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

Alias	none
¿Requerido?	false
¿Posición?	named
Valor predeterminado	none
¿Aceptar canalización?	True (ByValue)
¿Aceptar caracteres comodín?	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.

Alias	none
¿Requerido?	false
¿Posición?	4008
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-CimSession<CimSession[]>

Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.

Alias	Session
¿Requerido?	false
¿Posición?	named
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	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).

Alias	none
¿Requerido?	false
¿Posición?	4011
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-IpAddresses<String[]>

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

Alias	none
¿Requerido?	false
¿Posición?	4012
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	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.

Alias	none
¿Requerido?	false
¿Posición?	4013
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	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.

Alias	none
¿Requerido?	false
¿Posición?	4005
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	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.

Alias	none
¿Requerido?	false
¿Posición?	4010
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MatchAllKeyword<UInt64>

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

Alias	none
¿Requerido?	false
¿Posición?	4007
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	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.

Alias	none
¿Requerido?	false
¿Posición?	4006
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-MultiLayer<Boolean>

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

Alias	none
¿Requerido?	false
¿Posición?	4009
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-PassThru

Devuelve un objeto que representa el elemento con el que está trabajando. De forma predeterminada, este cmdlet no genera ningún resultado.

Alias	none
¿Requerido?	false
¿Posición?	named
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-SessionName<String[]>

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

Alias	none
¿Requerido?	false
¿Posición?	1
Valor predeterminado	none
¿Aceptar canalización?	True (ByPropertyName)
¿Aceptar caracteres comodín?	false

-ThrottleLimit<Int32>

Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.

Alias	none
¿Requerido?	false
¿Posición?	named
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-TruncationLength<UInt16>

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

Alias	none
¿Requerido?	false
¿Posición?	4014
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-VmCaptureDirection<VmCaptureDirection>

Specifies the direction of network traffic for a Virtual Machine (VM) capture. Los valores aceptables para este parámetro son los siguientes:

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

Alias	none
¿Requerido?	false
¿Posición?	4015
Valor predeterminado	none
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-Confirm

Solicita confirmación antes de ejecutar el cmdlet.

¿Requerido?	false
¿Posición?	named
Valor predeterminado	falso
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

¿Requerido?	false
¿Posición?	named
Valor predeterminado	falso
¿Aceptar canalización?	false
¿Aceptar caracteres comodín?	false

<CommonParameters>

Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

<WorkflowParameters>

Este cmdlet admite los siguientes parámetros comunes de flujos de trabajo: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName e –InputObject. Para obtener más información, consulte about_WorkflowCommonParameters.

Entradas

El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.

Salidas

El tipo de resultado es el tipo de objetos que emite el cmdlet.

Ejemplos

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