Set-PefTraceFilter

[アーティクル]
11/16/2015

Set-PefTraceFilter

Sets a Trace Filter for a PEF Trace Session.

構文

Parameter Set: Default
Set-PefTraceFilter [-PEFSession] <IPpkTraceSession> [[-Filter] <String> ] [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-Trigger <Trigger[]> ] [ <CommonParameters>]

詳細説明

The Set-PefTraceFilter cmdlet sets a Trace Filter to a Protocol Engineering Framework (PEF) Trace Session.

パラメーター

-Filter<String>

Specifies a string that acts as a Trace Filter. A Trace Filter defines the messages that a Trace Session retrieves according to the specified filtering criteria. To learn more about Trace Filters, see Creating and Applying Trace Filters in the Message Analyzer Operating Guide.

エイリアス	none
必須?	false
位置は?	2
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. このパラメーターに対して使用できる値:

-- SilentlyContinue
-- Stop
-- Continue
-- Inquire
-- Ignore
-- Suspend

エイリアス	infa
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-InformationVariable<System.String>

Specifies a variable in which to store an information event message.

エイリアス	iv
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-PEFSession<IPpkTraceSession>

Specifies an object that contains a Trace Session. To create a Trace Session, use the New-PefTraceSession cmdlet.

エイリアス	none
必須?	true
位置は?	1
既定値	none
パイプライン入力を許可する	True (ByValue)
ワイルドカード文字を許可する	false

-Trigger<Trigger[]>

Specifies an array of Trigger objects.

エイリアス	none
必須?	false
位置は?	named
既定値	none
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。

入力

入力型は、コマンドレットにパイプできるオブジェクトの型です。

出力

出力型は、コマンドレットによって生成されるオブジェクトの型です。

例

Example 1: Add a Trace Filter to a Trace Session that closes with a stop trigger

This example sets a Trace Filter to a PEF Trace Session that stops after a 150 second interval expires.

The first command uses the New-PefTraceSession cmdlet to create a Trace Session object, and then stores it in the $TraceSession01 variable. This command includes the SaveOnStop parameter and specifies a file path, IcmpTrace.matu in the current directory, for the saved Trace Session.

The second command uses the New-PefTimeSpanTrigger cmdlet to create a trigger with a TimeSpan value of 150 seconds. For information about how to use the New-TimeSpan cmdlet to specify a TimeSpan value, type Get-Help New-TimeSpan.

The third command sets a Trace Filter with the string value Icmp for the Trace Session stored in $TraceSession01. Note that this filter takes effect immediately when the Trace Session starts.

The fourth command uses the Add-PefMessageSource cmdlet to specify a provider for the Trace Session stored in $TraceSession01.

The fifth command uses the Stop-PefTraceSession cmdlet to create a stop action for the trigger stored in the $Trigger02 variable, and associates that action with the Trace Session stored in $TraceSession01.

The last command uses the Start-PefTraceSession cmdlet to start the Trace Session stored in $TraceSession01.

PS C:\> $TraceSession01 = New-PefTraceSession -Mode Circular -Path "C:\Traces\IcmpTrace.matu" -SaveOnStop
PS C:\> $Trigger02 = New-PefTimeSpanTrigger -TimeSpan (New-TimeSpan -Seconds 150)
PS C:\> Set-PefTraceFilter -PEFSession $TraceSession01 -Filter "Icmp"
PS C:\> Add-PefMessageSource -PEFSession $TraceSession01 –Source "Microsoft-Pef-WFP-MessageProvider"
PS C:\> Stop-PefTraceSession –PEFSession $TraceSession01 -Trigger $Trigger02
PS C:\> Start-PefTraceSession –PEFSession $TraceSession01

Set-PefTraceFilter