Stop-PefTraceSession

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

Stop-PefTraceSession

Stops a PEF Trace Session.

構文

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

詳細説明

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.

パラメーター

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

エイリアス	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: 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

Stop-PefTraceSession