Write-EventLog

  • リファレンス
モジュール:
Microsoft.PowerShell.Management

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

構文

Write-EventLog
     [-LogName] <String>
     [-Source] <String>
     [[-EntryType] <EventLogEntryType>]
     [-Category <Int16>]
     [-EventId] <Int32>
     [-Message] <String>
     [-RawData <Byte[]>]
     [-ComputerName <String>]
     [<CommonParameters>]

説明

コマンドレットは Write-EventLog イベントログにイベントを書き込みます。

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

EventLog 名詞 (EventLog コマンドレット) を含むコマンドレットは、クラシック イベント ログでのみ機能します。 Windows Vista 以降のバージョンの Windows オペレーティング システムで Windows イベント ログ テクノロジを使用するログからイベントを取得するには、コマンドレットを Get-WinEvent 使用します。

例

例 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

イベントのタスク カテゴリを指定します。 イベント ログのカテゴリ メッセージ ファイルに記載された文字列に関連付けられた整数を入力します。

Type:Int16
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ComputerName

リモート コンピューターを指定します。 既定値はローカル コンピューターです。

リモート コンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。

このパラメーターは、Windows PowerShell リモート処理に依存しません。 コンピューターがリモート コマンドを実行するように構成されていない場合でも、コマンドレットの Get-EventLog ComputerName パラメーターを使用できます。

Type:String
Aliases:CN
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EntryType

イベントのエントリの種類を指定します。 このパラメーターに使用できる値は、Error、Warning、Information、SuccessAudit、FailureAudit です。 既定値は Information です。

値の説明については、「EventLogEntryType 列挙型」を参照してください。

Type:EventLogEntryType
Aliases:ET
Accepted values:Error, Information, FailureAudit, SuccessAudit, Warning
Position:3
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-EventId

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

Type:Int32
Aliases:ID, EID
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-LogName

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

Type:String
Aliases:LN
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Message

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

Type:String
Aliases:MSG
Position:4
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RawData

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

Type:Byte[]
Aliases:RD
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Source

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

Type:String
Aliases:SRC
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

入力

None

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

出力

EventLogEntry

このコマンドレットは、ログ内のイベントを表すオブジェクトを返します。

メモ

一部の Windows イベント ログでは、イベントを書き込むには管理者権限が必要です。 PowerShell は、[管理として実行] オプションを使用して開始する必要があります。