Start-PefCaptureSession
Applies To: Windows Server 2012 R2 Preview
Start-PefCaptureSession
Starts a PEF Trace Session.
Syntax
Parameter Set: Default
Start-PefCaptureSession [-Session] <IPpkCaptureSession> [-Trigger <Trigger[]> ] [ <CommonParameters>]
Detailed Description
The Start-PefCaptureSession 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 trigger or specify 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-PefCaptureSession cmdlet to create a stop action.
Parameters
-Session<IPpkCaptureSession>
Specifies an object that contains a Trace Session. To create a Trace Session, use the New-PefCaptureSession cmdlet.
Aliases |
none |
Required? |
true |
Position? |
1 |
Default Value |
none |
Accept Pipeline Input? |
True (ByValue) |
Accept Wildcard Characters? |
false |
-Trigger<Trigger[]>
Specifies an array of Trigger objects.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see about_CommonParameters.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
Outputs
The output type is the type of the objects that the cmdlet emits.
Examples
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-PefCaptureSession cmdlet to create a Trace Session object and stores it in the $TraceSession01 variable.
The second command uses the Add-PefMessageProvider cmdlet to specify a provider for the Trace Session object stored in the $TraceSession01 variable.
The third command uses the New-PefKeyDownTrigger cmdlet to create a new trigger object that includes the Ctrl+C keyboard trigger, and stores it in the $Trigger01 variable.
The fourth command uses the Stop-PefCaptureSession cmdlet to create a stop action for the Trace Session, which is activated by the trigger stored in the $Trigger01 variable.
The fifth command starts the PEF Trace Session stored in the $TraceSession01 variable.
PS C:\> $TraceSession01 = New-PefCaptureSession
PS C:\> Add-PefMessageProvider -Session $TraceSession01 –Provider "Microsoft-PEF-NDIS-PacketCapture"
PS C:\> $Trigger01 = New-PefKeyDownTrigger -CTRLC
PS C:\> Stop-PefCaptureSession -Session $TraceSession01 -Trigger $Trigger01
PS C:\> Start-PefCaptureSession -Session $TraceSession01