Export (0) Print
Expand All

New-PefDateTimeTrigger

New-PefDateTimeTrigger

Creates a date-time trigger.

Syntax

Parameter Set: Default
New-PefDateTimeTrigger [-DateTime] <DateTime> [-Repeat] [ <CommonParameters>]




Detailed Description

The New-PefDateTimeTrigger cmdlet creates a date-time trigger. You can use a date-time trigger to start or stop Protocol Engineering Framework (PEF) trace sessions on the date and time that you specify. The server activates the trigger at the appropriate time, as the result of associating the trigger with the PEF action.

Parameters

-DateTime<DateTime>

Specifies a DateTime object.


Aliases

none

Required?

true

Position?

1

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-Repeat

Indicates that the trigger runs on each occurrence of the date and time that you specify.


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: Add a Trace Filter by using a date-time trigger

This example adds a Trace Filter to a Trace Session at 3am on January 31, 2013. The first command uses the New-PefCaptureSession cmdlet to create a PEF Trace Session object and store it in the $TraceSession01 variable.

The second command uses the New-PefDateTimeTrigger cmdlet to create a trigger with a DateTime value of 1/31/2013 3:00 AM. The command stores the trigger in the $Trigger02 variable.

The third command uses the Set-PefCaptureFilter to specify a Trace Filter with the string value “icmp” for the Trace Session stored in the $TraceSession01 variable. This command also specifies the trigger stored in he $Trigger02 variable, which adds the specified Trace Filter to the Trace Session at 3am on January 31, 2013.

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

The fifth command uses the Stop-PefCaptureSession cmdlet to create a stop action with the New-PefKeyDownTrigger cmdlet, and associates that action with the Trace Session object stored in the $TraceSession01 variable. The trigger occurs when you use 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:\> $Trigger02 = New-PefDateTimeTrigger -DateTime “1/31/2013 3:00 AM"
PS C:\> Set-PefCaptureFilter -Session $TraceSession01 -Filter "icmp" -Trigger $Trigger02
PS C:\> Add-PefMessageProvider –Provider "Microsoft-PEF-NDIS-PacketCapture"
PS C:\> Stop-PefCaptureSession -Trigger (New-PefKeyDownTrigger -CTRLC)
PS C:\> Start-PefCaptureSession –Session $TraceSession01

Related topics

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft