Start-PefTraceSession

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

Start-PefTraceSession

Starts a PEF Trace Session.

構文

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

詳細説明

The Start-PefTraceSession cmdlet creates an action that starts a Protocol Engineering Framework (PEF) Trace Session. You can specify a trigger for this action.

If you do not specify a new trigger or a trigger that already fired, the start action enters a message processing loop. The Trace Session uses that loop to process messages that are delivered by the specified message providers. The loop stops when the Trace Session stops. A session is terminated when the stop action occurs or when there are no more messages to process. Use the Stop-PefTraceSession cmdlet to create a stop action.

パラメーター

-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: Start a Trace Session that closes with a stop trigger

This example creates and starts a PEF Trace Session.

The first command uses the New-PefTraceSession cmdlet to create a Trace Session object, and then stores it in the $TraceSession01 variable.

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

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

The fourth command uses the Stop-PefTraceSession cmdlet to create a stop action for the Trace Session, which is activated by the trigger stored in $Trigger01.

The last command starts the PEF Trace Session stored in $TraceSession01.

PS C:\> $TraceSession01 = New-PefTraceSession 
PS C:\> Add-PefMessageSource -PEFSession $TraceSession01 –Provider "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

Start-PefTraceSession