Description
This operation component stops the operating system of servers.
Run OS stop request using the shutdown command.
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 occurs if the host name or IP address is omitted.
An argument error will occur if a loopback interface host name or IP address, such as 'localhost', '127.0.0.1' or '::1' is specified.
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
Deferring time (minutes) to begin the OS stop.
Values between 1 and 1,440 (1 day) can be specified.
Because of the specific of the shutdown command, there is a case that cannot defer for 1,440 minutes.
Confirm the specific of the each OS shutdown command for detail.
For example: When begin the OS stop after 10 minutes: 10
If deferring time is omitted, 1 minute is specified.
OS type of the server that will stop the OS.
Specify Windows, Linux or Solaris. This option is not case sensitive.
If the OS type is omitted, the Configuration Management Database (CMDB) will be searched based on the specified host name or IP address, and Systemwalker Runbook Automation automatically sets the acquired OS type as the value.
Multiple operating system types can be specified. For the specification order, use the same order as for the host names or IP addresses specified for "hostname".
The maximum allowable number of operating system types 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.
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 Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user name as the value.
Multiple connected user names can be specified. For the specification order, use the same order as for the host names or IP addresses specified for "hostname".
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 allowable number of connection user 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.
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 Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired connected user password as the value.
Multiple passwords required for connections can be specified. For the specification order, use the same order as for the host names or IP addresses specified for "hostname".
If it connects with File Transfer Infrastructure, the connected user password is invalid.
The maximum allowable number of passwords required for connections 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.
Name of the user executing the shutdown command on the target host where the operation component is to be executed.
If the "execusername" and "execpassword" are not specified, the Configuration Management Database (CMDB) is searched based on the specified host name or IP address and Systemwalker Runbook Automation automatically sets the acquired administrator user as the value.
If not to register to CMDB, it is executed by name of the user connecting.
If the host specified in "hostname" is running on Windows and it connects with the file transfer infrastructure, execute the command as a SYSTEM user. In this case, the connected user name is invalid.
Multiple executing user names can be specified. For the specification order, use the same order as for the host names or IP addresses specified for "hostname".
The maximum allowable number of execution user 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.
This operation component does not use the value of "execpassword". The value of "execpassword" is ignored even if specified.
Specify the execution multiplicity for stopping operating systems.
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.
Specify the component operation mode to be used when multiple host names/IP addresses are specified for the server to be stopped.
The valid values are:
continue : Execute to the end of the specified host.
abort : Suspend processing in the host where the error was discovered.
If omitted or some other value than the options listed above is specified, "continue" is used by default.
This option is not case sensitive.
If "abort" is specified and a multiplicity of 2 or higher is specified, the component will not be interrupted until the server processing that is executing at the time the error is detected completes.
The specification for this option will be ignored if only one host name or IP address is specified for the server where the operating system is to be stopped.
This is the completion timeout (seconds) for the execution of operation components.
Values between 300 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 interrupted in return value 201.
This is the retry count for the execution of operation components.
When the operation components end in return value 161, the retry count is specified. Values between 0 and 5 can be specified.
As a result of retrying, if the operation components ended by the return values other than 161, the execution of the operation components ends even if it doesn't reach the specified retry count. The return values of the operation components become the value executed at the end.
For example: When retries are to be performed twice: 2
If multiple host names or IP addresses have been specified for the server for which the operating system is to be stopped, retries will not be performed.
This is the retry interval (seconds) for operation components.
When the operation components end in return value 161, the retry interval is specified. Values between 1 and 14400 can be specified.
For example: When retrying in 300 seconds: 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 |
|---|---|---|---|
| Success | 0 | Running the OS stop request was successful. |
| Failure | 161 | Failed to run the OS stop request. Retried if a retry count has been specified. 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 Output Data: os_stop_result. | ||
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. | ||
197 | There is an error in the option content, or there is a problem in the registered information in the Configuration Management Database (CMDB). | ||
200 | Stop of OS terminated abnormally. | ||
- | - | 201 | Execution of operation component timed out. |
202 | The operation component was not executed. There is a problem in the setting to execute operation components. | ||
203 | Failed to execute the operation component. There is a problem in the Operation Automation Server environment. | ||
205 | The operation components were 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 components were not executed. There is a possibility that the operation components are not 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 |
|
os_stop_result | This variable is set to the result of executing the stop request on the specified server. |
os_stop_list | This variable is set to a list of servers for which the stop request was successful. This specification is in the CSV format. |
os_stop_fault_list | This variable is set to a list of servers for which the stop request was unsuccessful. This specification is in the CSV format. |
returnCode | This variable is set to the return value. |
The output format for the "os_stop_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 operating system stop request is successful, the string "Success" will be output.
If the operating system stop request 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 a request to stop the operating system for host3 has failed
"hostname",Return_code,"Output","Message"
"host1",0,"","Success"
"host2",0,"","Success"
"host3",161,"","-bash: shutdown: command not found"
In the example above, the following will be output to the "message" variable.
<Example>
"hostname",Return_code,"Output","Message"
"host3",161,"","-bash: shutdown: command not found"
Notes
This operation component uses File Transfer Infrastructure or SSH communication to perform its operations when specify the host name other than the Management Server. It is necessary to be able to connect at least each one. Refer to "3.16 Notes of Each Communication Method" for information on communication methods.
Refer to "3.16.7 Notes When Connected User And Executing User Are Different" for information on different connected and executing users.
If multiple values are specified for the option, it is recommended that values be registered with the Configuration Management Database (CMDB) in advance.
Confirm the return values with the Web console. Refer to "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
When the return value of 201-208 is output, the Automated Operation Process enters an abort or error state, and the error message is output to the following places.
Event log of Management Server (when the Management Server is Windows(R))
System log of Management Server (when the Management Server is Linux)
Custom message of BPMN
Confirm the message in either of the above-mentioned place, and take an appropriate action. Refer to the Systemwalker Runbook Automation Message Guide for details.
