Set-NetEventPacketCaptureProvider
Set-NetEventPacketCaptureProvider
Modifies the configuration for a Remote Packet Capture provider.
構文
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>]
詳細説明
The Set-NetEventPacketCaptureProvider cmdlet modifies the configuration for a Remote Packet Capture provider.
パラメーター
-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.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
false |
-AssociatedEventSession<CimInstance>
Specifies the associated network event session, as a CIM object. To obtain the network event session, use the Get-NetEventSession cmdlet.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
True (ByValue) |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
4008 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-CimSession<CimSession[]>
リモート セッションまたはリモート コンピューターでコマンドレットを実行します。New-CimSession コマンドレットや Get-CimSession コマンドレットの出力など、コンピューター名またはセッション オブジェクトを入力します。既定値は、ローカル コンピューターで実行中の現在のセッションです。
エイリアス |
Session |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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).
エイリアス |
none |
必須? |
false |
位置は? |
4011 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-IpAddresses<String[]>
Specifies an array of IP addresses on which to filter. The packet capture provider logs network traffic that matches this filter.
エイリアス |
none |
必須? |
false |
位置は? |
4012 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
4013 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
4005 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
4010 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MatchAllKeyword<UInt64>
Specifies a bitmask that restricts the events that the provider logs.
エイリアス |
none |
必須? |
false |
位置は? |
4007 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
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.
エイリアス |
none |
必須? |
false |
位置は? |
4006 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-MultiLayer<Boolean>
Indicates whether the capture should occur at various layers in the stack. This setting has a value of $False by default.
エイリアス |
none |
必須? |
false |
位置は? |
4009 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-PassThru
作業中の項目を表すオブジェクトを返します。既定では、このコマンドレットによる出力はありません。
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-SessionName<String[]>
Specifies the name of the session associated with the packet capture provider.
エイリアス |
none |
必須? |
false |
位置は? |
1 |
既定値 |
none |
パイプライン入力を許可する |
True (ByPropertyName) |
ワイルドカード文字を許可する |
false |
-ThrottleLimit<Int32>
このコマンドレットを実行するために確立できる最大同時操作数を指定します。このパラメーターを省略するか、値として 0 を入力した場合、Windows PowerShell® では、コンピューターで実行している CIM コマンドレットの数に基づいて、コマンドレットに対する最適なスロットル制限を計算します。スロットル制限は現在のコマンドレットのみに適用され、セッションまたはコンピューターには適用されません。
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-TruncationLength<UInt16>
Specifies the display length of each captured packet. The default size is 128 bytes.
エイリアス |
none |
必須? |
false |
位置は? |
4014 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-VmCaptureDirection<VmCaptureDirection>
Specifies the direction of network traffic for a Virtual Machine (VM) capture. このパラメーターに対して使用できる値:
-- Ingress. Network traffic from a VM to a virtual switch.
-- Egress. Network traffic from a virtual switch to a VM.
エイリアス |
none |
必須? |
false |
位置は? |
4015 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-Confirm
コマンドレットを実行する前に、ユーザーに確認を求めます。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-WhatIf
コマンドレットを実行するとどのような結果になるかを表示します。コマンドレットは実行されません。
必須? |
false |
位置は? |
named |
既定値 |
false |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
<WorkflowParameters>
このコマンドレットは次のワークフロー共通パラメーターをサポートします。-PSParameterCollection、-PSComputerName、-PSCredential、-PSConnectionRetryCount、-PSConnectionRetryIntervalSec、-PSRunningTimeoutSec、-PSElapsedTimeoutSec、-PSPersist、-PSAuthentication、-PSAuthenticationLevel、-PSApplicationName、-PSPort、-PSUseSSL、-PSConfigurationName、-PSConnectionURI、-PSAllowRedirection、-PSSessionOption、-PSCertificateThumbprint、-PSPrivateMetadata、-AsJob、-JobName、–InputObject。詳細については、以下を参照してください。 about_WorkflowCommonParameters。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
例
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
PS C:\>
PS C:\>
PS C:\>
関連トピック
Add-NetEventPacketCaptureProvider
Get-NetEventPacketCaptureProvider