jp1pfmSuggestionGetCurrentlyNormalEvents
- Organization of this page
Description
This function gets a list of events whose status has currently been recovered to normal from JP1 events that have Warning or Error as SEVERITY.
The following table describes JP1 events to be obtained and criteria where the events are included in the response.
|
JP1 events to be obtained |
Criteria where events are included in the response |
|---|---|
|
All JP1 user events of Performance Management |
The status of the alarm that corresponds to the alarm table and alarm names configured in the extended attribute is currently normal. |
|
JP1 system events with event ID 00004840 |
The status of the agent with sid specified for the suggestion activation criteria is currently normal. |
|
Events that are JP1 system events with event ID 00004850, but not issued by the Store service |
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 "jp1pfmSuggestionCurrentlyNormalEvents". |
|
|
3 |
args |
object |
No |
Specify an object with the members in No. 4 and later. |
|
|
4 |
events |
string |
No |
Specify the value stored in suggestion of the response of the jp1pfmSuggestionGetPerformanceEvents function. |
|
|
5 |
allAlarmStatuses |
string |
No |
Specify the value stored in suggestion of the response of the jp1pfmSuggestionGetAllAlarmStatuses function. |
|
What value is contained in the suggestion member in the response
If the processing is successful, an array of SIDs of events whose status in the JP1 events specified for events has been recovered to normal is stored in JSON format. If there is no applicable JP1 event at all, an empty string is stored.
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. |
Notes
-
A JP1 event that meets one of the following criteria is not stored in the response:
-
The alarm table configured in an extended attribute is unbound, or the alarm is deleted.
-
The alarm configured as an extended attribute is currently disabled (in an inactive state).
-
The alarm configured in an extended attribute is the one for which the State changes for each record instance is selected, and one or more instances are not recovered to normal.
-
Monitoring of the agent specified by sid is suspended.
-
PFM - Manager cannot communicate with the agent specified by sid.
-
-
If the current time is not within the alarm evaluating hours or if the alarm is temporarily recovered to normal when a user changes the alarm definition, that JP1 event is included in the response.
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 changing the response status of an event to Processed when the status of the alarm or agent is recovered to normal in Examples of suggestion definition file (imdd_suggestion_arbitrary-character-string.conf).