jp1pfmSuggestionGetHostName
- Organization of this page
Description
This function gets the name of a monitoring host recognized by Performance Management on the host to which a specified IM management node belongs.
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. 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 "jp1pfmSuggestionGetHostName". |
|
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 host name of the host to which the specified IM management node belongs 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 configuration information of JP1/IM2 was changed during the processing. |
KAJY24105-E |
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 suspending monitoring while a host is being maintained in Examples of suggestion definition file (imdd_suggestion_arbitrary-character-string.conf).