jp1pfmSuggestionExecManagerCmd
機能
PFM - Managerの任意のコマンドを実行する関数です。
前提バージョン
-
PFM - Manager：12-50以降※
-
PFM - Web Console：12-00以降
-
JP1/IM2：12-50以降
- 注※
-
PFM - Managerホストに，バージョン12-10以降のJP1/Baseが必要です。
また，JP1/IM2の提案機能をPerformance Managementのユースケース1で運用する場合は，監視対象ホストにPFM - Agent for Platform（バージョンは問いません）が必要です。
提案定義ファイルでの指定方法
提案活性条件と対処アクションに指定する次のオブジェクトのメンバーに，必要な値を指定します。
-
提案活性条件のtypeが「plugin」のkeyオブジェクト
-
対処アクションのtypeが「plugin」のparamsオブジェクト
指定する値を，次の表に示します。
|
項番 |
メンバー名 |
データ型 |
省略可否 |
説明 |
|
|---|---|---|---|---|---|
|
1 |
sid |
string |
不可 |
コマンドを実行したいPFM - Managerの管理下にあるPerformance ManagementのIM管理ノードのツリーIDを指定します。 ツリーIDの指定方法については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の設定項目」を参照してください。 |
|
|
2 |
method |
string |
不可 |
"jp1pfmSuggestionExecManagerCmd"を指定します。 |
|
|
3 |
args |
object |
不可 |
項番4以降のメンバーを持つオブジェクトを指定します。 |
|
|
4 |
commandName |
string |
不可 |
実行したいPFM - Managerのコマンド名を指定します。 次のコマンド実行パスに格納されているコマンド名を指定できます。
|
|
|
5 |
commandArgs |
string |
可 |
コマンドの引数をスペース区切りで指定します。指定を省略した場合，引数なしで動作します。 なお，PFM - Managerが論理ホスト環境かどうかは自動で判定されるため，「-lhost 論理ホスト名」オプションの指定は不要です。 |
|
|
6 |
lhostOption |
boolean |
不可 |
実行するコマンドの仕様に応じて，次のどちらかを指定します。
|
|
|
7 |
successfulReturn |
number[] |
不可 |
コマンドの実行を成功扱いとする戻り値を配列で指定します。 |
|
レスポンスのsuggestionメンバーに格納される値
コマンドを実行して戻り値を取得できた場合，successfulReturnに指定した配列の値と比較します。配列のどれかの値と一致したときは，標準出力結果がsuggestionに格納されます。
エラーケース
エラーが発生した場合，args.setError()関数を呼び出して，メッセージが格納されます。
エラー要因と格納されるメッセージのメッセージIDを，次の表に示します。
|
エラー要因 |
メッセージID |
|---|---|
|
処理中にJP1/IM2の構成情報が変更された。 |
KAJY24105-E |
|
提案定義ファイルのargsオブジェクトで，指定が必要なメンバーを指定していない。 |
KAJY24113-E |
|
提案定義ファイルのcommandNameに，「\」または「/」を含む文字列を指定した。 |
|
|
提案定義ファイルのcommandNameとcommandArgsに，文字数の合計が3,072バイトを超える値を指定した。 |
|
|
PFM - Managerのコマンドを実行できなかった。 |
KAJY24114-E |
|
PFM - Managerのコマンドでエラーが発生した。 |
KAJY24115-E |
注意事項
-
PFM - Managerのコマンド実行パスにあるコマンドを実行できます。PFM - Web Consoleやエージェント製品が同梱するコマンドは実行できません。
-
監視二重化の環境の場合，プライマリーとセカンダリーのどちらか一方でコマンドが実行されます。片方が停止しているときは，もう片方でコマンドが実行されます。
-
この関数は，JP1/IM2のjp1Imdd.execCmdメソッドを使用しています。前提条件や制限値については，JP1/IM2のマニュアルの，jp1Imdd.execCmdメソッドについて説明している個所を参照してください。
提案定義ファイルでの指定例
この関数を使用した提案定義ファイルの記述例については，「提案定義ファイル（imdd_suggestion_任意の文字列.conf）の記述例」の「ホストをメンテナンスしているときに，監視を一時停止する場合の記述例」を参照してください。