Start-PefTraceSession
Start-PefTraceSession
Starts a PEF Trace Session.
Syntax
Parameter Set: Default
Start-PefTraceSession [-PEFSession] <IPpkTraceSession> [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-Trigger <Trigger[]> ] [ <CommonParameters>]
Detaillierte Beschreibung
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.
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
Aliasse |
infa |
Erforderlich? |
false |
Position? |
named |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-InformationVariable<System.String>
Specifies a variable in which to store an information event message.
Aliasse |
iv |
Erforderlich? |
false |
Position? |
named |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
-PEFSession<IPpkTraceSession>
Specifies an object that contains a Trace Session. To create a Trace Session, use the New-PefTraceSession cmdlet.
Aliasse |
none |
Erforderlich? |
true |
Position? |
1 |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
True (ByValue) |
Platzhalterzeichen akzeptieren? |
false |
-Trigger<Trigger[]>
Specifies an array of Trigger objects.
Aliasse |
none |
Erforderlich? |
false |
Position? |
named |
Standardwert |
none |
Pipelineeingaben akzeptieren? |
false |
Platzhalterzeichen akzeptieren? |
false |
<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: 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