jp1pfmSuggestionGetAlarmStatus

〈このページの構成〉

機能

指定したIM管理ノードに対応するエージェントにバインドしているアラームの状態を取得する関数です。

この関数を実行する前に，jp1pfmSuggestionGetAllAlarmStatuses関数を実行しておく必要があります。

注※

PFM - Managerホストに，バージョン12-10以降のJP1/Baseが必要です。

また，JP1/IM2の提案機能をPerformance Managementのユースケース1で運用する場合は，監視対象ホストにPFM - Agent for Platform（バージョンは問いません）が必要です。

提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに，必要な値を指定します。

指定する値を，次の表に示します。

表5‒7　keyオブジェクトとparamsオブジェクトのメンバーに指定する値
項番	メンバー名		データ型	省略可否	説明
1	`sid`		string	不可	Performance ManagementのIM管理ノードのツリーIDを指定します。 `jp1pfmSuggestionGetAllAlarmStatuses`関数の`sid`と同じ値を指定します。
2	`method`		string	不可	`"jp1pfmSuggestionGetAlarmStatus"`を指定します。
3	`args`		object	不可	項番4以降のメンバーを持つオブジェクトを指定します。
4		`allAlarmStatuses`	string	不可	`jp1pfmSuggestionGetAllAlarmStatuses`関数のレスポンスの`suggestion`に格納される値を指定します。
5		`alarmTableName`	string	不可	アラーム状態の取得対象のアラームテーブル名を指定します。
6		`alarmName`	string	不可	アラーム状態の取得対象のアラーム名を指定します。

処理が成功した場合，次の表に示すどれかの値がsuggestionに格納されます。

suggestionに格納される値	説明
`"OK"`	アラームが正常状態である。
`"Warning"`	アラームが警告状態である。
`"Exception"`	アラームが異常状態である。
`"Inactive"`	アラームのアクティブ設定は無効である。
`"Suspended"`	監視一時停止中である。
`"Unreachable"`	Agent CollectorまたはRemote Monitor Collectorに接続できない。
`"NotBound"`	`alarmTableName`に指定したアラームテーブルをバインドしていない，または，`alarmName`に指定したアラームが存在しない。

エラーが発生した場合，args.setError()関数を呼び出して，メッセージが格納されます。

エラー要因と格納されるメッセージのメッセージIDを，次の表に示します。

エラー要因	メッセージID
提案定義ファイルの`args`オブジェクトで，指定が必要なメンバーを指定していない。	`KAJY24113-E`
提案定義ファイルの`sid`に，この関数で指定できない種類の，Performance ManagementのツリーSIDを指定した。
提案定義ファイルの`allAlarmStatuses`に指定した値が誤っている。

なし。