jp1pfmSuggestionGetAgentAllInformation
- Organization of this page
Description
This function gets information of an agent that corresponds to a specified IM management node.
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. 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 "jp1pfmSuggestionGetAgentAllInformation". |
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 agent information (not an empty string) is stored. To get specific information from this string, use the jp1pfmSuggestionGetAgentInformation 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 |
---|---|
Access to PFM - Web Console failed. |
KAJY24100-E |
An internal error occurred in PFM - Web Console. |
KAJY24101-E |
A failure occurred during communication with PFM - Web Console. |
KAJY24102-E |
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 |
Notes
-
The services of PFM - Manager and PFM - Web Console must be up and running.
-
PFM - Manager is under load, it might take long for processing or a timeout can occur. If that happens, wait a while and try again.
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.