Description
This operation component uses IPMI to check for hardware errors based on the sensor information for the specified hardware.
Options
Basic Options
IP address defined for the server IPMI.
An argument error will occur if this is omitted.
The maximum length of the IP address is 1,024 characters. An argument error will occur if this limit is exceeded.
Name of the user defined for the server IPMI.
An argument error will occur if this is omitted.
The maximum length of the user name is 1,024 characters. An argument error will occur if this limit is exceeded.
Password of the user defined for the server IPMI.
An argument error will occur if this is omitted.
The maximum length of the password is 1,024 characters. An argument error will occur if this limit is exceeded.
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 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 |
|---|---|---|---|
| Normal | 0 | Successfully checked for hardware errors. No errors have been found. |
2 | Successfully checked for hardware errors. No errors were detected, but information could not be acquired from some sensors. | ||
| Abnormality discovered | 1 | Successfully checked for hardware errors. Either an error was detected or information could not be acquired from any sensors. |
| Failure | 161 | Failed to check for hardware errors. If a retry count has been specified, retries will be performed. |
197 | There is an error with the content of an option. | ||
- | - | 201 | The execution of the operation component has timed out. |
202 | The operation component has not been executed. There is 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 | This variable will be set to the following message if hardware problems are checked successfully. The operation component was successful. If an attempt to check hardware problems fails, the content of the error will be set as a string. |
sensor_status_result | This variable is set to a list of the sensor information that has been obtained. |
returnCode | This variable is set to the return value. |
A list of the sensor information acquired is output to the sensor_status_result using the following format.
<sensor name>|<current state>|<threshold evaluation result>
[Output example]
CPU Fan 1 | 5709.72 RPM | ok CPU Fan 2 | 5709.72 RPM | ok System 5V | 4.91 Volts | ok System 3.3V | 3.29 Volts | ok CPU0 Dmn 0 Temp | 48 degrees C | ok
If the current state is "no reading", this indicates that information could not be acquired.
The "threshold evaluation results" categories area as follows:
ok: Normal state
ns: The sensors have either been disabled or do not exist. Normal state.
cr: Abnormal state ("critical")
nr: Abnormal state ("non-recoverable")
nc: Abnormal state ("non-critical")
Notes
To check for hardware errors using this operation component, the hardware for the Business Server must comply with the following specifications:
IPMI V2.0
For environments where IPMI has not been set up, set up IPMI.
The communications port for which communications must be allowed on the server to be checked using this operation component is UDP 623.
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.
