jp1pfmSuggestionGetAllAlarmStatuses
- Organization of this page
Description
This function gets the statuses of all alarms bound to an agent that corresponds to a specified IM management node.
Prerequisite version
-
PFM - Manager: 12-50 or later#
-
PFM - Web Console: 12-00 or later
-
JP1/IM2: 12-50 or later
- #
-
The PFM - Manager host must have JP1/Base version 12-10 or later.
Furthermore, if you use the suggestion function of JP1/IM2 in use case 1 of Performance Management, the monitored host requires PFM - Agent for Platform (of any version).
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. You can specify the tree ID of the IM management node that corresponds to one of the following:
For details on how to specify the tree ID, see Suggestion definition file settings (imdd_suggestion_arbitrary-character-string.conf). |
|
2 |
method |
string |
No |
Specify "jp1pfmSuggestionGetAllAlarmStatuses". |
|
3 |
args |
object |
No |
Specify {} (an empty object). |
What value is contained in the suggestion member in the response
If the processing is successful, the string having the statuses of all the alarms bound to the agent (not an empty string) is stored. To get the status of a specific alarm from this string, use the jp1pfmSuggestionGetAlarmStatus function.
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 configuration information of JP1/IM2 was changed during the processing. |
KAJY24105-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. |
KAJY24113-E |
|
Failed to run the command of PFM - Manager. |
KAJY24114-E |
|
An error occurred in the command of PFM - Manager. |
KAJY24115-E |
Notes
-
The services of PFM - Manager must be up and running.
-
This function uses the jp1Imdd.execCmd method of JP1/IM2 to run the commands of PFM - Manager. For details on the prerequisites and the limit values, see the topic describing the jp1Imdd.execCmd method in the manuals on JP1/IM2.
-
If the performance data of a PFM - Agent instance is specified in sid and that agent is busy due to collecting records or other reasons, it might not respond for up to about five minutes. If that happens, wait a while and try again.
-
If PFM - Manager runs on Linux, the LANG environment variable of the login shell for the OS user mapped to the JP1 user must have the same value as that of the LANG variable with which JP1/Base works. If these values do not match, data you obtain might be corrupt.
Example of how to specify in the suggestion definition file
Example of displaying a report for identifying the causal process when CPU usage surges in Examples of suggestion definition file (imdd_suggestion_arbitrary-character-string.conf).