jp1pfmSuggestionGetAgentAllInformation

〈このページの構成〉

機能

指定したIM管理ノードに対応するエージェントの情報を取得する関数です。

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

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

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

処理が成功した場合，エージェントの情報を保持する文字列（空文字以外）が格納されます。この文字列から特定の情報を取得するには，jp1pfmSuggestionGetAgentInformation関数を使用します。

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

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

エラー要因	メッセージID
PFM - Web Consoleにアクセスできなかった。	`KAJY24100-E`
PFM - Web Consoleで内部エラーが発生した。	`KAJY24101-E`
PFM - Web Consoleとの通信中に障害が発生した。	`KAJY24102-E`
処理中にJP1/IM2の構成情報が変更された。	`KAJY24105-E`
提案定義ファイルの`sid`に，この関数で指定できない種類の，Performance ManagementのツリーSIDを指定した。	`KAJY24113-E`

PFM - ManagerとPFM - Web Consoleのサービスが稼働している必要があります。
PFM - Managerに負荷がかかっている場合，処理に時間が掛かったり，タイムアウトが発生したりすることがあります。その場合は，しばらく時間をおいてから再度実行してください。

この関数を使用した提案定義ファイルの記述例については，JP1/AJS3のマニュアルの，提案テンプレートについて説明している章を参照してください。