Description
This operation component confirms the operating status of a node (server or network device).
Options
Basic Options
Target host name or IP address where the operation component will be executed.
Multiple host names or IP addresses can be specified. An argument error will occur if the host name or IP address is omitted.
The maximum allowable number of host names or IP addresses is 100. An argument error will occur if this limit is exceeded.
The specification is in CSV format. Refer to "3.17 Notes on Specifying Multiple Input Parameters" for examples of multiple specifications.
Advanced Options
Specify the execution multiplicity for starting servers.
Values between 1 and 100 can be specified.
If a value greater than the number of host names or IP addresses specified for the "hostname" option is used, the operation component runs as though the "hostname" value has been specified for "multiplicity".
If this option is omitted, the operation component will run as though "10" has been specified.
This is the completion timeout (seconds) for the execution of operation components.
Values between 0 and 86400 (1 day) can be specified.
For example: When timeout is to occur every 10 minutes: 600
When the execution of the operation components is not completed even if the specified time passes, the processing of the operation components is stopped in return value 201.
If completion timeout is omitted, and the value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
This is the retry count for the execution of operation components.
Specify the count that will be retried when the operation component is finished in return value 161. Values between 0 and 5 can be specified.
When the operation components is terminated in return values other than 161 as a result of the retrying, the operation components will be terminated even if it doesn't reach the specified retry counts. The return value of the operation components returns the value executed at the end.
For example: When retries are to be performed twice: 2
If retry count is omitted, and the value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
If multiple host names or IP addresses have been specified for the node for which the status is to be verified, retries will not be performed.
This is the retry interval (seconds) for operation components.
Specify the interval that will be retried when the operation component is terminated in return value 161. Values between 1 and 14400 can be specified.
For example: When retries are to be performed at 300 seconds interval: 300
If the specification of the timeout, retry and retry_interval is omitted, and a value beyond the limits of the above-mentioned is input, the value specified with the operation components definition file becomes effective. Refer to "2.5 Definition File for Operation Components" for details.
Return Values
Icon | Name | Return value | Description |
|---|---|---|---|
| Operation normal | 0 | The node is running. |
| Operation abnormal | 161 | The node is not running. When the retry count is specified, it will be retried. If multiple host names have been specified, retries will not be performed. |
180 | Multiple operations failed. For the return values for the operations on each host, check the "Return_code" column in the standard output. | ||
| Failure | 197 | There is an error in the input information. |
198 | There is an error in the specification of the option. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute the operation components. | ||
203 | The operation components were not able to be executed normally. There is a problem in the Management Server environment. | ||
205 | The operation component was not executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component was not executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation component was not executed. There is a possibility that the operation components have not been registered in the Management Server. | ||
208 | The Automated Operation Process has been canceled because the Automated Operation Process was recovered while the operation component was executing. |
Output information
Variable | Description |
|---|---|
message |
|
node_state_check_result | This variable is set to the result of executing the state check request on the specified server. |
node_state_run_list | This variable is set to a list of nodes where the node status is "Run". The specification is in the CSV format. |
node_state_stop_list | This variable is set to a list of nodes where the node status is "Stop". The specification is in the CSV format. |
returnCode | This variable is set to the return value. |
The output format for the "node_state_check_result" variable is as follows:
[hostname],[return value],[output data],[message]
For [output data], nothing will be output.
For [message], one of the following will be output:
If the node is running, the string "Run" will be output.
If the node is not running, the string "Stop" will be output.
If an attempt to check the operational status of the node fails, the content of the error will be output as a string.
<Example>
If "host1,host2,host3" has been specified for the hostname option, and the "host3" node is not operating
"hostname",Return_code,"Output","Message"
"host1",0,"","Run"
"host2",0,"","Run"
"host3",161,"","Stop"
In the example above, the following will be output to the "message" variable.
<Example>
"hostname",Return_code,"Output","Message"
"host3",161,"","Stop"
Notes
This operation component confirms the operating status of the node by ping. Therefore, the node that controls the ping response by setting of firewall and OS cannot confirm operating status. Set that it can be responded to the ping.
To check the return value, use Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When return values between 201 and 208 are output, the automated operation enters an abort or error state, and the error message is output to the following places.
Event log of the Management Server (When the Management Server is Windows(R))
System log of the Management Server (When the Management Server is Linux)
Custom message of BPMN
Confirm the message in any of the above-mentioned place, and execute appropriate measures. Refer to the Systemwalker Runbook Automation Message Guide for details.
