Write-EventLog
将事件写入事件日志。
语法
Write-EventLog
[-LogName] <String>
[-Source] <String>
[[-EntryType] <EventLogEntryType>]
[-Category <Int16>]
[-EventId] <Int32>
[-Message] <String>
[-RawData <Byte[]>]
[-ComputerName <String>]
[<CommonParameters>]
说明
Write-EventLog
cmdlet 将事件写入事件日志。
若要将事件写入事件日志,则计算机上必须存在该事件日志,并且必须为该事件日志注册来源。
包含 EventLog 名词的 cmdlet (EventLog cmdlet) 仅适用于传统事件日志。 若要从那些使用 Windows Vista 及更高版本 Windows 操作系统中的 Windows 事件日志技术的日志中获取事件,请使用 Get-WinEvent
cmdlet。
示例
示例 1:将事件写入应用程序事件日志
PS C:\> 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:将事件写入远程计算机的应用程序事件日志
PS C:\> Write-EventLog -ComputerName "Server01" -LogName Application -Source "MyApp" -EventID 3001 -Message "MyApp added a user-requested feature to the display."
此命令将一个事件从 MyApp 源写入远程计算机 Server01 上的应用程序事件日志。
参数
-Category
指定事件的任务类别。 请输入一个与事件日志的类别消息文件中的字符串相关联的整数。
类型: | Int16 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ComputerName
指定远程计算机。 默认为本地计算机。
键入远程计算机的 NetBIOS 名称、IP 地址或完全限定的域名。
此参数不依赖于 Windows PowerShell 远程处理。 即使你的计算机未配置为运行远程命令,你也可以使用 Get-EventLog
cmdlet 的 ComputerName 参数。
类型: | String |
别名: | CN |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-EntryType
指定事件的条目类型。 此参数可接受的值包括:Error、Warning、Information、SuccessAudit 和 FailureAudit。 默认值为 Information。
有关值的说明,请参阅 EventLogEntryType 枚举。
类型: | EventLogEntryType |
别名: | ET |
接受的值: | Error, Information, FailureAudit, SuccessAudit, Warning |
Position: | 3 |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-EventId
指定事件标识符。 此参数是必需的。 EventId 参数的最大值为 65535。
类型: | Int32 |
别名: | ID, EID |
Position: | 2 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-LogName
指定要向其中写入事件的日志的名称。 输入日志名称。 日志名称是 Log 属性的值,而不是 LogDisplayName。 不允许使用通配符。 此参数是必需的。
类型: | String |
别名: | LN |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Message
指定事件消息。 此参数是必需的。
类型: | String |
别名: | MSG |
Position: | 4 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-RawData
指定与事件关联的二进制数据,以字节为单位。
类型: | Byte[] |
别名: | RD |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Source
指定事件来源,这通常是将事件写入日志的应用程序的名称。
类型: | String |
别名: | SRC |
Position: | 1 |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
输入
None
不能通过管道将输入传递给此 cmdlet。
输出
此 cmdlet 返回表示日志中事件的对象。
备注
对于某些 Windows 事件日志,写入事件需要管理员权限。 必须使用“以管理员身份运行”选项启动 PowerShell。