3.10.4 監視製品にイベント通知

機能説明

Systemwalker Centric Managerなどの運用管理製品によりイベント監視を行っているサーバ上のイベントDBにイベントを発生します。

Systemwalker Centric Managerでイベント監視を行っている場合、“ラベル: エラー種別: メッセージテキスト”の形式でメッセージを作成し、Systemwalker Centric Managerのシステム監視エージェントへメッセージを通知します。

オプション

基本オプション

(1) hostname

運用操作部品を実行する対象のホスト名またはIPアドレスです。

Systemwalker Centric Managerでイベント監視を行っている場合は、Systemwalker Centric Managerの運用管理サーバのホスト名またはIPアドレスを指定します。

管理サーバで運用操作部品を実行する場合、以下を指定します。

IPv4の場合: “localhost”または“127.0.0.1”
IPv6の場合: “localhost”または“::1”

ホスト名またはIPアドレスを省略した場合、引数エラーとなります。

ホスト名またはIPアドレスの文字数の上限は、1024文字です。1024文字より大きい場合、引数エラーとなります。

(2) label

イベントに表示するラベルです。

Systemwalker Centric Managerでイベント監視を行っている場合、文字数の上限は以下のとおりです。以下の文字数より大きい場合、引数エラーとなります。

イベント監視を行っているサーバのOS種別がWindowsの場合、80文字です。

イベント監視を行っているサーバのOS種別がLinux、Solarisの場合、8文字です。

接尾辞のコロン“:”は自動的に付加されます。

ラベルを省略した場合の形式は、“エラー種別:メッセージテキスト”となり、ラベルは表示しません。

(3) errorkind

イベントに表示するエラー種別です。

Systemwalker Centric Managerでイベント監視を行っている場合、以下の“指定する文字列”を指定します。なお、大文字／小文字は区別しません。

イベント監視を行っているサーバのOS種別がWindowsの場合

指定する文字列	エラー種別	重要度
HALT	HALT	最重要
ERROR	ERROR	重要
WARNING	WARNING	警告
NOTICE	INFO	通知
INFO	INFO	一般

イベント監視を行っているサーバのOS種別がLinux、Solarisの場合

指定する文字列	エラー種別	重要度
HALT	停止	最重要
ERROR	エラー	重要
WARNING	警告	警告
NOTICE	情報	通知
INFO	情報	一般

エラー種別を省略した場合、Windowsの場合は“ERROR”、Linux、Solarisの場合は“エラー”を使用します。

(4) text

イベントに表示するメッセージテキストです。

Systemwalker Centric Managerでイベント監視を行っている場合、文字数の上限は以下のとおりです。以下の文字数より大きい場合、引数エラーとなります。

指定できるメッセージテキストの上限は、labelとerrorkindの文字数と合わせて600文字です。それより大きい場合、引数エラーとなります。

メッセージテキストを省略した場合、引数エラーとなります。

メッセージテキストに改行が含まれた場合、空白に変換します。

メッセージテキストの先頭には以下の文字列を追加します。

“[RBAXXXXX]”：XXXXXは運用プロセスのプロセスID

拡張オプション

(1) ostype

運用操作部品を実行する対象のホストのOS種別です。

Windows、Linux、Solarisを指定します。なお、大文字／小文字は区別しません。

OS種別の入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得したOS種別の値をSystemwalker Runbook Automationが自動的に設定します。

OS種別の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(2) username

運用操作部品を実行する対象のホストへSSHを利用して接続するユーザー名です。

接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続ユーザー名の値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、接続ユーザー名は以下のようになり変更できません。このため、ユーザー名を指定しても無効になります。

業務サーバがWindowsの場合: システムユーザー
業務サーバがLinux、Solarisの場合: root

接続ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(3) password

運用操作部品を実行する対象のホストへSSHを利用して接続するユーザーのパスワードです。

接続ユーザー名および接続に必要なパスワードの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した接続パスワードの値をSystemwalker Runbook Automationが自動的に設定します。

ファイル転送基盤を利用して接続する場合は、パスワードを指定しても無効になります。

接続に必要なパスワードの文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(4) execusername

運用操作部品を実行する対象のホストでコマンドを実行するユーザー名です。

実行ユーザー名およびexecpasswordの入力を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した管理者ユーザーの値をSystemwalker Runbook Automationが自動的に設定します。CMDBに登録されていない場合は、接続ユーザー名で実行します。

hostnameに指定したホストがWindowsで、ファイル転送基盤を利用して接続する場合は、システムユーザーで実行します。このため、ユーザー名を指定しても無効になります。

実行ユーザー名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(5) execpassword: 本運用操作部品ではexecpasswordの値を使用しません。execpasswordの値を指定した場合、無効となります。

(6) mwtype

本運用操作部品の連携対象となるイベント監視を行っている運用管理製品名を指定します。

Systemwalker Centric Managerでイベント監視を行っている場合は、“CMGR”を指定します。なお、大文字／小文字は区別しません。

本運用操作部品の連携対象はSystemwalker Centric Managerだけです。

運用管理製品名の指定を省略した場合、指定したホスト名またはIPアドレスを元に構成管理データベース(CMDB)を検索し、取得した値をSystemwalker Runbook Automationが自動的に設定します。

指定できる運用管理製品名の文字列の上限は、1024文字です。それより大きい場合、引数エラーとなります。

(7) mwinstallpath

本運用操作部品と連携するコマンドのインストールパスを指定します。

Systemwalker Centric Managerでイベント監視を行っている場合は、opfmtコマンドのインストールディレクトリの絶対パス名を指定します。

mwtypeの設定により、本運用操作部品の連携対象である運用管理製品がSystemwalker Centric Managerである場合は、省略することができます。

本運用操作部品の連携対象はSystemwalker Centric Managerだけです。

指定できるインストールパスの上限は、1024文字です。それより大きい場合、引数エラーとなります。

(8) timeout

運用操作部品の実行の完了待ち合わせ時間(秒)です。

300～86,400(1日)の範囲で指定が可能です。

(例) 完了待ち合わせを10分間行う場合：600

指定した時間を経過しても運用操作部品の実行が完了しない場合は、運用操作部品の処理を復帰値：201で中断します。

(9) retry

運用操作部品の実行の起動リトライ回数です。

運用操作部品が復帰値：161で終了した場合に、起動リトライを行う回数を指定します。0～5の範囲で指定が可能です。

起動リトライにより再実行した結果、運用操作部品が161以外の復帰値で終了した場合は、指定した起動リトライ回数に達していなくても運用操作部品の実行は終了します。運用操作部品の復帰値は最後に実行した値になります。

(例) 起動リトライを2回行う場合：2

(10) retry_interval

運用操作部品のリトライ間隔(秒)です。

運用操作部品が復帰値：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	オプションの指定に誤りがありました。もしくは、構成管理データベース(CMDB)の登録情報に問題があります。
		200	イベントの通知が異常終了しました。
－	－	201	運用操作部品の実行がタイムアウトしました。
		202	運用操作部品が実行されませんでした。運用操作部品を実行するための設定に問題があります。
		203	運用操作部品の実行が失敗しました。管理サーバの環境に問題があります。
		205	運用操作部品が実行されませんでした。運用操作部品の入力情報の指定に問題があります。
		206	運用操作部品を正常に実行できませんでした。運用操作部品の出力情報の指定に問題があります。
		207	運用操作部品が実行されませんでした。運用操作部品が管理サーバに登録されていない可能性があります。
		208	運用操作部品の実行途中に自動運用プロセスのリカバリが行われたため、自動運用プロセスを中止状態にしました。

出力情報

変数	意味
message	イベントの通知に成功した場合、以下のメッセージを設定します。 The operation component was successful. イベントの通知に失敗した場合、エラー内容を文字列として設定します。
event_message	イベントに表示するメッセージを設定します。メッセージはイベント監視を行っている運用管理製品によって異なります。 Systemwalker Centric Managerでイベント監視を行っている場合は、opfmtコマンドによるメッセージを出力します。出力形式、および出力項目については、“Systemwalker Centric Manager リファレンスマニュアル”を参照してください。
returnCode	復帰値を設定します。

変数

意味

message

イベントの通知に成功した場合、以下のメッセージを設定します。

The operation component was successful.

イベントの通知に失敗した場合、エラー内容を文字列として設定します。

event_message

イベントに表示するメッセージを設定します。

メッセージはイベント監視を行っている運用管理製品によって異なります。

Systemwalker Centric Managerでイベント監視を行っている場合は、opfmtコマンドによるメッセージを出力します。出力形式、および出力項目については、“Systemwalker Centric Manager リファレンスマニュアル”を参照してください。

returnCode

復帰値を設定します。

注意事項

本運用操作部品は、hostnameに管理サーバ以外の情報を入力した場合、ファイル転送基盤またはSSHを利用して動作を実現しています。少なくともどちらか片方では通信可能となるように設定してください。各通信方法の注意事項については、“3.17 各通信方法の注意事項”を参照してください。
接続ユーザーと実行ユーザーが異なる場合、“3.17.7 接続ユーザーと実行ユーザーが異なる場合の注意事項”を参照してください。
各オプションには、半角カナ文字および以下の記号は使用しないでください。半角カナ文字および以下の記号を使用すると、運用操作部品の実行に失敗する場合があります。
“～”、“￡”、“―”、“∥”、“￠”、“￢”、“￣”、“￥”、“〃”
業務サーバにRBAエージェントが未導入の場合は、textオプションに日本語を指定すると運用操作部品の操作結果は保証されません。日本語を指定する場合は業務サーバにRBAエージェントを導入してください。
Systemwalker Centric Managerでイベント監視を行っている場合、連携可能なバージョンレベルはV13.0.0以降です。
復帰値の確認は、Webコンソールで行います。詳細については、“Systemwalker Runbook Automation 運用ガイド”の“運用操作部品の実行状況・実行結果を確認する”を参照してください。
201～208の復帰値が出力された場合は自動運用プロセスが中止状態またはエラー状態となり、以下の場所にエラーメッセージが出力されます。
- 管理サーバのイベントログ(管理サーバがWindows(R)の場合)
- 管理サーバのシスログ(管理サーバがLinuxの場合)
- BPMNのカスタムメッセージ
上記いずれかの場所でメッセージを確認し、適切な対処を実施してください。メッセージの詳細については、“Systemwalker Runbook Automation メッセージ集”を参照してください。