4.16.12 イベントログへのイベント作成
機能
この部品は，Windowsの実行対象サーバで，イベントログにイベントを作成します。
この部品が前提とするサーバを次に示します。
・実行対象サーバ
この部品を実行する対象となるサーバです。
この部品内のスクリプトでは次に示す処理を行います。
・次のコマンドを実行します。
eventcreate
/l "イベントログ名(Windows.eventLogNameプロパティ)の値"
/so "イベントのソース(Windows.eventSourceプロパティ)の値"
/t "イベントの種類(Windows.eventTypeプロパティ)の値"
/id "イベントID(Windows.eventIDプロパティ)の値"
/d "イベントの説明(Windows.eventDescriptionプロパティ)の値"
eventcreateコマンドの詳細については，Microsoftのライブラリ内で記載している箇所を参照してください。
利用場面
他の部品での実行結果などを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
部品のタグ
Configure OS,Windows
タスクログに表示される部品の名称
osEventLogCreateEvent
戻り値
|
戻り値 |
説明 |
|---|---|
|
0 |
正常 |
|
21 |
異常(環境不正) コマンドが見つからない(部品スクリプトでエラーを検知) |
|
27 |
異常(エラー内容はタスクログで確認) |
|
41 |
異常(部品内でエラーを検知) プロパティ未入力(部品スクリプトでエラーを検知) |
プロパティ一覧
プロパティ一覧を次の表に示します。
|
プロパティキー |
プロパティ名 |
説明 |
デフォルト値 |
入出力種別 |
必須区分 |
|---|---|---|---|---|---|
|
plugin.destinationHost |
実行対象サーバのホスト名 |
この部品を実行するサーバのホスト名またはIPアドレスを指定します。IPv6アドレスには対応していません。 |
− |
入力 |
○ |
|
Windows.eventLogName |
イベントログ名 |
イベントログの名前を指定します。 |
− |
入力 |
○ |
|
Windows.eventSource |
イベントのソース |
イベントのソースを指定します。 |
− |
入力 |
○ |
|
Windows.eventType |
イベントの種類 |
イベントの種類を指定します。指定可能な値は，"SUCCESS"，"ERROR"，"WARNING"，"INFORMATION"です。 |
− |
入力 |
○ |
|
Windows.eventID |
イベントID |
イベントIDを1〜1000の範囲で指定します。 |
− |
入力 |
○ |
|
Windows.eventDescription |
イベントの説明 |
イベントの説明を指定します。 |
− |
入力 |
○ |
|
common.returnValue |
部品の戻り値 |
この部品の戻り値が格納されます。 |
− |
出力 |
△ |