将事件写入事件日志。
语法
Write-EventLog [-LogName] <string> [-Source] <string> [-EventID] <int> [-Message] <string> [[-EntryType] {<Error> | <Warning> | <Information> | <SuccessAudit> | <FailureAudit>}] [-Category <Int16>] [-ComputerName <string>] [-RawData <Byte[]>] [<CommonParameters>]
说明
Write-EventLog cmdlet 将事件写入事件日志。
要将事件写入事件日志,计算机上必须存在该事件日志,并且您必须为该事件日志注册来源。
包含 EventLog 名词的 cmdlet (EventLog cmdlet) 仅适用于传统事件日志。要从使用 Windows Vista 以及 Windows 更高版本中的 Windows 事件日志技术的日志中获取事件,请使用 Get-WinEvent。
参数
-Category <Int16>
指定事件的任务类别。请输入一个与事件日志的类别消息文件中的字符串相关联的整数。
是否为必需? |
false |
位置? |
named |
默认值 |
1 |
是否接受管道输入? |
false |
是否接受通配符? |
false |
-ComputerName <string>
指定远程计算机。默认值为本地计算机。
键入远程计算机的 NetBIOS 名称、Internet 协议 (IP) 地址或完全限定的域名。
此参数不依赖于 Windows PowerShell 远程处理。即使您的计算机未配置为运行远程命令,您也可以使用 Get-EventLog 的 ComputerName 参数。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-EntryType <EventLogEntryType>
指定事件的条目类型。有效值包括 Error、Warning、Information、SuccessAudit 和 FailureAudit。默认值为 Information。
有关这些值的说明,请参阅 MSDN (Microsoft Developer Network) 库中的 System.Diagnostics.EventLogEntryType,网址是 https://go.microsoft.com/fwlink/?LinkId=143599。
是否为必需? |
false |
位置? |
4 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-EventID <int>
指定事件标识符。此参数是必需的。
是否为必需? |
true |
位置? |
3 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-LogName <string>
指定要向其中写入事件的日志的名称。请输入日志名称(Log 属性的值,而不是 LogDisplayName)。不允许使用通配符。此参数是必需的。
是否为必需? |
true |
位置? |
1 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-Message <string>
指定事件消息。此参数是必需的。
是否为必需? |
true |
位置? |
5 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-RawData <Byte[]>
指定与事件关联的二进制数据,以字节为单位。
是否为必需? |
false |
位置? |
named |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
-Source <string>
指定事件来源,这通常是将事件写入日志的应用程序的名称。
是否为必需? |
true |
位置? |
2 |
默认值 |
|
是否接受管道输入? |
false |
是否接受通配符? |
false |
<CommonParameters>
此 cmdlet 支持通用参数:-Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer 和 -OutVariable。有关详细信息,请参阅 about_Commonparameters.
输入和输出
输入类型是指可通过管道传递给 cmdlet 的对象的类型。返回类型是指 Cmdlet 所返回对象的类型。
输入 |
None 不能通过管道将输入传递给此 cmdlet。 |
输出 |
System.Diagnostics.EventLogEntry Write-EventLog 返回表示日志中事件的对象。 |
说明
要在 Windows Vista 以及更高版本的 Windows 上使用 Write-EventLog,请使用“以管理员身份运行”选项启动 Windows PowerShell。
示例 1
C:\PS>write-eventlog -logname Application -source MyApp -eventID 3001 -entrytype Information -message "MyApp added a user-requested feature to the display." -category 1 -rawdata 10,20 说明 ----------- 此命令将一个事件从 MyApp 源写入应用程序事件日志。
示例 2
C:\PS>write-eventlog -computername Server01 -logname Application -source MyApp -eventID 3001 -message "MyApp added a user-requested feature to the display." 说明 ----------- 此命令将一个事件从 MyApp 源写入远程计算机 Server01 上的应用程序事件日志。
另请参阅