Write-EventLog
将事件写入事件日志。
语法
Default (默认值)
Write-EventLog
[-LogName] <String>
[-Source] <String>
[[-EntryType] <EventLogEntryType>]
[-Category <Int16>]
[-EventId] <Int32>
[-Message] <String>
[-RawData <Byte[]>]
[-ComputerName <String>]
[<CommonParameters>]
说明
Write-EventLog
cmdlet 将事件写入事件日志。
若要将事件写入事件日志,事件日志必须存在于计算机上,并且必须为事件日志注册源。
包含 EventLog 名词(EventLog cmdlet)的 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 |
默认值: | None |
支持通配符: | False |
不显示: | False |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-ComputerName
指定远程计算机。 默认值为本地计算机。
键入远程计算机的 NetBIOS 名称、IP 地址或完全限定的域名。
此参数不依赖于 Windows PowerShell 远程处理。 即使计算机未配置为运行远程命令,也可以使用 cmdlet 的 Get-EventLog
参数。
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | 中国区 |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-EntryType
指定事件的条目类型。 此参数的可接受值为:Error、Warning、Information、SuccessAudit 和 FailureAudit。 默认值为 Information。
有关值的说明,请参阅 EventLogEntryType 枚举。
参数属性
类型: | EventLogEntryType |
默认值: | None |
接受的值: | Error, Information, FailureAudit, SuccessAudit, Warning |
支持通配符: | False |
不显示: | False |
别名: | ET |
参数集
(All)
Position: | 3 |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-EventId
指定事件标识符。 此参数是必需的。 EventId 参数的最大值为 65535。
参数属性
类型: | Int32 |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | ID, EID |
参数集
(All)
Position: | 2 |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-LogName
指定写入事件的日志的名称。 输入日志名称。 日志名称是 Log 属性的值,而不是 LogDisplayName的值。 不允许使用通配符。 此参数是必需的。
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | LN |
参数集
(All)
Position: | 0 |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Message
指定事件消息。 此参数是必需的。
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | 味精 |
参数集
(All)
Position: | 4 |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-RawData
指定与事件关联的二进制数据(以字节为单位)。
参数属性
类型: | Byte[] |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | RD |
参数集
(All)
Position: | Named |
必需: | False |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
-Source
指定事件源,该源通常是将事件写入日志的应用程序的名称。
参数属性
类型: | String |
默认值: | None |
支持通配符: | False |
不显示: | False |
别名: | SRC |
参数集
(All)
Position: | 1 |
必需: | True |
来自管道的值: | False |
来自管道的值(按属性名称): | False |
来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输入
None
不能通过管道将输入传递给此 cmdlet。
输出
EventLogEntry
此 cmdlet 返回表示日志中的事件的对象。
备注
对于某些 Windows 事件日志,写入事件需要管理员权限。 必须使用 以管理员身份运行 选项启动 PowerShell。