機能説明
Windowsイベントログの情報を取得します。取得するイベントログの情報は、最大1000件です。
オプション
基本オプション
運用操作部品を実行する対象のホスト名またはIPアドレスです。
管理サーバで運用操作部品を実行する場合、以下を指定します。
IPv4の場合: 'localhost'または'127.0.0.1'
IPv6の場合: 'localhost'または'::1'
ホスト名またはIPアドレスを省略した場合、引数エラーとなります。
ホスト名またはIPアドレスの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
拡張オプション
取得するイベントのイベント種類です。
取得するイベント種類は、'Application'と'System'と’Security’を指定します。なお、大文字／小文字は区別しません。
上記以外のイベント種類を指定した場合、引数エラーとなります。
イベント種類を省略した場合、すべてのイベント種類のログ情報を取得します。
イベント種類の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
取得するイベントのイベントIDです。
イベントIDを省略した場合、すべてのイベントIDのログ情報を取得します。
指定できる範囲は、0から65535までです。それ以外の値を指定した場合、引数エラーとなります。
取得するイベントのソース名です。ソース名はログの出力元の名前です。
ソース名を省略した場合、すべてのソースのログ情報を取得します。
ソース名の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
ソース名は、以下のように指定します。
(例) winword
取得するイベントのレベルです。
以下のレベル以外を指定した場合、引数エラーとなります。
レベルを省略した場合、すべてのレベルのログ情報を取得します。
レベルの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
レベルとその意味を以下に示します。
レベル | 意味 |
|---|---|
1 | ERROR |
2 | INFORMATION |
3 | WARNING |
4 | AUDIT_SUCCESS |
取得するイベントのフィルターメッセージです。
フィルターメッセージに指定された文字列を含むイベントを取得します。
フィルターメッセージを省略した場合、フィルタリングを行いません。
メッセージの文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
取得するイベントの起点となる日時です。
指定した日時以降のイベントを取得します。
起点となる日時を省略した場合、イベントログに保存されている最も古いイベントから取得します。
起点となる日時の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
「指定形式は、年を4桁、月日時分秒を2桁で指定します(YYYYMMDDhhmmss)。」
(例) 20110830123055
取得するイベントログの終点となる日時です。
指定した日時以前のイベントを取得します。
終点となる日時を省略した場合、イベントログに保存されている最後のイベントまで取得します。
運用操作部品の実行と新規イベントの発生が競合した場合、新規のイベントが取得できない場合があります。
終点となる日時の文字数の上限は、1024文字です。それより大きい場合、引数エラーとなります。
「指定形式は、年を4桁、月日時分秒を2桁で指定します(YYYYMMDDhhmmss)。」
(例) 20110830123255
運用操作部品を実行する対象のホストのOS種別です。
Windowsを指定します。なお、大文字／小文字は区別しません。
OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。
OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザー名です。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。
業務サーバがWindowsの場合: Administrator
接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品を実行する対象のホストへSSHを利用して接続するユーザーのパスワードです。
接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。
ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。
接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。
運用操作部品の実行の完了待ち合わせ時間(秒)です。
300～86,400(1日)の範囲で指定が可能です。
(例) 完了待ち合わせを10分間行う場合：600
指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。
運用操作部品の実行の起動リトライ回数です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。
起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。
(例) 起動リトライを2回行う場合：2
運用操作部品のリトライ間隔(秒)です。
運用操作部品が復帰値：161で終了した場合に、起動リトライを行うまでの間隔を指定します。1～14400の範囲で指定が可能です。
(例) 300秒間隔でリトライを行う場合：300
timeout、retry、およびretry_intervalについて、指定を省略した場合や、範囲外の値を入力した場合は、運用操作部品実行定義ファイルで指定した値が有効になります。詳細は、“2.5 運用操作部品実行定義ファイル”を参照してください。
復帰値
アイコン | シンボル名 | 復帰値 | 意味 |
|---|---|---|---|
| 成功 | 0 | イベントログの取得に成功しました。 |
| 失敗 | 161 | イベントログの取得に失敗しました。リトライ回数を指定した場合、リトライします。 |
187 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)時の認証に失敗しました。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
188 | RBAエージェントが導入されていない業務サーバに対して運用操作部品による操作を実施中に、業務サーバとのネットワーク通信(SSH)が切断されました。 | ||
189 | 運用操作部品による操作を実施する際、業務サーバにネットワーク接続(SSH)できませんでした。 または、運用操作部品による操作を実施する際に、業務サーバとの通信処理（ファイル転送基盤）で異常が発生しました。実行結果にファイル転送基盤のエラーコードを出力します。エラーコードについては、“3.22 ファイル転送基盤の詳細コード”を参照してください。 | ||
197 | 入力情報に誤りがありました。 | ||
200 | イベントログの取得が異常終了しました。 | ||
－ | － | 201 | 運用操作部品の実行がタイムアウトしました。 |
202 | 運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。 | ||
203 | 運用操作部品を正常に実行できませんでした。管理サーバの環境に問題があります。 | ||
205 | 運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。 | ||
206 | 運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。 | ||
207 | 運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。 | ||
208 | 運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。 |
出力情報
変数 | 意味 |
|---|---|
message | イベントログの取得に成功した場合、以下のメッセージを設定します。 The operation component was successful. イベントログの取得に失敗した場合、エラー内容を文字列として設定します。 |
log_get_result | イベントログの取得内容を以下の形式で設定します。 [メッセージ]の内容に改行が含まれた場合、空白に変換します。 [イベントID],[イベント種類],[ソース],[レベル],[メッセージ],[発生時刻] ＜例＞ "6009","System","winword","ERROR",~"testEventLogMessage","20110830123255" |
nexttime | 取得したイベントログが1000件を超えた場合、残りのイベントログの先頭の日時を設定します。 設定形式は、年を4桁、月日時分秒を2桁で設定します(YYYYMMDDhhmmss)。 |
returnCode | 復帰値を設定します。 |
注意事項
本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
「～」「￡」「―」「∥」「￠」「￢」「￣」「￥」「〃」
業務サーバにRBAエージェントが未導入の場合は、sourcenameオプションおよびmessageオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
取得したイベントログの情報が1000件を超えた場合、1000件目のイベントログと発生時刻が同じイベントログは、1000件目以降でも取得対象とします。
本運用操作部品は、以下のオプションに指定した値をもとに、“wmic ntevent”コマンドを実行してイベントログを取得しています。“wmic ntevent”コマンドは、大量にイベントログを取得する場合、時間がかかる場合があります。このため、取得するイベントログが大量にならないように以下のオプションを指定してください。また、timeoutに適切な値を設定してください。
eventtype
eventid
sourcename
level
message
starttime
endtime
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
管理サーバのイベントログ(管理サーバがWindows(R)の場合)
管理サーバのシスログ(管理サーバがLinuxの場合)
BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。
