Stop-PefTraceSession

Stop-PefTraceSession

Stops a PEF Trace Session.

Syntax

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

Detaillierte Beschreibung

The Stop-PefTraceSession cmdlet creates an action that stops a Protocol Engineering Framework (PEF) Trace Session. You can also specify a trigger that causes the Trace Session to stop. Use this cmdlet to define a stop action before you start a PEF Trace Session.

When a Trace Session stops, the session disposes of all message data and any other information. To store the message data from theTrace Session, use the SaveOnStop parameter when you create the Trace Session object with the New-PefTraceSession cmdlet. You can also use the Save-PefDataCollection cmdlet to save the message data.

Parameter

-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. When one of these triggers runs, the action stops the Trace Session.

<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: Define a stop action for a Trace Session

This example creates a PEF Trace Session that includes a stop action.

The first command creates a Trace Session and stores it in the $TraceSession01 variable. This command also specifies the Circular capture mode. The command uses the SaveOnStop parameter and specifies an input file containing message data for the Trace Session as Trace01.matu, located in the current directory, and an output file to contain the captured data, Result.matu, also in the current directory.

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

The third command uses the New-PefMessageTrigger cmdlet to create a message trigger object and stores it in the $Trigger01 variable.

The fourth command creates a stop action for the Trace Session stored in the $TraceSession01 variable and specifies the trigger stored in the $Trigger01 variable.

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

PS C:\> $TraceSession01 = New-PefTraceSession -Mode Circular -Path "C:\Traces\Result.matu" -Name ".\Trace01.matu" -SaveOnStop
PS C:\> Add-PefMessageSource -PEFSession $TraceSession01 –Source "Microsoft-Pef-WFP-MessageProvider"
PS C:\> $Trigger01 = New-PefMessageTrigger -Filter "icmp"
PS C:\> Stop-PefTraceSession -PEFSession $TraceSession01 -Trigger $Trigger01
PS C:\> Start-PefTraceSession –PEFSession $TraceSession01

Verwandte Themen

Add-PefMessageSource

New-PefDateTimeTrigger

New-PefKeyDownTrigger

New-PefMessageTrigger

New-PefProcessTrigger

New-PefTimeSpanTrigger

New-PefTraceSession

Save-PefDataCollection

Start-PefTraceSession