New-PefTimeSpanTrigger
New-PefTimeSpanTrigger
Creates a trigger that signals after the specified time span.
構文
Parameter Set: Default
New-PefTimeSpanTrigger [-TimeSpan] <TimeSpan> [-InformationAction <System.Management.Automation.ActionPreference> {SilentlyContinue | Stop | Continue | Inquire | Ignore | Suspend} ] [-InformationVariable <System.String> ] [-Repeat] [ <CommonParameters>]
詳細説明
The New-PefTimeSpanTrigger cmdlet creates a trigger that signals after a specified time span. You can use a timer trigger to start or stop a Protocol Engineering Framework (PEF) Trace Session after a specified time interval elapses. The trigger becomes active when you associate it to a PEF 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 |
-Repeat
Indicates that the trigger runs on each occurrence of a time-span interval that you specify. If you do not specify this parameter, the trigger runs only once.
エイリアス |
none |
必須? |
false |
位置は? |
named |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
-TimeSpan<TimeSpan>
Specifies the amount of time before the server fires the trigger.
エイリアス |
none |
必須? |
true |
位置は? |
1 |
既定値 |
none |
パイプライン入力を許可する |
false |
ワイルドカード文字を許可する |
false |
<CommonParameters>
このコマンドレットは次の共通パラメーターをサポートします。-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、-OutVariable.詳細については、以下を参照してください。 about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216)。
入力
入力型は、コマンドレットにパイプできるオブジェクトの型です。
出力
出力型は、コマンドレットによって生成されるオブジェクトの型です。
例
Example 1: Add a Trace Filter by using a time span trigger
This example adds a Trace Filter to a Trace Session after a period of 150 seconds expires.
The first command uses the New-PefTraceSession cmdlet to create a PEF Trace Session object and stores it in the $TraceSession01 variable.
The second command uses the current 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-PefTraceFilter 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-PefMessageSource cmdlet to specify a message provider for the Trace Session object stored in the $TraceSession01 variable.
The final command uses the Start-PefTraceSession cmdlet to start the Trace Session stored in the $TraceSession01 variable.
PS C:\> $TraceSession01 = New-PefTraceSession -Mode Circular
PS C:\> $Trigger01 = New-PefTimeSpanTrigger -TimeSpan (New-TimeSpan -Seconds 150)
PS C:\> Set-PefTraceFilter -PEFSession $TraceSession01 -Filter "icmp" -Trigger $Trigger01
PS C:\> Add-PefMessageSource -Session $TraceSession01 –Source "Microsoft-Pef-WFP-MessageProvider"
PS C:\> Start-PefTraceSession –PEFSession $TraceSession01