New-PefTimeSpanTrigger
New-PefTimeSpanTrigger
Creates a timer trigger based on a specified span of time.
Syntax
Parameter Set: Default
New-PefTimeSpanTrigger [-TimeSpan] <TimeSpan> [-Repeat] [ <CommonParameters>]
Detailed Description
The New-PefTimeSpanTrigger cmdlet creates a timer trigger for a span of time. You can use a timer trigger to start or stop a Protocol Engineering Framework (PEF) Trace Session after a specified time interval elapses. The server activates the trigger when you associate the trigger with the PEF action.
Parameters
-Repeat
Indicates that the trigger runs on each occurrence of a time-span interval that you specify.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
false |
Accept Wildcard Characters? |
false |
-TimeSpan<TimeSpan>
Specifies the amount of time before the server fires the trigger.
Aliases |
none |
Required? |
true |
Position? |
1 |
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: Add a Trace Filter by using a timer trigger
This example adds a Trace Filter to a Trace Session after a period of 150 seconds expires.
The first command uses the New-PefCaptureSession cmdlet to create a PEF Trace Session object and stores it in the $TraceSession01 variable.
The second command uses the New-PefTimeSpanTrigger cmdlet to create a trigger with a TimeSpan value of 150 seconds. The command stores the trigger in the $Trigger01 variable. To specify the TimeSpan value, type Get-Help New-TimeSpan to learn how to use the New-TimeSpan cmdlet.
The third command uses the Set-PefCaptureFilter to set a Trace Filter with the string value “icmp” for the Trace Session object that is stored in the $TraceSession01 variable. This command specifies the trigger stored in the $Trigger01 variable, which causes the specified Trace Filter to be applied to the Trace Session message retrieval action 150 seconds after the session starts.
The fourth command uses the Add-PefMessageProvider cmdlet to specify a message provider for the Trace Session object stored in the $TraceSession01 variable.
The fifth command uses the Stop-PefCaptureSession cmdlet to create a stop action for the Trace Session. You can stop the session by default with the use of the keyboard shortcut Ctrl+C.
The sixth command uses the Start-PefCaptureSession cmdlet to start the Trace Session stored in the $TraceSession01 variable.
PS C:\> $TraceSession01 = New-PefCaptureSession -Mode Circular
PS C:\> $Trigger01 = New-PefTimeSpanTrigger -TimeSpan (New-TimeSpan -Seconds 150)
PS C:\> Set-PefCaptureFilter -Session $TraceSession01 -Filter "icmp" -Trigger $Trigger01
PS C:\> Add-PefMessageProvider -Session $TraceSession01 –Provider "Microsoft-PEF-NDIS-PacketCapture"
PS C:\> Stop-PefCaptureSession –Session $TraceSession01
PS C:\> Start-PefCaptureSession –Session $TraceSession01