jp1pfmSuggestionGetAllAlarmStatuses

〈このページの構成〉

機能

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

注※

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

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

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

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

表5‒8　keyオブジェクトとparamsオブジェクトのメンバーに指定する値
項番	メンバー名	データ型	省略可否	説明
1	`sid`	string	不可	Performance ManagementのIM管理ノードのツリーIDを指定します。次のどれかに対応するIM管理ノードのツリーIDを指定できます。 PFM - Manager（ヘルスチェックエージェント） PFM - AgentインスタンスのパフォーマンスデータリモートエージェントのパフォーマンスデータグループエージェントツリーIDの指定方法については，「提案定義ファイル（`imdd_suggestion_`任意の文字列`.conf`）の設定項目」を参照してください。
2	`method`	string	不可	`"jp1pfmSuggestionGetAllAlarmStatuses"`を指定します。
3	`args`	object	不可	`{}`（空オブジェクト）を指定します。

処理が成功した場合，エージェントにバインドしている全アラームの状態を保持する文字列（空文字以外）が格納されます。この文字列から特定のアラームの状態を取得するには，jp1pfmSuggestionGetAlarmStatus関数を使用します。

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

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

エラー要因	メッセージID
処理中にJP1/IM2の構成情報が変更された。	`KAJY24105-E`
提案定義ファイルの`sid`に，この関数で指定できない種類の，Performance ManagementのツリーSIDを指定した。	`KAJY24113-E`
PFM - Managerのコマンドを実行できなかった。	`KAJY24114-E`
PFM - Managerのコマンドでエラーが発生した。	`KAJY24115-E`

PFM - Managerのサービスが稼働している必要があります。
この関数は，JP1/IM2のjp1Imdd.execCmdメソッドを使用してPFM - Managerのコマンドを実行しています。前提条件や制限値については，JP1/IM2のマニュアルの，jp1Imdd.execCmdメソッドについて説明している箇所を参照してください。
PFM - Agentインスタンスのパフォーマンスデータをsidに指定し，そのエージェントがレコード収集中などの理由によってビジーである場合，最大で5分程度応答を返さないことがあります。その場合は，しばらく時間をおいてから再度実行してください。
PFM - ManagerがLinuxで動作する場合，JP1ユーザーにマッピングされているOSユーザーのログインシェルのLANG環境変数の値と，JP1/Baseが動作するLANG変数の値は一致させる必要があります。一致していない場合，取得したデータが文字化けすることがあります。