Description
This operation component checks whether a TCP connection can be made on a port for a node (server or network device).
This operation component can be used to check whether communications can be performed using the specified port.
This operation component can be used only when the Management Server is running on Linux.
Options
Basic Options
Target host name or IP address where the operation component will be executed.
To check the port status execute 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.
Port number or service name of the node for which connectivity is to be checked.
If you specify a service name, check its corresponding port number registered at /etc/services on the Management Server.
Multiple port numbers or service names can be specified. You may specify the port number and service name collectively.
An argument error will occur if the port number or service name is omitted.
The maximum allowable number of port numbers or 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 port number or service name for the node for which connectability is to be checked 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
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 even though 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 |
|---|---|---|---|
| Connection possible | 0 | Successfully confirmed the port connection. A connection can be established using the specified port. |
| Connection not possible | 161 | Failed to confirm the port connection. If a retry count has been specified, retries will be performed. |
| Failure | 196 | An option that cannot be specified when the Management Server is running on Linux or Windows has been specified. |
197 | There is an error with the input information. | ||
198 | There is an error with an option specification. | ||
- | - | 201 | The execution of the operation component has timed out. |
202 | The operation component has not been executed due to a problem with the settings for executing the operation component. | ||
203 | The operation component has not been executed normally. 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 |
|
port_service_check_result | This variable is set to the result of executing the connection check request on the specified server. |
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 "port_service_check_result" variable is as follows:
[port],[return value],[output data],[message]
For [output data], nothing will be output.
For [message], one of the following will be output:
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 "22,25" was specified for the "port" option, and connections were only possible for port number 22:
"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:
"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.
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: /etc/services file
For the service name, 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.
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.
