jp1pfmSuggestionGetAgentInformation
- Organization of this page
Description
This function gets some information, such as a product name, business group name, JP1 resource group, and status (health check and alarms), of an agent that corresponds to a specified IM management node.
Before running this function, you must execute the jp1pfmSuggestionGetAgentAllInformation function.
Prerequisite version
-
PFM - Manager and PFM - Web Console: 12-00 or later
-
JP1/IM2: 12-50 or later
How to specify the function in the suggestion definition file
Specify necessary values for the members of the following objects to be specified in suggestion activation criteria and response action:
-
key object with the plugin type in the suggestion activation criteria
-
params object with the plugin type in the response action
The following table lists and describes the values you specify.
No. |
Member name |
Data type |
Optional |
Description |
|
---|---|---|---|---|---|
1 |
sid |
string |
No |
Specify the tree ID of the IM management node of Performance Management. Specify the same value as sid of the jp1pfmSuggestionGetAgentAllInformation function. |
|
2 |
method |
string |
No |
Specify "jp1pfmSuggestionGetAgentInformation". |
|
3 |
args |
object |
No |
Specify an object with the members in No. 4 and later. |
|
4 |
allInformation |
string |
No |
Specify the value stored in suggestion of the response of the jp1pfmSuggestionGetAgentAllInformation function. |
|
5 |
member |
number[] |
No |
Specify the items to be obtained as an array. The values you can specify are as follows:
For details on the value stored in suggestion of the response for each of the above values, see Table 5-6 Values specified for member and a value stored in suggestion. |
What value is contained in the suggestion member in the response
The following table describes the values stored in suggestion depending on values specified for member if the processing is successful.
Value specified for member |
Value stored in suggestion |
---|---|
"productId" |
The value of the product ID is stored. |
"displayName" |
The value of the display name is stored. A different value is stored depending on whether the product name display functionality of Performance Management is enabled. For example, if PFM - Agent for Platform (Windows) has been set up on the host with the host name of hostA, the following value is stored:
|
"healthSeverity" |
The value of the severity of the health check status is stored. One of the following values is stored. The value of the applicable health check status shows the default value#.
The values of the above health check statuses are the default value#.
|
"healthDetail" |
The value of the health check status is stored. One of the following values is stored:
|
"status" |
The value of the agent status is stored. One of the following values is obtained depending on the status of the alarm bound to the agent. If monitoring of the agent is suspended, Suspended is obtained regardless of the existence or status of the bound alarm.
|
"businessGroupName" |
The name of the business group associated with the monitoring host can be obtained. If the business group functionality is disabled or a business group is not assigned to a host, an empty string is obtained. |
"resourceGroupName" |
The name of the JP1 resource group associated with the monitoring host can be obtained. An empty string is obtained if:
|
Error case
If an error occurs, the args.setError() function is called to store its message.
The following table describes causes of errors and message IDs of messages to be stored.
Cause of error |
Message ID |
---|---|
The args object in the suggestion definition file does not specify necessary members required. |
KAJY24113-E |
A Performance Management tree SID of a type that cannot be accepted in this function was specified for sid in the suggestion definition file. |
|
An incorrect value is specified for allInformation or member in the suggestion definition file. |
Note
A value specified based on the last performance information collected by the health check agent is stored in the response value for healthDetail. Therefore, this causes a delay of the time specified for the Collection Interval property (collection interval) of the Health Check Detail (PD_HC) record at the maximum.
Example of how to specify in the suggestion definition file
For an example of the suggestion definition file that contains this function, see the topic describing the suggestion template in the manuals of JP1/AJS3.