jp1pfmSuggestionGetCurrentlyNormalEvents
機能
SEVERITY(重大度)がWarningまたはErrorであるJP1イベントのうち,現在は状態が正常に回復しているイベントの一覧を取得する関数です。
取得対象のJP1イベントとレスポンスに格納される条件を,次の表に示します。
取得対象のJP1イベント |
レスポンスに格納される条件 |
---|---|
Performance ManagementのすべてのJP1ユーザーイベント |
拡張属性に設定されているアラームテーブル名とアラーム名に一致するアラームの状態が,現在正常である。 |
イベントIDが「00004840」のJP1システムイベント |
提案活性条件に指定するsidのエージェントの状態が,現在正常である。 |
イベントIDが「00004850」のJP1システムイベントのうち,発行元がStoreサービスでないイベント |
前提バージョン
-
PFM - Manager:12-50以降※
-
PFM - Web Console:12-00以降
-
JP1/IM2:12-50以降
- 注※
-
PFM - Managerホストに,バージョン12-10以降のJP1/Baseが必要です。
また,JP1/IM2の提案機能をPerformance Managementのユースケース1で運用する場合は,監視対象ホストにPFM - Agent for Platform(バージョンは問いません)が必要です。
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに,必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を,次の表に示します。
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
|
---|---|---|---|---|---|
1 |
sid |
string |
不可 |
Performance ManagementのIM管理ノードのツリーIDを指定します。 jp1pfmSuggestionGetAllAlarmStatuses関数のsidと同じ値を指定します。 |
|
2 |
method |
string |
不可 |
"jp1pfmSuggestionCurrentlyNormalEvents"を指定します。 |
|
3 |
args |
object |
不可 |
項番4以降のメンバーを持つオブジェクトを指定します。 |
|
4 |
events |
string |
不可 |
jp1pfmSuggestionGetPerformanceEvents関数のレスポンスのsuggestionに格納される値を指定します。 |
|
5 |
allAlarmStatuses |
string |
不可 |
jp1pfmSuggestionGetAllAlarmStatuses関数のレスポンスのsuggestionに格納される値を指定します。 |
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合,eventsに指定したJP1イベントのうち,状態が正常に回復しているイベントのSIDの配列がJSON形式で格納されます。該当するJP1イベントが1つもない場合は,空文字が格納されます。
エラーケース
エラーが発生した場合,args.setError()関数を呼び出して,メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを,次の表に示します。
エラー要因 |
メッセージID |
---|---|
提案定義ファイルのargsオブジェクトで,指定が必要なメンバーを指定していない。 |
KAJY24113-E |
提案定義ファイルのsidに,この関数で指定できない種類の,Performance ManagementのツリーSIDを指定した。 |
|
提案定義ファイルのallAlarmStatusesに指定した値が誤っている。 |
注意事項
-
次のどれかに該当するJP1イベントは,レスポンスに格納されません。
-
拡張属性に設定されているアラームテーブルがアンバインド,またはアラームが削除されている。
-
拡張属性に設定されているアラームが,現在は無効(インアクティブ状態)である。
-
拡張属性に設定されているアラームが,「レコードのインスタンスごとの状態変化」を選択しているアラームで,1つ以上のインスタンスが正常回復していない。
-
sidで指定したエージェントが監視一時停止状態である。
-
PFM - Managerが,sidで指定したエージェントと通信できない。
-
-
現在時刻がアラーム評価時間外である場合や,ユーザー操作によってアラーム定義を変更するなどしてアラームが一時的に正常回復した場合でも,そのJP1イベントはレスポンスの格納対象となります。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については,「提案定義ファイル(imdd_suggestion_任意の文字列.conf)の記述例」の「アラームまたはエージェントの状態が正常に回復したときに,イベントの対処状況を「対処済」に変更する場合の記述例」を参照してください。