Message Analyzer Cmdlets in Windows PowerShell

Applies To: Windows 8.1, Windows PowerShell 4.0, Windows Server 2012 R2

Windows PowerShell® is a task-based command-line shell and scripting language designed especially for system administration. This reference topic for the information technology (IT) professional provides assistance in utilizing the Windows PowerShell cmdlets to script and automate tasks.

Message Analyzer Cmdlets

This reference provides cmdlet descriptions and syntax for all Message Analyzer cmdlets that are supported by the Protocol Engineering Framework (PEF). It lists the cmdlets in alphabetical order based on the verb at the beginning of the cmdlet.

You need to be a member of the Message Capture Users Group and the Performance Log Users Group to run Message Analyzer cmdlets.

Cmdlet Description

Add-PefMessageSource

Adds message sources to a PEF Trace Session.

Add-PefProviderConfig

Adds a provider to a remote Trace Session on a target host.

Invoke-PefCustomAction

Creates a PEF action that runs a script block.

New-PefDateTimeTrigger

Creates a trigger that signals at the specified time.

New-PefEventLogTrigger

Creates a trigger that signals when an event log logs an entry.

New-PefKeyDownTrigger

Creates a trigger that signals when a user presses a key.

New-PefMessageTrigger

Creates a trigger based on detecting a filter match for a specific message in a PEF Trace Session.

New-PefProcessTrigger

Creates a trigger that signals when a process exits.

New-PefTargetHost

Creates a target host object for a PEF Live Trace Session.

New-PefTimeSpanTrigger

Creates a trigger that signals after the specified time span.

New-PefTraceSession

Creates a PEF Trace Session.

New-PefWin32EventTrigger

Creates a trigger that signals when a specified Win32 system event is raised.

Save-PefDataCollection

Saves the data from a PEF Trace Session.

Set-PefTraceFilter

Sets a Trace Filter for a PEF Trace Session.

Start-PefTraceSession

Starts a PEF Trace Session.

Stop-PefTraceSession

Stops a PEF Live Trace Session.

Note

To list all the cmdlets that are available, use the Get-Command –Module PEF cmdlet.

For more information about, or for the syntax of, any of the cmdlets, use the Get-Help <cmdlet name> cmdlet, where <cmdlet name> is the name of the cmdlet that you want to research. For more detailed information, you can run any of the following cmdlets:

Get-Help <cmdlet name> -Detailed
Get-Help <cmdlet name> -Examples
Get-Help <cmdlet name> -Full

More Information

For more information about Microsoft Message Analyzer and the cmdlets that it supports, see the following documentation: