jp1pfmSuggestionGetAlarmStatus
- Organization of this page
Description
This function gets the status of an alarm bound to an agent that corresponds to a specified IM management node.
Before running this function, you must execute the jp1pfmSuggestionGetAllAlarmStatuses function.
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. Specify the same value as sid of the jp1pfmSuggestionGetAllAlarmStatuses function. |
|
|
2 |
method |
string |
No |
Specify "jp1pfmSuggestionGetAlarmStatus". |
|
|
3 |
args |
object |
No |
Specify an object with the members in No. 4 and later. |
|
|
4 |
allAlarmStatuses |
string |
No |
Specify the value stored in suggestion of the response of the jp1pfmSuggestionGetAllAlarmStatuses function. |
|
|
5 |
alarmTableName |
string |
No |
Specify the name of the alarm table from which the alarm status is obtained. |
|
|
6 |
alarmName |
string |
No |
Specify the name of the alarm from which the alarm status is obtained. |
|
What value is contained in the suggestion member in the response
If the processing is successful, one of the values listed in the following table is stored in suggestion:
|
Value stored in suggestion |
Description |
|---|---|
|
"OK" |
The alarm is in the normal status. |
|
"Warning" |
The alarm is in the warning status. |
|
"Exception" |
The alarm is in the error status. |
|
"Inactive" |
The active setting of the alarm is disabled. |
|
"Suspended" |
Monitoring is suspended. |
|
"Unreachable" |
Agent Collector or Remote Monitor Collector cannot be reached. |
|
"NotBound" |
The alarm table specified for alarmTableName is not bound, or the alarm specified for alarmName does not exist. |
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 allAlarmStatuses in the suggestion definition file. |
Note
None.
Example of how to specify in the suggestion definition file
For an example of the suggestion definition file that contains this function, see 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).