Description
This operation component stops servers.
This component uses IPMI to make requests to stop servers.
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
IP address set in the IPMI of the server to be stopped.
If IPMI IP address 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 IPMI IP address as a value.
Multiple IP addresses 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 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.
User name set in the IPMI of the server to be stopped.
If the user name or password is 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 IPMI user name as the value.
Multiple connection user names can be specified. For the specification order, use the same order as the IP addresses set for the IPMI of the server to be stopped that are specified for "ipmiipaddress".
The maximum allowable number of 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.
User password set in the IPMI of the server to be stopped.
If either the user name or the password is not entered, 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 IPMI user password as a value.
Multiple connection passwords can be specified. For the specification order, use the same order as the IP addresses set for the IPMI of the server to be stopped that are specified for "ipmiipaddress".
The maximum allowable number of passwords 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 execution multiplicity for stopping 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 "1" has been specified.
If multiple different IP addresses are specified for "ipmiipaddress", specify the degree of execution multiplicity.
Specify the component operation mode to be used when multiple host names/IP addresses are specified for the server to be stopped. This option is not case sensitive.
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.
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.
This will be ignored if only one host name or IP address is specified for the server 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 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 | A request to stop the server has been successful. |
| Failure | 161 | A request to stop the server failed. 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: server_stop_result | ||
189 | Connection to the server failed. | ||
197 | There is an error in the option content. | ||
- | - | 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 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 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 |
|
server_stop_result | This variable is set to the result of executing the stop request on the specified server. |
server_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. |
server_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 "server_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 server stop request is successful, the string "Success" will be output.
If the server 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 server "host3" has failed
"hostname",Return_code,"Output","Message"
"host1",0,"","Success"
"host2",0,"","Success"
"host3",161,"","Lanplus RAKP2 HMAC does not match with BMC"
In the example above, the following will be output to the "message" variable.
<Example>
"hostname",Return_code,"Output","Message"
"host3",161,"","Lanplus RAKP2 HMAC does not match with BMC"
Notes
If using this operation component to stop the server, Business Server hardware must correspond to the following specifications:
IPMI V2.0
If the setting of IPMI of the Managed Server is not completed, set up IPMI.
If ipmiipaddress, ipmiusername or ipmipassword are omitted, in this operation component, Systemwalker Runbook Automation automatically sets acquired values that are registered in the Configuration Management Database (CMDB). Therefore, if use information that is registered in the Configuration Management Database (CMDB), required information need to register to the Configuration Management Database (CMDB) by using swrba_ipmiimport command before use this operation component. If register the information to the Configuration Management Database (CMDB), don't omit the password. Refer to 1.4.12 swrba_ipmiimport (IPMI Information Import Command) for details.
Example of the input file (CSV format) that is specified swrba_ipmiimport
"IP address that is operated server","IP address set in the IPMI","User name set in the IPMI","User password set in the IPMI"
When use this operation component, the communication port which requires communication permission on the Business Server is UDP port 623.
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.
