Write-EventLog

[アーティクル]
10/30/2009

イベントをイベントログに書き込みます。

構文

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 コマンドレットはイベントをイベントログに書き込みます。

イベントをイベントログに書き込むには、イベントログがコンピューター上に存在し、イベントソースがイベントログに登録されている必要があります。

EventLog という名詞を含むコマンドレット (EventLog コマンドレット) は、従来のイベントログでのみ有効です。Windows Vista 以降のバージョンで 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) ライブラリの「System.Diagnostics.EventLogEntryType」(https://msdn.microsoft.com/ja-jp/library/system.diagnostics.eventlogentrytype.aspx) を参照してください。

必須	false
位置	4
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-EventID <int>

イベント識別子を指定します。このパラメーターは必須です。

必須	true
位置	3
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-LogName <string>

イベントを書き込むログの名前を指定します。ログ名 (LogDisplayName ではなく Log プロパティの値) を入力します。ワイルドカード文字は使用できません。このパラメーターは必須です。

必須	true
位置	1
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Message <string>

イベントメッセージを指定します。このパラメーターは必須です。

必須	true
位置	5
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-RawData <Byte[]>

イベントに関連付けられたバイナリデータをバイト単位で指定します。

必須	false
位置	named
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

-Source <string>

イベントソースを指定します。通常は、イベントをログに書き込むアプリケーションの名前です。

必須	true
位置	2
既定値
パイプライン入力を許可する	false
ワイルドカード文字を許可する	false

<CommonParameters>

このコマンドレットは、次の共通パラメーターをサポートします: -Verbose、-Debug、-ErrorAction、-ErrorVariable、-OutBuffer、および -OutVariable。詳細については、次を参照してください: about_Commonparameters.

入力と出力

入力値の型は、コマンドレットへのパイプが可能なオブジェクトの型です。戻り値の型は、コマンドレットによって返されるオブジェクトの型です。

入力

なし

パイプを使用してこのコマンドレットに入力を渡すことはできません。

出力

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 イベント ログに書き込みます。

次の方法で共有