jp1pfmSuggestionGetHostName
機能
指定したIM管理ノードが所属するホストの,Performance Managementが認識している監視ホスト名を取得する関数です。
前提バージョン
-
PFM - ManagerおよびPFM - Web Console:12-00以降
-
JP1/IM2:12-50以降
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに,必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を,次の表に示します。
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
---|---|---|---|---|
1 |
sid |
string |
不可 |
Performance ManagementのIM管理ノードのツリーIDを指定します。 ツリーIDの指定方法については,「提案定義ファイル(imdd_suggestion_任意の文字列.conf)の設定項目」を参照してください。 |
2 |
method |
string |
不可 |
"jp1pfmSuggestionGetHostName"を指定します。 |
3 |
args |
object |
不可 |
{}(空オブジェクト)を指定します。 |
レスポンスのsuggestionメンバーに格納される値
処理が成功した場合,指定したIM管理ノードが所属するホストのホスト名が格納されます。
エラーケース
エラーが発生した場合,args.setError()関数を呼び出して,メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを,次の表に示します。
エラー要因 |
メッセージID |
---|---|
処理中にJP1/IM2の構成情報が変更された。 |
KAJY24105-E |
注意事項
なし。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については,「提案定義ファイル(imdd_suggestion_任意の文字列.conf)の記述例」の「ホストをメンテナンスしているときに,監視を一時停止する場合の記述例」を参照してください。