Share via

New-EventLog

  • Reference
Module:
Microsoft.PowerShell.Management

Creates a new event log and a new event source on a local or remote computer.

Syntax

New-EventLog
   [-LogName] <string>
   [-Source] <string[]>
   [[-ComputerName] <string[]>]
    [-CategoryResourceFile <string>]
   [-MessageResourceFile <string>]
   [-ParameterResourceFile <string>] 
   [<CommonParameters>]

Description

This cmdlet creates a new classic event log on a local or remote computer. It can also register an event source that writes to the new log or to an existing log.

The cmdlets that contain the EventLog noun (the Event log cmdlets) work only on classic event logs. To get events from logs that use the Windows Event Log technology in Windows Vista and later versions of Windows, use Get-WinEvent.

Examples

Example 1 - create a new event log

This command creates the TestLog event log on the local computer and registers a new source for it.

New-EventLog -source TestApp -LogName TestLog -MessageResourceFile C:\Test\TestApp.dll

Example 2 - add a new event source to an existing log

This command adds a new event source, NewTestApp, to the Application log on the Server01 remote computer.

$file = "C:\Program Files\TestApps\NewTestApp.dll"
New-EventLog -ComputerName Server01 -Source NewTestApp -LogName Application -MessageResourceFile $file -CategoryResourceFile $file

The command requires that the NewTestApp.dll file is located on the Server01 computer.

Parameters

-CategoryResourceFile

Specifies the path to the file that contains category strings for the source events. This file is also known as the Category Message File.

The file must be present on the computer on which the event log is being created. This parameter does not create or move files.

Type:String
Aliases:CRF
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

Creates the new event logs on the specified computers. The default is the local computer.

The NetBIOS name, IP address, or fully qualified domain name of a remote computer. To specify the local computer, type the computer name, a dot (.), or "localhost".

This parameter does not rely on PowerShell remoting. You can use the ComputerName parameter of Get-EventLog even if your computer is not configured to run remote commands.

Type:String[]
Aliases:CN
Position:3
Default value:Local computer
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LogName

Specifies the name of the event log.

If the log does not exist, New-EventLog creates the log and uses this value for the Log and LogDisplayName properties of the new event log. If the log exists, New-EventLog registers a new source for the event log.

Type:String
Aliases:LN
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-MessageResourceFile

Specifies the path to the file that contains message formatting strings for the source events. This file is also known as the Event Message File.

The file must be present on the computer on which the event log is being created. This parameter does not create or move files.

Type:String
Aliases:MRF
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ParameterResourceFile

Specifies the path to the file that contains strings used for parameter substitutions in event descriptions. This file is also known as the Parameter Message File.

The file must be present on the computer on which the event log is being created. This parameter does not create or move files.

Type:String
Aliases:PRF
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Source

Specifies the names of the event log sources, such as application programs that write to the event log. This parameter is required.

Type:String[]
Aliases:SRC
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

EventLogEntry

Notes

To use New-EventLog on Windows Vista and later versions of Windows, open PowerShell with the "Run as administrator" option.

To create an event source in Windows Vista, Windows XP Professional, or Windows Server 2003, you must be a member of the Administrators group on the computer.

When you create a new event log and a new event source, the system registers the new source for the new log, but the log is not created until the first entry is written to it.

The operating system stores event logs as files.

When you create a new event log, the associated file is stored in the $env:SystemRoot\System32\Config directory on the specified computer.

The file name is the first eight characters of the Log property with an .evt file name extension.