將事件寫入事件記錄檔。

語法

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 名稱、網際網路通訊協定 (IP) 位址或完整網域名稱。

此參數並不依存於 Windows PowerShell 遠端。即使沒有將電腦設定成執行遠端命令,也可以使用 Get-EventLog 的 ComputerName 參數。

必要?

false

位置?

named

預設值

接受管線輸入?

false

接受萬用字元?

false

-EntryType <EventLogEntryType>

指定事件的記錄類型。有效的值包含 Error、Warning、Information、SuccessAudit 與 FailureAudit。預設值為 Information。

如需這些值的描述,請參閱 MSDN (Microsoft Developer Network) Library (https://go.microsoft.com/fwlink/?LinkId=143599) 中的「System.Diagnostics.EventLogEntryType」。

必要?

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 所傳回的物件型別。

輸入

您無法經由管道將輸入輸出至這個 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 來源中的事件寫入 Application 事件記錄檔。






範例 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 遠端電腦上的 Application 事件記錄檔。






請參閱




目錄