jp1pfmSuggestionGetAgentInformation

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[]

不可

取得対象の項目を配列で指定します。

次の値を指定できます。

• "productId"

  プロダクトID

• "displayName"

  表示名

• "healthSeverity"

  ヘルスチェックステータスの重大度

• "healthDetail"

  ヘルスチェック状態

• "status"

  エージェントの状態

• "businessGroupName"

  監視ホストに対応づけられている業務グループ名

• "resourceGroupName"

  監視ホストに対応づけられているJP1資源グループ名

上記の各値に対してレスポンスのsuggestionに格納される値については，「表5-6 memberに指定した値とsuggestionに格納される値」を参照してください。

"productId"

「プロダクトID」の値が格納されます。

"displayName"

「表示名」の値が格納されます。

Performance Managementのプロダクト名表示機能を有効にしているかどうかによって，格納される値が異なります。

例えば，ホスト名が「hostA」であるホストにPFM - Agent for Platform（Windows）がセットアップ済みの場合，格納される値は次のようになります。

• プロダクト名表示機能が有効な場合

  hostA<Windows>

• プロダクト名表記機能が無効な場合

  TA1hostA

"healthSeverity"

「ヘルスチェックステータスの重大度」の値が格納されます。

次のどれかの値が格納されます。該当するヘルスチェック状態の値はデフォルト値^※を示します。

• Information

  該当するヘルスチェック状態：Running，Suspended

• Warning

  該当するヘルスチェック状態：Incomplete

• Error

  該当するヘルスチェック状態：Stopped，Unconfirmed，Host Not Available

• None

  該当するヘルスチェック状態：Not Supported

上記のヘルスチェック状態の値はデフォルト値^※です。

注※

ヘルスチェックエージェントの「Health Check Configurations」ノードの「JP1 Event -ヘルスチェック状態の値」プロパティの設定に依存します。なお，「Suspended」に該当する重大度は固定で変更できません。

"healthDetail"

「ヘルスチェック状態」の値が格納されます。

次のどれかの値が格納されます。

• Not Supported

  非対応（ヘルスチェック非対応のエージェント）

• Running

  動作中

• Incomplete

  縮退稼働

• Stopped

  サービス停止

• Unconfirmed

  状態不明

• Host Not Available

  ホスト停止

• Suspended

  監視一時停止中

"status"

「エージェントの状態」の値が格納されます。

エージェントにバインドしているアラームの状態によって，次のどれかの値を取得します。

エージェントが監視一時停止の場合は，バインドしているアラームの有無や状態に関わらず，「Suspended」を取得します。

• OK

  すべて正常状態である^※

• Warning

  異常状態のものがなく，警告状態のものが1つ以上ある

• Exception

  異常状態のものが1つ以上ある

• Suspended

  監視一時停止中である

注※

次の状態も正常状態とみなします。

・バインドしているアラームがない

・アラームのアクティブ設定が無効である

"businessGroupName"

「監視ホストに対応づけられている業務グループ名」を取得できます。

業務グループ機能が無効の場合，または，業務グループが割り当てられていないホストの場合は，空文字を取得します。

"resourceGroupName"

「監視ホストに対応づけられているJP1資源グループ名」を取得できます。

次の場合は，空文字を取得します。

• 業務グループ機能が無効

• PFM - Managerの認証モードがPFM認証モード

• 業務グループが割り当てられていない

• 業務グループに資源グループが割り当てられていない

提案定義ファイルのargsオブジェクトで，指定が必要なメンバーを指定していない。

KAJY24113-E

提案定義ファイルのsidに，この関数で指定できない種類の，Performance ManagementのツリーSIDを指定した。

提案定義ファイルのallInformationまたはmemberに指定した値が誤っている。