Set-PefTraceFilter

Set-PefTraceFilter

Sets a Trace Filter for a PEF Trace Session.

Syntax

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

Detaillierte Beschreibung

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

Parameter

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

-InformationAction<System.Management.Automation.ActionPreference>

Specifies how this cmdlet responds to an information event. Die folgenden Werte für diesen Parameter sind zulässig:

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

-InformationVariable<System.String>

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

-PEFSession<IPpkTraceSession>

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

-Trigger<Trigger[]>

Specifies an array of Trigger objects.

<CommonParameters>

Dieses Cmdlet unterstützt die allgemeinen Parameter: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, -OutVariable. Weitere Informationen finden Sie unter about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Eingaben

Der Eingabetyp ist der Typ der Objekte, die über die Pipeline an das Cmdlet übergeben werden können.

Ausgaben

Der Ausgabetyp ist der Typ der Objekte, die vom Cmdlet ausgegeben werden.

Beispiele

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

Verwandte Themen

Add-PefMessageSource

New-PefTraceSession

New-PefDateTimeTrigger

New-PefKeyDownTrigger

New-PefMessageTrigger

New-PefProcessTrigger

New-PefTimeSpanTrigger