4.16.11 イベントログのイベント一覧取得
機能
この部品は，Windowsの実行対象サーバで，指定したイベントログにあるイベントの一覧をCSV形式で実行対象サーバのファイルに出力します。
出力ファイルのエンコード形式は，実行対象サーバのシステムのデフォルトエンコーディングです。
この部品が前提とするサーバを次に示します。
・実行対象サーバ
この部品を実行する対象となるサーバです。
この部品内のスクリプトでは次に示す処理を行います。
・次のコマンドレットを実行します。
Get-EventLog
-LogName "イベントログ名(Windows.eventLogNameプロパティ)の値"
-After "イベントの取得開始日時(Windows.eventStartDateTimeプロパティ)の値"
Get-EventLogコマンドレットの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。
出力するCSVファイルの項目を次に示します。
項目はコンマ区切りで出力します。
(a) イベントID(ヘッダー名：EventID)
(b) マシン名(ヘッダー名：MachineName)
(c) インデックス(ヘッダー名：Index)
(d) カテゴリー(ヘッダー名：Category)
(e) カテゴリー番号(ヘッダー名：CategoryNumber)
(f) イベントの種類(ヘッダー名：EntryType)
(g) メッセージ(ヘッダー名：Message)
(h) ソース(ヘッダー名：Source)
(i) イベント生成時刻(ヘッダー名：TimeGenerated)
(j) イベント出力時刻(ヘッダー名：TimeWritten)
(k) ユーザー名(ヘッダー名：UserName)
利用場面
Windowsのイベントログにあるイベントの一覧を取得する場合に使用します。
前提条件
【システム内前提製品】/【実行対象サーバの稼働OS】の最新のサポート状況については，リリースノートを参照してください。
【システム内前提製品】
JP1/Automatic Operation 11-00以降
【実行対象サーバの稼働OS】
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter，Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
注意事項
(1) 部品のプロパティには「"」(ダブルクォーテーション)および「'」(シングルクォーテーション)を含む文字列は指定しないでください。
実行権限
(1) 実行サーバに接続する際のユーザーは，イベントログのイベントを参照するために必要な権限を持っている必要があります。
バージョン
02.01.00
部品のタグ
Gather OS information,Windows
タスクログに表示される部品の名称
osEventLogGetEvent
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
Windows.eventLogName |
イベントログ名 |
イベントログの名前を指定します。 |
− |
入力 |
○ |
|
common.outputFilePath |
出力ファイルのパス |
出力するファイルをフルパスで指定します。 |
− |
入力 |
○ |
|
Windows.eventStartDateTime |
イベントの取得開始日時 |
指定された日時のあとに発生したイベントを取得します。 |
− |
入力 |
△ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |