Tuning Manager Software ユーザーズガイド
アラームの状態が変化したときに,システムがどのような動作を実行するかのアクションを設定します。実行できるアクションを次に示します。
- emailを送信する
- 任意のコマンドを実行する
- SNMPトラップを送信する
- 注意
- [新規アラーム > 基本情報]画面の[全般]エリアで[値の存在を監視するアラームとする]を選択した場合,[警告]は選択できません。
- [新規アラーム > 基本情報]画面の[高度な設定]フィールドで[常にアラーム通知する]を選択した場合,[正常]は選択できません。
- アクションは複数を組み合わせることもできます。
- email通知を実行したい場合,事前に設定が必要です。「8.3.1 emailの送信元の設定」を参照してください。
- コマンドを実行したい場合,事前に設定が必要です。「8.3.2 コマンドを実行するホストの設定」を参照してください。
- SNMPトラップの通知を実行したい場合,事前に設定が必要です。「8.3.3 SNMPトラップを送信するための設定」を参照してください。
- この項の構成
- (1) emailを送信する
- (2) 任意のコマンドを実行する
- (3) アラーム発生時にSNMPトラップを送信する
- (4) アクションの実行に関する注意事項
アラームイベントが発生したときにemailを送信する場合の手順を次に示します。
- [新規アラーム > アクション]画面で,[Eメール]を選択します。
- email送信の契機を[異常][警告][正常]から選択します。
- [次へ >]ボタンをクリックします。[Eメールの定義]エリアが表示されます。
- emailのアドレス,email本文などを設定します。
- [Eメールアドレス]
- 通知先のemailアドレスを,127バイト以内の半角英数字で指定します。
- 複数のemailアドレスを指定する場合は,「,(コンマ)」で区切ります。
- [アクションハンドラ]
- emailの送信を実行するAction Handlerサービスを,ドロップダウンリストから選択します。デフォルトで,Action Handlerサービス名(サービスID)が表示されています。
- 使用するAction Handlerサービス名が表示されない場合は,[サービス階層]画面で該当するAction Handlerサービスのプロパティを表示させ,[Capabilities]の[Email]を「Yes」に設定してください。
- [変数名]
- 送信するemailのメッセージテキストに設定できる変数が表示されます。
- ここに表示される変数一覧から任意の変数を選択し,[変数を追加]ボタンをクリックすると,送信するemailのメッセージテキストとして[メール本文]に追加されます。
- ここに表示される変数を次の表に示します。
項目名 変数名 説明 日付/時刻 %SCT アラーム評価をしたエージェントが稼働しているホストのシステム時刻が表示される。 エージェント名 %ANS このアラームテーブルがバインドされたエージェント名が表示される。 ホスト名 %HNS このアラームテーブルがバインドされたエージェントが稼働しているホスト名が表示される。 状態 %SCS メッセージ出力の対象となったアラーム状態が表示される。
次のどれかの値になります。
- OK:正常の場合
- WARNING:警告の場合
- EXCEPTION:異常の場合
アラーム名 %AIS [新規アラーム > 基本情報]または[編集 > 基本情報]画面の[アラーム名]に設定したアラーム名が表示される。 アラームテーブル名 %ATS [新規アラーム > 基本情報]または[編集 > 基本情報]画面の[アラームテーブル名]に設定したアラームテーブル名が表示される。 メッセージテキスト %MTS※1 [新規アラーム > 基本情報]または[編集 > 基本情報]画面の[メッセージテキスト]に設定したメッセージテキストが表示される。 プロダクト %PTS [新規アラーム > 基本情報]または[編集 > 基本情報]画面の[プロダクト]に設定したプロダクト名が表示される。 測定値 %CVS[n][.p]※2※3※4 アラーム通知の対象となった(条件式を満たした)測定値が表示される。 アラーム条件式の設定によって,評価する順序が異なります。
- n※5
[新規アラーム > アラーム条件式]または[編集 > アラーム条件式]画面で,条件式を複数指定した場合のフィールドの位置を,1以上の数値で指定する。先頭フィールドは1を数指定する。ただし0または条件式のより大きい値を指定した場合は先頭フィールドの測定値が表示される。- p※5
整数または小数に置換されるフィールドの場合:
表示したい小数部の桁数(四捨五入して表示)を指定する。
測定値が文字列に置換されるフィールドの場合(アラーム正常回復時,文字列「<OK>」に置換される場合も含む):
測定値を半角スペースで区切って分割してできる文字列のうち,表示したい文字列の位置を指定する。位置を指定する場合は,1以上の値を指定する。0を指定した場合は,測定値がそのまま表示される。半角スペースで区切って分割してできる文字列の個数より大きい値を指定した場合は,長さが0バイトの文字列(空文字列)に置換される。
アラーム条件式内に同じフィールドを2つ以上指定すると,変数%CVSの値は最初のフィールドが指す値に集約されます。
同じフィールドを2つ以上設定した場合および評価順序については,「8.4.4 アラーム条件式を設定する」の参考を参照してください。
- 注※1
- 複数インスタンスレコードを使用したアラーム定義で,アラームの状態が異常または警告から正常に変化した場合,変数%MTSに格納される値は次のようになります。
- ・アラーム正常回復時の測定値出力機能が有効の場合
- アラームが正常状態に遷移する前までの間で,最後に発行された異常または警告アラームの要因となったインスタンスの,アラームメッセージテキストが格納される。
- ・アラーム正常回復時の測定値出力機能が無効の場合
- イベント発行要因となる値が特定されないため,空文字列が格納される。
- なお,アラーム正常回復時の測定値出力機能の詳細については,マニュアル「JP1/Performance Management 運用ガイド」の,アラームによる稼働監視について説明している章を参照してください。
- 注※2
- 複数インスタンスレコードを使用したアラーム定義で,アラームの状態が異常または警告から正常に変化した場合,変数%CVSに格納される値は次のようになります。
- ・アラーム正常回復時の測定値出力機能が有効の場合
- アラームが正常状態に遷移する前までの間で,最後に発行された異常または警告アラームの要因となったインスタンスの,現在の測定値が格納される。
- ・アラーム正常回復時の測定値出力機能が無効の場合
- 条件式を満たした測定値が存在しないため,文字列「<OK>」が格納される。ただし,変数%CVS[n][.p]のpの値に2以上の値を指定した場合は,空文字列が格納される。
- なお,アラーム正常回復時の測定値出力機能の詳細については,マニュアル「JP1/Performance Management 運用ガイド」の,アラームによる稼働監視について説明している章を参照してください。
- 注※3
- 変数%CVSで展開される文字列の最大長は79バイトになります。
- アラーム条件式が複数ある場合は,「条件式ごとの置換文字の合計値」に「アラーム条件式の数から1バイト引いた値」を足した合計値が79バイトとなります。
- 注※4
- 変数%CVSで置換される文字列に「|」が含まれる場合,「|」より後ろの部分は切り捨てられます。
- 注※5
- 指定できる値の桁数は5桁までです。6桁以上の値を指定した場合は6桁目以降の文字列は展開されないで,アラーム通知時のメッセージにそのまま表示されます。
- [変数を追加]ボタン
- [変数名]で選択した変数を,[メール本文]に追加します。
例えば,次の条件でemailを送信すると仮定します。
- [メール本文]
- 返信するemailのメッセージテキストの内容を全角文字,半角文字で指定します。指定できる文字数は,1,000バイト以内です。[メール本文]には,次のテキストがあらかじめ設定されています。
- Date:%SCT,Host:%HNS,Product:%PTS,Agent:%ANS,Alarm:%AIS(%ATS),State:%SCS,Message:%MTS
- 注意
- 変数を値に置換したあとのメッセージテキストの長さが1,000バイトを超える場合,アラームが通知されるタイミングでAgent Collectorサービスが次のメッセージを出力します。
- KAVE00184-W 変数展開後の文字数が値フィールドの制限文字数を超えています(service=サービスID, alarm table=アラームテーブル名, alarm=アラーム名)
- この場合,メッセージテキストに指定する文字列や%CVSに指定する桁数を1,000バイトに収まるように調節してください。
条件:この場合,次のように設定します(「図8-7 [新規アラーム > アクション定義]画面」参照)。
- emailアドレス:T.Hitachi@Dept01.Hitachi.com へ送信する
- アクションハンドラ:ホスト名がWebAPのAction Handlerサービスでemailを送信する
- email本文:「日付/時刻,ホスト名,プロダクト名」の文を送信する
[Eメールアドレス]:T.Hitachi@Dept01.Hitachi.com
[アクションハンドラ]:PH1WebAP
[メール本文]:Date:%SCT Host:%HNS Product:%PTS
- 注意
- ・アラームの定義で[値の存在を監視するアラームとする]をチェックした場合,アラーム通知時は収集されたデータに条件式で指定した値が存在しません。このためメッセージテキストやMail Subjectに変数%CVSを指定しても,アラーム正常回復時の測定値出力機能を有効に設定している場合は「N/A」,無効に設定している場合は空文字列に置換されます。
- ・メッセージテキストで「%CVS」のあとにマルチバイト文字(例:,)を指定すると,変数展開後の文字列が文字化けすることがあります。「%CVS」のあとにマルチバイト文字を指定しないでください。
- [完了]ボタンをクリックします。設定が完了します。
アラームイベントが発生したときに任意のコマンドを実行する場合の手順を次に示します。
- [新規アラーム > アクション]画面で,[コマンド]を選択します。
- コマンド実行の契機を[異常][警告][正常]から選択します。
- [次へ >]ボタンをクリックします。[コマンドの定義]エリアが表示されます。
- 実行するコマンド名,コマンド引数などを設定します。
- [コマンド名]
- 実行するコマンド(スクリプト)名を,511バイト以内の半角英数字で指定します。次のディレクトリにあるコマンド(スクリプト)以外は,フルパスまたはサービスのカレントディレクトリ相対パスで指定してください。
- ・Action Handlerサービスのインストール先ディレクトリ
- ・環境変数のPATH変数に設定されているパス
- 相対パスを指定する場合は,Action Handlerサービスのカレントディレクトリを[サービス階層]画面で確認してください。
- [アクションハンドラ]
- コマンド(スクリプト)を実行するAction Handlerサービスを,ドロップダウンリストから選択します。デフォルトでは,[LOCAL](アラームテーブルをバインドしたエージェントのホスト)が表示されています。
- 使用するAction Handlerサービス名(サービスID)が表示されない場合は,[サービス階層]画面で該当するAction Handlerサービスのプロパティを表示させ,[Capabilities]の[Script]を「Yes」に設定してください。
- [変数名]
- コマンドの引数に設定できる変数が表示されます。
- ここに表示される変数一覧から任意の変数を選択し,[変数を追加]ボタンをクリックすると,コマンド引数として[コマンド引数]に追加されます。
- 設定できる変数は,[Eメールの定義]の[変数名]で説明しているものと同じです。
- [変数を追加]
- [変数名]で選択した変数を,[コマンド引数]に追加します。
例えば,次の条件でコマンドを実行すると仮定します。
- [コマンド引数]
- 実行するコマンド(スクリプト)に渡すパラメーターを,2,047バイト以内の全角文字または半角英数字で指定します。
- 注意
- 変数を値に置換したあとのコマンド引数の長さが2,047バイトを超える場合,アラームが通知されるタイミングでAgent Collectorサービスが次のメッセージを出力します。
- KAVE00184-W 変数展開後の文字数が値フィールドの制限文字数を超えています(service=サービスID, alarm table=アラームテーブル名, alarm=アラーム名)
- この場合,コマンド引数に指定する文字列や%CVSに指定する桁数を2,047バイトに収まるように調節してください。
条件:この場合,次のように設定します(「図8-8 コマンド設定例」参照)。
- ログ出力用に作成した/usr/bin/LogOutputコマンドを実行する
- WebAPホストのAction Handlerでコマンドを実行する
- パラメーターとしてコマンドに渡す内容は,日付/時刻,ホスト名,メッセージテキストとする
[コマンド名]:/usr/bin/LogOutput
[アクションハンドラ]:PH1WebAP
[コマンド引数]:Date:%SCT Host:%HNS %MTS
- 注意
- ・コマンドにパラメーターとして渡す文字列に,次の半角記号を使用することはできません。
- < >
- 指定した場合は前後の文字が切り取られることがあります。
- ・コマンドの標準出力をファイルなどにリダイレクトすることはできません。
- [完了]ボタンをクリックします。設定が完了します。
アラームイベントが発生したときにSNMPトラップを送信する場合の手順を次に示します。
- [新規アラーム > アクション]画面で,[SNMP]を選択します。
- SNMPトラップ送信の契機を[異常][警告][正常]から選択します。
- [完了]ボタンをクリックします。設定が完了します。
Tuning Manager serverが送信するSNMPトラップのManagement Information Base (MIB)オブジェクトについては,マニュアル「JP1/Performance Management 運用ガイド」の,MIBオブジェクトの構成について説明している個所を参照してください。
- 参考
- SNMPトラップは,ログイン先のPFM - Manager(Trap Generatorサービス)が稼働しているサーバから発行されます。
アクションの実行に関する注意事項を次に示します。
- email送信時の前提プログラムについて
emailを送信する場合は,SMTP準拠のemailサーバが必要です。
ただし,認証を必要とするSMTPサーバおよび拡張SMTPしか受け付けないSMTPサーバを用いたemail送信はできません。- コマンド実行時の実行ファイルについて
- Windows上で実行する場合
- コマンド実行時は,次に示す拡張子を持つファイルを実行できます。
- ・ EXE:実行形式ファイル
- ・ COM:実行形式(コマンド)ファイル
- ・ BAT:バッチファイル
- DEL,DIRなどの内部コマンドをジョブとして実行する場合は,バッチファイルを作成し,バッチファイル中のコマンドとして実行してください。
- また,コマンド実行で指定するプログラムファイルは,システムアカウントでアクセスできるファイルだけです。ネットワークフォルダにあるファイルは実行できません。
- SolarisおよびLinux上で実行する場合
- コマンド実行時は,次に示すファイルを実行できます。ただし,実行属性が付加されている必要があります。
- ・ 実行形式ファイル
- ・ シェルスクリプトファイル
- コマンド実行で指定するプログラムファイルは,rootユーザー権限でアクセスできるファイルだけです。NFSマウントのディレクトリにあるファイルを実行する場合は,そのホストのrootユーザー権限でアクセスできるように権限を設定する必要があります。
- コマンド実行時のアカウントについて
- Windows上で実行する場合
- コマンド実行時のアカウントは,システムアカウントです(なお,Action Handlerサービスのアカウントも,システムアカウントです)。
- そのため,プログラムから参照または更新するリソースについては,システムアカウントでアクセスできる必要があります。
- SolarisおよびLinux上で実行する場合
- コマンド実行時のアカウントは,rootユーザー権限のアカウントです(なお,Action Handlerサービスのアカウントも,rootユーザー権限のアカウントです)。
- そのため,プログラムから参照または更新するリソースについては,rootユーザー権限のアカウントでアクセスできる必要があります。
- コマンド実行時に有効となる環境変数について
- Windows上で実行する場合
- コマンド実行時に有効な環境変数は,Tuning Managerシリーズのプログラムのサービス起動時のシステム環境変数です。
- コマンド実行時にはプロファイル情報を読み込みません。
- SolarisおよびLinux上で実行する場合
- コマンド実行時に有効な環境変数は,Tuning Managerシリーズのプログラムのサービス起動時の,rootユーザー権限の環境変数です。
- コマンド実行時にはプロファイル情報を読み込みません。ただし,umaskについては「コマンド実行時に生成されるファイルのumaskについて」を参照してください。
- コマンド実行時のカレントディレクトリについて
- Windows上で実行する場合
- コマンド実行時のカレントフォルダは,Action Handlerサービスのフォルダ(PFM - Managerのインストール先フォルダ\bin\action)です。
- SolarisおよびLinux上で実行する場合
- コマンド実行時のカレントディレクトリは,Action Handlerサービスのディレクトリ(/opt/jp1pc/bin/action)です。
- コマンド実行時に生成されるファイルのumaskについて
- Windows上で実行する場合
- Windows環境ではumaskは関係ありません。
- SolarisおよびLinux上で実行する場合
- コマンド実行時のumaskは「000」に設定されます(ファイル権限は「777」です)。umaskを変更する場合は,実行するスクリプトファイルまたはプログラム中で,umaskを再設定する必要があります。
- コマンド実行時のそのほかの注意事項
- Windows上で実行する場合
- ・ Win16ビットアプリケーションは実行できません。
- ・ ウィンドウやダイアログボックスを表示するプログラムは実行できません。
- ただし,net sendコマンドを実行してダイアログボックスを表示することはできます。これは,net sendコマンドがダイアログボックスを表示するのではなく,WindowsのMessengerサービスが表示するためです。
- ・ Windowsメッセージ機構(DDE)を利用したプログラムは実行できません。
- ・ 対話操作を必要とするプログラムは実行できません。
- ・ 常駐プログラム(終了しないプログラム)は実行できません。
- ・ アプリケーションに関連づけられている拡張子を持つプログラムは実行できません。
- ・ ネットワークフォルダ上にあるプログラムは実行できません。
- ・ ディスクの準備ができていないリムーバブルディスク上のプログラムを設定しないでください。
- ・ Windowsサービスの起動設定で,デスクトップとの対話を許可する設定をしないでください。
- ・ 実行したプログラムの標準出力や標準エラー出力の内容は取得できません。
- ・ WindowsのSysWOW64システムフォルダ配下にあるコマンドをアラームのアクション定義に指定する場合は,絶対パスで指定してください。
- ・ コマンドのパスやコマンド名に半角空白文字を含む場合は,"(ダブルクォーテーション)で囲んでください。
- SolarisおよびLinux上で実行する場合
- ・ 対話操作を必要とするプログラムは実行できません。
- ・ 対話環境が前提であるstty,tty,tset,scriptコマンドを含むプログラムは実行できません。
- ・ 常駐プログラム(終了しないプログラム)は実行できません。
- ・ 実行属性が付加されていないプログラムは実行できません。
- ・ ディスクの準備ができていないリムーバブルディスク上のプログラムを設定しないでください。
- ・ 実行したプログラムの標準出力や標準エラー出力の内容は取得できません。
All Rights Reserved. Copyright© 2010, 2014, Hitachi, Ltd.