Write-EventLog
イベント ログにイベントを書き込みます。
構文
Default (既定)
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
イベントのタスク カテゴリを指定します。 イベント ログのカテゴリ メッセージ ファイル内の文字列に関連付けられている整数を入力します。
パラメーターのプロパティ
| 型: | Int16 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ComputerName
リモート コンピューターを指定します。 既定値はローカル コンピューターです。
リモート コンピューターの NetBIOS 名、IP アドレス、または完全修飾ドメイン名を入力します。
このパラメーターは、Windows PowerShell リモート処理には依存しません。 コンピューターがリモート コマンドを実行するように構成されていない場合でも、 コマンドレットの Get-EventLog パラメーターを使用できます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | CN |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EntryType
イベントのエントリの種類を指定します。 このパラメーターに使用できる値は、Error、Warning、Information、SuccessAudit、FailureAudit です。 既定値は Information です。
値の詳細については、「EventLogEntryType 列挙 を参照してください。
パラメーターのプロパティ
| 型: | EventLogEntryType |
| 規定値: | None |
| 指定可能な値: | Error, Information, FailureAudit, SuccessAudit, Warning |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ET |
パラメーター セット
(All)
| 配置: | 3 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-EventId
イベント識別子を指定します。 このパラメーターは必須です。 EventId パラメーターの最大値は 65535 です。
パラメーターのプロパティ
| 型: | Int32 |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ID, EID |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-LogName
イベントの書き込み先となるログの名前を指定します。 ログ名を入力します。 ログ名は、LogDisplayNameではなく、Log プロパティの値です。 ワイルドカード文字は使用できません。 このパラメーターは必須です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | LN |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Message
イベント メッセージを指定します。 このパラメーターは必須です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | MSG |
パラメーター セット
(All)
| 配置: | 4 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-RawData
イベントに関連付けられているバイナリ データをバイト単位で指定します。
パラメーターのプロパティ
| 型: | Byte[] |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | RD |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Source
イベント ソースを指定します。通常は、イベントをログに書き込むアプリケーションの名前です。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | SRC |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
None
このコマンドレットに入力をパイプすることはできません。
出力
EventLogEntry
このコマンドレットは、ログ内のイベントを表すオブジェクトを返します。
メモ
一部の Windows イベント ログでは、イベントを書き込むには管理者権限が必要です。 [管理者として実行] オプション 使用して PowerShell を起動する必要があります。