New-WinEvent

Creates an ETW event for the specified event provider.
New-WinEvent [-ProviderName*] <String> [-Id*] <Int32> [[-Payload] <Object[]>] [-Version <Byte>] [<CommonParameters>]

The New-WinEvent cmdlet creates an Event Tracing for Windows (ETW) event for an event provider. You can use this cmdlet to add events to ETW channels from Windows PowerShell.

Parameters
-Id <Int32>

  • This value is required

Specifies an event ID that was registered through an instrumentation manifest.

-Payload <Object[]>

Specifies the message for the event. When the event is written to an event log, the payload is stored in the Message property of the event object.

When the specified payload does not match the payload in the event definition, Windows PowerShell generates a warning, but the command still succeeds.

-ProviderName <String>

  • This value is required

Specifies the event provider that writes the event to an event log, such as Microsoft-Windows-PowerShell. An ETW event provider is a logical entity that writes events to ETW sessions.

-Version <Byte>

Specifies the version number of the event. Type the event number. Windows PowerShell converts the number to the required Byte type.

This parameter lets you specify an event when different versions of the same event are defined.

<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer, PipelineVariable, and OutVariable.

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

None

This cmdlet does not generate any output.

Examples
  1. Create an ETW event for a specified provider:
    PS C:> New-WinEvent -ProviderName Microsoft-Windows-PowerShell -Id 45090 -Payload @("Workflow", "Running")
    

    This command uses the New-WinEvent cmdlet to create event 45090 for the Microsoft-Windows-PowerShell provider.

Additional Notes
 After the provider writes the even to an event log, you can use the Get-WinEvent cmdlet to get the event from 
 the event log.
 For information about Event Tracing for Windows, see Improve Debugging And Performance Tuning With ETW 
 (http://msdn.microsoft.com/en-us/magazine/cc163437.aspx).
Related Links

Get-WinEvent