Description
This operation component retrieves the power status of servers.
Options
Mandatory Options
Host name or IP Address of a server where the power status will be obtained.
An argument error occurs if the host name or IP address is omitted.
The maximum length of the host name or IP address is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Advanced Options
IP address set in the IPMI of a server where the power status is obtained.
If the IP address is omitted, the Configuration Management Database (CMDB) will be searched based on the specified hostname or IP address, the Systemwalker Runbook Automation automatically sets the obtained IP address as the value.
The maximum length of the IP address is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Name of the user set in the IPMI of a server where the power status is obtained.
If the user name or password is not specified, the Configuration Management Database (CMDB) is searched based on the specified hostname or IP address and Systemwalker Runbook Automation automatically sets the obtained user name as the value.
The maximum length of the user name is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
Password of the user set in the IPMI of a server where the power status is obtained.
If the user name or password is not specified, the Configuration Management Database (CMDB) is searched based on the specified hostname or IP address and Systemwalker Runbook Automation automatically sets the obtained password as the value.
The maximum length of the user name is 1,024 bytes. An argument error occurs if the length is larger than 1,024 bytes.
This is the completion timeout (seconds) for the execution of the Operation Component.
Values between 300 and 86400 (1day) can be specified.
For example: when waiting for 10 minutes until completion:600
If the execution of Operation Components is not completed after passing the specified time, the Operation Component stops its processing with the return value:201.
This is the retry count for the execution of the Operation Component.
Specify retry count when operation components ended with the return value:161. Values between 0 and 5 can be specified.
If the Operation Component ended with return value except 161 as a result of a retry, the execution of the Operation Component stops at retry count less than the specified value. The return value of Operation Components is the value of the last execution.
For example: when retries are performed twice: 2
This is the retry interval (seconds) of Operation Components.
Specify interval until retry is to be performed when Operation Components ended with the return value:161. Values between 1 and 14400 can be specified.
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 |
|---|---|---|---|
| Power OFF | 0 | Obtaining power status was successful. The power is OFF. |
| Power ON | 1 | Obtaining power status was successful. The power is ON |
| Failure | 161 | Obtaining power status failed. If retry count is specified, retries are to be performed. |
189 | Failed to connect to a server. | ||
197 | There is an error in the option content. | ||
- | - | 201 | Execution of Operation Components timed out. |
202 | The Operation Component was not executed. There is a problem in the setting for executing Operation Components. | ||
203 | The Operation Component was not 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. There is a problem with the output information specification of the operation component. | ||
207 | The Operation Component was not executed. The Operation Component may not be 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 | This variable will be set to one of the following strings if the power status of the server is acquired successfully.
If an attempt to acquire the power status of the server fails, the content of the error will be set as a string. |
returnCode | This variable is set to the return value. |
Notes
When obtaining the power status of a server using this Operation Component, the hardware for the Business Server must comply with the following specifications:
IPMI V2.0
In the environment where IPMI is not configured, configure IPMI.
If imiipaddress, ipmiusername or ipmipassword is omitted, this Operation Component automatically sets the values stored in the CMDB. So when using the values stored in the CMDB, necessary information should be stored to the CMDB using swrba_ipmiimport command in advance. If storing any information to the CMDB, do not omit the password. For the detail of the swrbd_impiimport command, see " swrba_ipmiimport (IPMI Information Import Command) ".
Example of the input file(CSV format) specified for swrba_impiimport command
"Server IP address where processing is performed", "IP address of IPMI", "user name of IPMI", " password of IPMI"
When using this Operation Component, the communication port which requires communication permission on the Business Server is UDP port 623.
To check the return value, use Web console. Refer to the "Confirming the Operation Component Execution Status/Execution Results" in the Systemwalker Runbook Automation Operation Guide for details.
If the return value is between 201 and 208, the Automated Operation Process enters an abort or error state, and error messages are output to the places below.
The event log of Management Server(in case Windows(R) Management Server)
The syslog of Management Server(in case Linux Management Server)
BPMN custom messages
Check error messages in one of the places above and take the appropriate measures. Refer to the Systemwalker Runbook Automation Message Guide for details.
