jp1pfmSuggestionGetAgentInformation
機能
指定したIM管理ノードに対応するエージェントのプロダクト名,業務グループ名,JP1資源グループ,ステータス(ヘルスチェックやアラーム)などを取得する関数です。
この関数を実行する前に,jp1pfmSuggestionGetAgentAllInformation関数を実行しておく必要があります。
前提バージョン
-
PFM - ManagerおよびPFM - Web Console:12-00以降
-
JP1/IM2:12-50以降
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに,必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を,次の表に示します。
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
|
---|---|---|---|---|---|
1 |
sid |
string |
不可 |
Performance ManagementのIM管理ノードのツリーIDを指定します。 jp1pfmSuggestionGetAgentAllInformation関数のsidと同じ値を指定します。 |
|
2 |
method |
string |
不可 |
"jp1pfmSuggestionGetAgentInformation"を指定します。 |
|
3 |
args |
object |
不可 |
項番4以降のメンバーを持つオブジェクトを指定します。 |
|
4 |
allInformation |
string |
不可 |
jp1pfmSuggestionGetAgentAllInformation関数のレスポンスのsuggestionに格納される値を指定します。 |
|
5 |
member |
number[] |
不可 |
取得対象の項目を配列で指定します。 次の値を指定できます。
上記の各値に対してレスポンスのsuggestionに格納される値については,「表5-6 memberに指定した値とsuggestionに格納される値」を参照してください。 |
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合,memberに指定した値に応じてsuggestionに格納される値を,次の表に示します。
memberに指定した値 |
suggestionに格納される値 |
---|---|
"productId" |
「プロダクトID」の値が格納されます。 |
"displayName" |
「表示名」の値が格納されます。 Performance Managementのプロダクト名表示機能を有効にしているかどうかによって,格納される値が異なります。 例えば,ホスト名が「hostA」であるホストにPFM - Agent for Platform(Windows)がセットアップ済みの場合,格納される値は次のようになります。
|
"healthSeverity" |
「ヘルスチェックステータスの重大度」の値が格納されます。 次のどれかの値が格納されます。該当するヘルスチェック状態の値はデフォルト値※を示します。
上記のヘルスチェック状態の値はデフォルト値※です。
|
"healthDetail" |
「ヘルスチェック状態」の値が格納されます。 次のどれかの値が格納されます。
|
"status" |
「エージェントの状態」の値が格納されます。 エージェントにバインドしているアラームの状態によって,次のどれかの値を取得します。 エージェントが監視一時停止の場合は,バインドしているアラームの有無や状態に関わらず,「Suspended」を取得します。
|
"businessGroupName" |
「監視ホストに対応づけられている業務グループ名」を取得できます。 業務グループ機能が無効の場合,または,業務グループが割り当てられていないホストの場合は,空文字を取得します。 |
"resourceGroupName" |
「監視ホストに対応づけられているJP1資源グループ名」を取得できます。 次の場合は,空文字を取得します。
|
エラーケース
エラーが発生した場合,args.setError()関数を呼び出して,メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを,次の表に示します。
エラー要因 |
メッセージID |
---|---|
提案定義ファイルのargsオブジェクトで,指定が必要なメンバーを指定していない。 |
KAJY24113-E |
提案定義ファイルのsidに,この関数で指定できない種類の,Performance ManagementのツリーSIDを指定した。 |
|
提案定義ファイルのallInformationまたはmemberに指定した値が誤っている。 |
注意事項
healthDetailに対してレスポンスに格納される値は,ヘルスチェックエージェントが最後に収集した性能情報を元に設定した値となります。このため,最大でHealth Check Detail(PD_HC)レコードのCollection Intervalプロパティ(収集間隔)に設定されている時間分のタイムラグが発生します。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については,JP1/AJS3のマニュアルの,提案テンプレートについて説明している章を参照してください。