9.5.2 Checking the execution agents that are affected when an agent host stops
This section describes the template for checking execution agents that are affected when an agent host stops.
If you execute the response action of this suggestion template, the window is automatically changed to a JP1/IM2 window that displays a list of execution agents affected when the agent host on which JP1/AJS3 - Agent is installed stops.
- Organization of this subsection
(1) Prerequisite conditions
Before using the template for checking execution agents that are affected when an agent host stops, make sure that the following prerequisite conditions are met:
-
The versions of JP1/AJS3 - Manager and JP1/AJS3 - Web Console are 12-50 or later.
-
The host on which JP1/AJS3 - Agent is installed is monitored by using the health check function of JP1/PFM.
-
The versions of JP1/IM2 and JP1/PFM - Manager are 12-50 or later.
-
JP1/IM2 is able to obtain system configuration information from JP1/AJS3 and JP1/PFM.
For details about the settings that are necessary for linkage between JP1/IM2 and JP1/AJS3, see 9.3 Setup for linking JP1/IM2.
For details about the settings that allow linkage between JP1/IM2 and JP1/PFM, see the JP1/Performance Management User's Guide. For details about the health check function of JP1/PFM, see the JP1/Performance Management Planning and Configuration Guide.
(2) Suggestion template
The following shows the file name of the suggestion template. The following also provides an overview and specification example of the suggestion template.
- File name
-
- For the Japanese version of JP1/IM2:
-
imdd_suggestion_ajs_check_failed_agent_list_ja.conf
- For the English version of JP1/IM2:
-
imdd_suggestion_ajs_check_failed_agent_list_en.conf
For details about the location where suggestion templates are stored, see the JP1/Integrated Management 3 - Manager Administration Guide.
- Overview
-
The following table provides an overview of this suggestion template.
No.
Item
Overview
1
Node on which suggestion information is shown
Node showing the JP1/PFM monitoring agents of the Management Applications category
2
JP1 user permission under which the suggestion information is shown
JP1_JPQ_User or higher and JP1_PFM_Operator or higher
3
Suggestion activation criteria
-
The host that stopped is used as an execution agent of jobs
-
JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed
-
Information acquisition of the host on which JP1/PFM has stopped is successful
-
At the time of condition judgment, the target host has not recovered from the Host Not Available status
4
Response action
Go to JP1/AJS3 - Web Console, and display the execution agent that uses the stopped host as an execution-target host in the Execution Agent tab
-
The suggestion activation criteria "JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed" of this suggestion template evaluates whether JP1 events issued by JP1/PFM are registered in JP1/IM2 as Severe events that satisfy the following conditions.
No. |
JP1 event attributes |
Value |
---|---|---|
1 |
Event ID |
4860 |
2 |
Message |
The character string (hcsstatus=Host Not Available) is included. |
3 |
Event level |
Error |
4 |
Response status |
Unprocessed |
- Cautionary notes
-
-
If JP1/IM2 is used to change the Event levels or Severe event definitions of JP1 events
If the following JP1/IM2 functions are used, the response action is not suggested by this suggestion template when the agent host is stopped.
- Function for changing severity levels
- Function for defining severe events
- Function for releasing severe events
- Function for deleting severe events
Customize the suggestion activation criteria "JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed" to match the Event levels or Severe event definitions of the monitored JP1 events.
-
If the Event levels of JP1 events issued by JP1/PFM are changed
If the Event level of the JP1 events issued when the health check status is "Host Not Available" is changed from the default (Error), the response action is not suggested by this suggestion template when the agent host is stopped. Customize the suggestion activation criteria "JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed" to match the Event levels of the monitored JP1 events.
-
- An example of coding
{ "meta":{ "version":"1" }, "suggestions":[ { "suggestionId":"jp1_ajs_check_failed_agent_list", "label":"Check the execution agent affected by the stopped host", "node":"_CATEGORY_m.*_OBJECT_JP1PFM-A([^1478]|[1478].*%5B([^%]*%5D|(.|..|[^A]..|.[^l].|..[^l]|.{4,})%40))", "permissions":[ ["JP1_PFM_Admin","JP1_JPQ_User"], ["JP1_PFM_Admin","JP1_JPQ_Operator"], ["JP1_PFM_Admin","JP1_JPQ_Admin"], ["JP1_PFM_Operator","JP1_JPQ_User"], ["JP1_PFM_Operator","JP1_JPQ_Operator"], ["JP1_PFM_Operator","JP1_JPQ_Admin"] ], "cases":[ [ { "type":"struct", "key":{ "idType":"target", "sid":"${../../_OBJECT_JP1AJSAGT/<managerAgent:target:sid:}" }, "ope":"EXIST", "val":true, "description":"The host that stopped is used as an execution agent of jobs" }, { "type":"event", "key":{ "statusFilter":[30], "sid":"${.:tree:sid:}", "B.ID":["00004860"], "REGEX_B.MESSAGE":"KAVL15022-E.*hcsstatus=Host Not Available", "E.@JP1IM_DEALT":[0] }, "ope":"EXIST", "val":true, "description":"JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed" }, { "type":"plugin", "key":{ "sid":"${.:tree:sid:}", "method":"jp1pfmSuggestionGetAgentAllInformation", "args":{} }, "ope":"NOTIN", "val":"", "description":"Information acquisition of the host on which JP1/PFM has stopped is successful" }, { "type":"plugin", "key":{ "sid":"${.:tree:sid:}", "method":"jp1pfmSuggestionGetAgentInformation", "args":{ "allInformation":"${:plugin[1]::}", "member":"healthDetail" } }, "ope":"IN", "val":"Host Not Available", "description":"At the time of condition judgment, the target host has not recovered from the Host Not Available status" } ] ], "action":{ "type":"jump", "params":{ "url":"http://(server-name):(port-number)/ajs/login.html?jt=${:user:jp1Token:URLENC}&manager=${../../_OBJECT_JP1AJSAGT/<managerAgent/../..:tree:value.label:URLENC}&type=agent&agentHost=${../../../:tree:value.label:URLENC}&eou=1", "target":"_blank" }, "description":"Go to JP1/AJS3 - Web Console, and display the execution agent that uses the stopped host as an execution-target host in the execution agent tab" } } ] }
For details about each item in the suggestion template, see the description of the suggestion definition file in the manual JP1/Integrated Management 3 - Manager Command, Definition File and API Reference.
(3) Procedure for applying the template
The following shows the procedure for applying the suggestion template to JP1/IM2:
-
Copy the suggestion template to any folder of your choice on the JP1/IM2 manager host.
-
Use a text editor to open the suggestion template that you have copied, and then edit the settings in the template.
In the url key, change the server name and port number of the JP1/AJS3 - Web Console host according to the environment:
"url":"http://host-name-or-IP-address-of-Web-Console-server:port-number/ajs/login.html",
-
On the JP1/IM2 manager host, run the jddupdatesuggestion command in which the path of the folder to which the suggestion template was copied is specified as an argument.
(4) Procedure for customizing the template
In this suggestion template, you can change JP1/PFM to another product that monitors stoppage of an agent host. In this case, however, the mechanism of agent host stoppage detection follows the specifications of the new monitoring product. If you change JP1/PFM to another monitoring product, change the settings of the following items in the suggestion template according to the new monitoring product:
-
Node on which suggestion information is shown
-
JP1 user permission under which the suggestion information is shown
-
The following three suggestion activation criteria:
-
JP1/PFM issues a JP1 event indicating the Host Not Available status of the target host, and the status of that JP1 event in JP1/IM2 is Unprocessed
-
Information acquisition of the host on which JP1/PFM has stopped is successful
-
At the time of condition judgment, the target host has not recovered from the Host Not Available status
-
In addition, change the following variables so that the path is a relative path starting from the IM management node on which the suggestion is shown.
No. |
Item |
Description |
Variable |
---|---|---|---|
1 |
Node of the Destination JP1/AJS3 - Manager |
Indicates the JP1/AJS3 - Manager node that is connected with a relation to managerAgent and the JP1/AJS3 - Agent node of the host that stopped. Specify a relative path starting from the IM management node on which the suggestion is shown. |
${../../_OBJECT_JP1AJSAGT/<managerAgent:target:sid:} |
2 |
Host name of the Destination JP1/AJS3 - Manager |
Indicates the label name of JP1/AJS3 - Manager that is connected with a relation to managerAgent and the JP1/AJS - Agent node of the host that stopped. Specify a relative path starting from the IM management node on which the suggestion is shown. |
${../../_OBJECT_JP1AJSAGT/<managerAgent/../..:tree:value.label:URLENC} |
3 |
Host name of the host that stopped |
Indicates the label name of the node of the host that stopped.Specify a relative path starting from the IM management node on which the suggestion is shown. |
${../../../:tree:value.label:URLENC} |
The following shows the procedure for customizing the suggestion template:
-
Copy the suggestion template to any folder of your choice on the JP1/IM2 manager host.
-
Rename the suggestion template you have copied.
Rename the copied suggestion template to imdd_suggestion_X.conf (X: a name of your choice).
-
Use a text editor to open the suggestion template that you have copied.
-
Edit the server name and port number of the JP1/AJS3 - Web Console host.
In the url key, change the server name and port number of the JP1/AJS3 - Web Console host according to the environment.
"url":"http://host-name-or-IP-address-of-Web-Console-server:port-number/ajs/login.html",
-
Edit the settings that you want to customize.
-
On the JP1/IM2 manager host, run the jddupdatesuggestion command in which the path of the folder to which the suggestion template was copied is specified as an argument.
- Cautionary note
-
Save the suggestion template in UTF-8 encoding without BOM.