Description
This operation component checks whether a server is operating normally.
Specifically, this operation component checks whether:
- The specified service is running
- A TCP connection can be made to the specified port
If the Management Server is running on Windows(R), this operation will be happened as below when you set the port basic option.
With setting a value in "service" basic option
The content specified for the "port" basic option will be ignored.
Without setting a value in "service" basic option
The execution of this operation component will be error.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
To execute the operation component on the Management Server, specify the following:
For IPv4: 'localhost' or '127.0.0.1'
For IPv6: 'localhost' or '::1'
However, if the Management Server is on SELinux features and the operation component is executed on its Management Server, specify host name or IP address of the Management Server.
An argument error will occur if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the service whose start status is to be confirmed. Specify the service name of windows.
This will be ignored if the host for which the start status is confirmed is running Linux or Solaris.
If the service name is omitted, the command will search the Configuration Management Database (CMDB) based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set the value for the service name that has been acquired from the CMDB.
Multiple service names can be specified.
The maximum allowable service names 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.
Specify the name of the service for which the operable status is to be checked, as follows:
Example: Dhcp
Example: Dhcp,EventLog
Port number or service name for which the possibility of use for connection is checked.
If you specify a service name, check its corresponding port number registered at /etc/services on the Management Server.
If the port number or service name is omitted, the command will search the Configuration Management Database (CMDB) based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set the value for the port number or service name that has been acquired from the CMDB.
Multiple port numbers or service names can be specified. You may specify the port number and service name collectively.
The maximum allowable number of port numbers 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.
For the port number or service name for which the connection is to be checked, specify as follows:
Example: To check whether a connection can be made via SSH: "ssh"
Example: To check whether connections can be made via ports 22 and 25: "22,25"
Advanced Options
Operating system of the host executing the operation component.
Specify Windows, Linux or Solaris. This option is not case sensitive.
If the OS type is omitted, the command will search the Configuration Management Database (CMDB) based on the specified host name or IP address, and then Systemwalker Runbook Automation will automatically set the value for the OS type that has been acquired from the CMDB.
The maximum length of the OS type is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the user connecting with SSH to the host executing the operation component.
If the connected user name and password required for connection are not specified, the command searches the Configuration Management Database (CMDB) based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the value for the connected user name that has been acquired from the CMDB.
If the operation component connects with the file transfer infrastructure, the connected user name will be fixed at either of the following names and cannot be changed. In this case, the user name is ignored even if specified.
If the Business Server is running on Windows: SYSTEM user
If the Business Server is running on Linux or Solaris: root
The maximum length of the connected user name is 1,024 characters. An argument error will occur if this limit is exceeded.
Password of the user connecting with SSH to the host executing the operation component.
If the connected user name and password required for connection are not specified, the command searches the Configuration Management Database (CMDB) based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the value for the connected user password that has been acquired from the CMDB.
If the connection is made using the file transfer infrastructure, the password will not take effect even if it is specified.
The maximum length of the connected user password is 1,024 characters. An argument error will occur if this limit is exceeded.
This is the completion timeout (in seconds) for executing the operation component.
Values between 300 and 86400 (1 day) can be specified.
Example: If the completion timeout is 10 minutes: 600
If the operation component has not finished executing when the specified time has passed, the processing for the operation component will be interrupted with return value 201.
This is the retry count for executing the operation component.
Specify the number of retry attempts to be used when the operation component terminates with return value 161. Values between 0 and 5 can be specified.
If the operation component terminates with a return value other than "161" as a result of being re-executed from a retry, the execution of the operation component will terminate even if the specified number of retries has not been reached. The return value for the operation component will be the value from the last time the operation component was executed.
Example: To retry twice: 2
This is the retry interval (in seconds) for the operation component.
Specify the time to wait before a retry is attempted if the operation component terminates with return value 161. Values between 1 and 14400 can be specified.
Example: To retry at 300 second intervals: 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 service is operating normally. |
| Operation abnormal | 161 | The service has stopped or the port connection confirmation has failed. If a retry count has been specified, retries will be performed. |
| Failure | 179 | The service has not been found. |
187 | Authentication failed when an attempt was made to connect to the Business Server over the network (using SSH). Alternatively, an error occurred during the processing of communications with the Business Server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
188 | When the operation component was performing an operation on a Business Server where an RBA Agent has not been installed, an SSH network connection to the Business Server has been disrupted. | ||
189 | An attempt to connect to the Business Server over the network (using SSH) failed. Alternatively, an error occurred during the processing of communications with the Business Server (file transfer infrastructure). In this case, the error code for the file transfer infrastructure is output to the execution results. Refer to "3.21 Detailed Code of File Transfer Infrastructure" for information on error codes. | ||
196 | An option that cannot be specified when the Management Server is running on Windows has been specified. | ||
197 | There is an error with the content of an option. | ||
200 | Failed to confirm that the service is running. | ||
- | - | 201 | The execution of the operation component has timed out. |
202 | The operation component has not been executed. | ||
203 | Failed to execute the operation component. There is a problem with the environment for the Management Server. | ||
205 | The operation component has not been executed. There is a problem with the input information specification of the operation component. | ||
206 | The operation component has not been executed normally. There is a problem with the output information specification of the operation component. | ||
207 | The operation component has not been executed. The operation component may not have been registered on 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 | This variable will be set to the following message if an attempt to check that all services are running and that port connections can be made is successful. The operation component was successful. If some or all of the checks fail, information for the services and ports that failed to be checked will be output using the same format as the "server_check_result" variable. If an attempt to check whether the server is running normally fails, the content of the error will be set as a string. |
server_check_result | This variable is set to the result of executing the check on the specified service and port. |
service_stop_list | This variable is set to a list of services where the service status is "Stop". The specification is in the CSV format. |
port_disconnect_list | This variable is set to a list of port numbers for which connections cannot be established. The specification is in the CSV format. |
returnCode | This variable is set to the return value. |
The output format for the "server_check_result" variable is as follows:
[service],[return value],[output data],[message]
[port],[return value],[output data],[message]
For [output data], nothing will be output.
For [message], one of the following will be output:
For [service]
If the service is determined to be running, the string "Run" will be output.
If the service is determined to be not running, the string "Stop" will be output.
If an attempt to check whether the service is running fails, the content of the error will be output as a string.
For [port]
If the operation component checks the port connection successfully, and it is possible to connect to the port, the string "Success" will be output.
If the operation component fails to check the port connection, the content of the error will be output as a string.
<Example>
If "service1, service2, service3" has been specified for the "service" option, and "22, 25" has been specified for the "port" option
"service",Return_code,"Output","Message"
"service1",0,"","Run"
"service2",0,"","Run"
"service3",161,"","Stop"
"port","Return_code","Output","Message"
"22",0,"","Success"
"25",161,"","Connection refused."
In the example above, the following will be output to the "message" variable.
<Example>
"service",Return_code,"Output","Message"
"service3",161,"","Stop"
"port","Return_code","Output","Message"
"25",161,"","Connection refused."
Notes
Use SYN scan to check the ports used by this operation part.
When checking the ports used by this operation component, the port scan may be detected as a threat by security countermeasures. Therefore, please use it within the following range.
Please execute this operation parts only for the business server that are target of operation/monitoring with Systemwalker Runbook Automation, when you do scan for used ports.
When two or more portnumbers or service names are specified, the SYN scanning will be performed in a short time from the management server. Therefore, please set security countermeasures of the business server so as not to detect an abnormality even if there is multiple SYN scanning from the management server.
If information other than the Management Server is entered for the "hostname" option, this operation component will execute actions using either the file transfer infrastructure or SSH communications. Specify settings so that communications can be performed using at least one of these methods. Refer to "3.16 Notes of Each Communication Method" for information on communication methods.
In this operation component, if service option and port option are omitted, Systemwalker Runbook Automation set the value which registered to CMDB automatically. Therefore, if using value which registered to CMDB, it is required to register necessary information to CMDB in advance. Refer to "3.20 Information Registration to CMDB (Confirm Information of Normal Running Status of Server)" for information on how to register.
If there are no options in both "service" and "port" option, it will be error. When collecting information from CMDB, but there are no information in them, it will be also error.
To specify the name of a service for the "port" option, the service must be registered with the operating system for the Management Server. For specifiable service names, check the settings of the operating system below:
For Linux/Solaris: /etc/services file
For the service name specified for the "port" option, use only alphanumeric characters, hyphens ("-") and underscores ("_").
The only protocol for which port connections can be confirmed using this operation component is TCP.
Use the Web console to check the return value. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
If a return value between 201 and 208 has been output, the Automated Operation Process enters an abort or error state, and error messages will be output to the following locations:
Event logs for the Management Server (if the Management Server is running on Windows(R))
syslogs for the Management Server (if the Management Server is running on Linux)
Custom messages for BPMN
Check the messages in one of these locations, and take the appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
