BX-63-0002-01

BX-63-0002-01

First Edition, December 2013, BX-63-0002 (out of print)
Second Edition, April 2015, BX-63-0002-01
All Rights Reserved, Copyright © 2013, 2015, Hitachi Industry & Control Solutions, Ltd.
The contents of this publication may be revised without prior notice.
No part of this publication may be reproduced in any form or by any means without permission inwriting from the publisher.
Printed in Japan.

TP<IC> (FL-MW2007)

SAFETY INSTRUCTIONS

Carefully read and fully understand the safety precautions below before operating
the equipment.
z Operate the equipment by following the instructions and procedures describedin this manual.
z Pay attention especially to safety precautions displayed on the equipment or inthis manual. Make sure you follow them. Otherwise, personal injury andproperty damage including damage to the equipment may result.
z A safety precaution is indicated by a heading as shown below. A heading iseither a safety alert symbol; a word such as “DANGER”, “WARNING”,“CAUTION”, or “NOTICE”; or a combination of both.
This is a safety alert symbol. This symbol is used to signify
potential hazards that may result in personal injury or death.
Make sure you follow the safety message that follows thissymbol in order to avoid possible injury or death.
DANGER: This symbol is used to indicate imminent hazards thatwill highly likely result in serious personal injury or
death.
WARNING: This symbol is used to indicate potential hazards that
may result in serious personal injury or death.
CAUTION: This symbol is used to indicate potential hazards that
may result in minor or moderate personal injury.
NOTICE: This symbol is used to indicate hazards that may result inequipment or property damage but not personal injury.
The heading “NOTE” is used to indicate a cautionary note about handling andoperation of the equipment.
z Do not attempt to perform any operation that is not described in this manual. If
there is any problem with the equipment, call your maintenance personnel.
z Read this manual carefully and fully understand the directions and precautions
written in this manual before operating the equipment.
z Keep this manual nearby so that you can reference the manual anytime youneed it.
z Every effort has been made to specify the best precautions on the equipment
and in the manual. Nevertheless, unexpected incidents may occur. When you
use the equipment, you are asked not only to follow the instructions but also to
use your own judgement on safety.
S-1

SAFETY INSTRUCTIONS (Continued)

1. COMMON SAFETY PRECAUTIONS
Carefully read and fully understand the following safety precautions.
1.1

WARNINGz This equipment is not designed and manufactured to be used for a life-criticalsystem that requires extreme safety. If there is a possibility that theequipment may be used for this purpose, contact one of our sales
representatives.
z In case of smoke, a burning smell, or the like, turn off the power to theequipment, disconnect the power cable from the outlet, and contact yoursales supplier or maintenance personnel. Using the faulty equipment without
repair may result in a fire or an electric shock.
z This equipment has built-in magnetic disk drives. Do not hit the equipment
or give a shock or vibration to the equipment because that may cause theequipment to fail. Should you drop the equipment or damage its chassis,
disconnect the power cable from the outlet and contact your maintenancepersonnel. Using the faulty equipment without repair may result in a fire oran electric shock. Do not give a shock to the equipment when unpacking or
carrying the equipment.
z Do not modify this equipment because that may result in a fire or an electric
shock. In no event will Hitachi be responsible for any consequences that
results from the modification or alteration of the equipment.

S-2

SAFETY INSTRUCTIONS (Continued)

1.2

CAUTIONz If the equipment drops or is tipped over, personal injury may result. Pay full
attention when transporting the equipment.
z Make sure you do not catch or hit your fingers to cause personal injury when
unpacking or carrying the equipment.

S-3

SAFETY INSTRUCTIONS (Continued)

1.3

NOTICEz This equipment alone cannot guarantee the system safety. In order to ensuresufficient safety of your system even when this equipment should fail,malfunction, or have program bugs, you must add systemic protections suchas building external protective/safety circuits to facilitate safety measures toprevent personal injury and serious accidents.
z Use the basic software that we specify. Operation is not guaranteed if any
other basic software is used.
z Do not use the equipment in the environment full of dust or with corrosivegas because that may cause the equipment to fail.
z Make sure sufficient space is provided for an air intake and exhaust aroundthe equipment. Otherwise, the temperature inside the equipment may rise andthat may cause a failure or short life span of the equipment. In addition, youneed to ensure sufficient clearance for maintenance work.
z Performing emergency shutdown (that is, unplugging the power cable fromthe outlet or shutting off the circuit breaker without proper shutdown of theOS) may cause the OS or applications not to work properly or may cause thesaved data to be corrupted. Never perform emergency shutdown unless you
must stop the system immediately due to some kind of error.
z Keep in mind that if the power supply is cut, the system may not be able torecover automatically.

S-4

SAFETY INSTRUCTIONS (Continued)

2. SAFETY WARNINGS IN THIS MANUAL
2.1 Safety Warning Indicated as “NOTICE”
z When a failure of a drive is anticipated, back up the data immediately andreplace the drive. For information about how to replace a drive, see“HF-BX1000/1200 INSTRUCTION MANUAL (manual number BX-620001)”.
(See page 2-3.)
z When an OS hung-up occurs, the processes on the OS may not run asscheduled, and the processing of the equipment may be delayed. As a result,the facility that uses this equipment may be affected. You must resolve theroot cause of the OS hung-up as soon as possible.
(See page 2-5.)
z If this equipment continues to operate while fan failure is detected, internal
parts such as a processor are not cooled down sufficiently, and that may
cause thermal runaway of the system due to malfunction of the equipment or
result in damage to the parts.
(See page 3-3.)
z If you select “Retriggered by application program” under Watchdog
timer setting and “Not reset” for Action at timeout in the RAS Setup
window, set the status display digital LEDs to the application status display
mode so that the status code is not displayed there. Otherwise, the timeout
code may be overwritten by the status code and may not be able to bechecked.
(See page 3-6.) (See page 4-17.)z When the Hardware status window shows an error in hardware, resolve theerror immediately.
(See page 4-3.)
z When failure of a drive is anticipated by SMART, the drive may experiencehardware failure in near future. We recommend you to back up the data andreplace the drive.
(See page 4-9.)

S-5

SAFETY INSTRUCTIONS (Continued)z If this equipment continues to operate with fan failure detected, internal parts
such as a processor are not cooled down sufficiently, and that may cause
thermal runaway of the system due to malfunction of the equipment or resultin damage to the parts. If possible, enable the automatic shutdown feature.
z If the automatic shutdown feature is not used, have a user application detect a
fan failure using a RAS event and shut down the equipment.
(See page 5-2.)
z Log function exits (asynchronously) without waiting for the data to be
actually written to a log file. That means this function does not return anerror even when writing to a log file fails for some reason. We recommend
important information be recorded in the OS event log.
(See page 6-11.)z CPU load increases while memory dump files are being collected. WhileCPU load is high, operation of user applications can be disturbed. Make surethat you do not collect memory dump files using the log informationcollection window while the applications for business use are running on thisequipment.
(See page 7-1.)
z While the equipment is running in simulation mode, monitoring of the actual
hardware status is disabled. Errors including fan failure and abnormal
temperature cannot be detected. You must never use this equipment insimulation mode for business use. Use the simulation function only fortesting a user application and checking the notification interface of the RAS
software.
(See page 8-2.)

S-6

PREFACE
This manual describes how to use the Reliability, Availability, Serviceability (RAS) feature of the
HITACHI INDUSTRIAL COMPUTER HF-BX1000/1200 (hereinafter referred to as “thisequipment”).
This manual is targeted for the RAS software version “01.01.****”. (* can be any numericalcharacter.) (For information about how to check the RAS software version, see “APPENDIX BCHECKING THE RAS SOFTWARE VERSION”.)<Organization of this manual>This manual is organized as follows.
CHAPTER 1 CAPABILITIES OF THE RAS FEATURE
CHAPTER 2 ITEMS MONITORED BY THE RAS FEATURE
CHAPTER 3 SETTING UP THE RAS FEATURE
CHAPTER 4 CHECKING THE HARDWARE STATUS
CHAPTER 5 CONTROLLING THE HARDWARE
CHAPTER 6 LIBRARY FUNCTIONSCHAPTER 7 FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSISCHAPTER 8 SIMULATING THE HARDWARE STATUS
APPENDIX A RUNNING COMMAND PROMPT AS AN ADMINISTRATORAPPENDIX B CHECKING THE RAS SOFTWARE VERSION<Precautions when you use the RAS feature>z Precautions about an event log entry at the startup of the SNMP service
When you enable the SNMP service, a standard feature of Windows®, in order to use remotenotification, an error log entry with event ID 1500 may be recorded at the startup of the SNMP
service. This event log entry is recorded when SNMP trap notification has not been set up. Set
up the trap notification according to “4.5.3 Enabling the remote notification”.
<Note for storage capacity calculations>z Memory capacities and requirements, file sizes and storage requirements, etc. must be
calculated according to the formula 2n. The following examples show the results of suchcalculations by 2n (to the right of the equals signs).
1 KB (kilobyte) = 1,024 bytes
1 MB (megabyte) = 1,048,576 bytes
1 GB (gigabyte) = 1,073,741,824 bytes
1 TB (terabyte) = 1,099,511,627,776 bytes
z As for disk capacities, they must be calculated using the formula 10n. Listed below are theresults of calculating the above example capacities using 10n in place of 2n.
1 KB (kilobyte) = 1,000 bytes
1 MB (megabyte) = 1,0002 bytes
1 GB (gigabyte) = 1,0003 bytes
1 TB (terabyte) = 1,0004 bytes<Trademarks>• Microsoft®, Windows®, Visual C++®, and Visual Basic® are trademarks or registeredtrademarks of U.S. Microsoft Corporation in the United States and other countries.
• All other product names (software and hardware) not from Hitachi described in this manual areregistered trademarks, trademarks, or products of their respective owners.

iCONTENTS
SAFETY INSTRUCTIONS ......................................................................................... S-1
CHAPTER 1 CAPABILITIES OF THE RAS FEATURE ........................................ 1-1
CHAPTER 2 ITEMS MONITORED BY THE RAS FEATURE ............................ 2-1
2.1 Fan Monitoring .................................................................................................................... 2-1
2.2 Monitoring Temperature inside the Chassis ........................................................................ 2-2
2.3 Drive Failure Prediction Function (SMART Monitoring) ................................................... 2-3
2.4 Drive Usage Monitoring ...................................................................................................... 2-4
2.5 Watchdog Timer Monitoring ............................................................................................... 2-5
2.5.1 Automatic retriggering feature for a watchdog timer .................................................... 2-5
2.5.2 Using a watchdog timer for monitoring a user program ................................................ 2-6
2.6 RAID Monitoring [D Model only] ....................................................................................... 2-7
2.6.1 State transition of the RAID .......................................................................................... 2-8
2.6.2 Note about media error .................................................................................................. 2-9

CHAPTER 3 SETTING UP THE RAS FEATURE .................................................... 3-1
3.1 RAS Setup Windows ........................................................................................................... 3-1
3.1.1 Overview ........................................................................................................................ 3-1
3.1.2 Starting the RAS Setup window .................................................................................... 3-2
3.1.3 Using the RAS Setup window ....................................................................................... 3-3
3.1.4 Editing popup notification messages ........................................................................... 3-13

CHAPTER 4 CHECKING THE HARDWARE STATUS ........................................ 4-1
4.1 Hardware Status Window .................................................................................................... 4-2
4.1.1 Overview ........................................................................................................................ 4-2
4.1.2 Hardware status icon ...................................................................................................... 4-4
4.1.3 Hardware status window ................................................................................................ 4-7
4.2 RAS Event Notification ..................................................................................................... 4-11
4.2.1 Overview ...................................................................................................................... 4-11
4.2.2 Detecting an event ....................................................................................................... 4-11
4.2.3 Example of using event objects ................................................................................... 4-11
4.3 Popup Notification ............................................................................................................. 4-12
4.3.1 Overview ...................................................................................................................... 4-12
4.3.2 Messages to be displayed ............................................................................................. 4-13
4.3.3 Popup notification settings .......................................................................................... 4-13
4.4 Status Display Digital LEDs Function ............................................................................... 4-14
4.4.1 Overview ...................................................................................................................... 4-14
4.4.2 Codes to be displayed .................................................................................................. 4-15
4.4.3 Status display modes .................................................................................................... 4-19
4.4.4 Priorities of displayed codes ........................................................................................ 4-20
4.4.5 Status display digital LEDs control functions ............................................................. 4-20
4.5 Remote Notification ........................................................................................................... 4-21
4.5.1 Overview ...................................................................................................................... 4-21
4.5.2 Hardware conditions that can be acquired by using remote notification ..................... 4-22
4.5.3 Enabling the remote notification ................................................................................. 4-23
4.5.4 Objects in the extended MIB for HF-BX .................................................................... 4-28
4.5.5 Extended MIB file for HF-BX ..................................................................................... 4-34
ii

4.6

Status Acquisition by Using the RAS Library ................................................................... 4-35

CHAPTER 5 CONTROLLING THE HARDWARE .................................................. 5-1
5.1 Automatic Shutdown and System Reset of the Equipment ................................................. 5-2
5.1.1 Automatic shutdown when detecting fan failure ........................................................... 5-2
5.1.2 Automatic shutdown when detecting abnormally high temperature ............................. 5-3
5.1.3 Automatic shutdown when a remote shutdown request through the contact input isdetected .......................................................................................................................... 5-3
5.1.4 System reset due to timeout detection ........................................................................... 5-3
5.1.5 Memory dump due to timeout detection ........................................................................ 5-3
5.2 Controlling the Hardware by Using the RAS Library ......................................................... 5-5
5.3 RAID Configuration Control Command (raidctrl) [D Model only] .................................... 5-6

CHAPTER 6 LIBRARY FUNCTIONS ......................................................................... 6-1
6.1 RAS Library Interface .......................................................................................................... 6-1
6.1.1 Overview ........................................................................................................................ 6-1
6.1.2 Shutdown function (BSSysShut) ................................................................................... 6-3
6.1.3 Watchdog timer control function (WdtControl) ............................................................ 6-4
6.1.4 Control functions for the general purpose external contact outputs(GendoControlEx) ......................................................................................................... 6-6
6.1.5 Get functions for the general purpose external contact inputs (GetGendiEx) ............... 6-8
6.1.6 Log function (MConWriteMessage) ............................................................................ 6-10
6.1.7 Get function for the drive condition (hfbDiskStat) ...................................................... 6-12
6.1.8 Get function for the RAID status (hfbRaidStat) [D Model only] ................................ 6-14
6.1.9 Status display digital LEDs control functions(SetStCode7seg, TurnOff7seg, SetMode7seg) ............................................................ 6-17
6.2 Sample Programs ............................................................................................................... 6-20

CHAPTER 7 FEATURES RELATED TO MAINTENANCE AND
FAILURE ANALYSIS ............................................................................. 7-1
7.1 Log Information Collection Window ................................................................................... 7-1
7.1.1 Overview ........................................................................................................................ 7-1
7.1.2 Starting the log information collection window ............................................................ 7-1
7.1.3 Using the log information collection window ............................................................... 7-2
7.1.4 Finishing the log information collection window .......................................................... 7-3
7.2 Logging the Trend of the Temperature inside the Chassis .................................................. 7-4
7.2.1 Overview ........................................................................................................................ 7-4
7.2.2 Log files ......................................................................................................................... 7-4
7.2.3 Logging interval setup command .................................................................................. 7-6

CHAPTER 8 SIMULATING THE HARDWARE STATUS ................................... 8-1
8.1 Hardware Status Simulation ................................................................................................. 8-1
8.1.1 Overview ........................................................................................................................ 8-1
8.1.2 Using the simulation function ........................................................................................ 8-3
8.1.3 Precautions when you use the Simulation Tool window ............................................. 8-13
8.1.4 Event log entries .......................................................................................................... 8-14
8.1.5 Remote notification ..................................................................................................... 8-14

iii

APPENDIX A RUNNING COMMAND PROMPT AS
AN ADMINISTRATOR ....................................................................... A-1
APPENDIX B CHECKING THE RAS SOFTWARE VERSION ......................... B-1

iv

FIGURES
Figure 1-1
Figure 1-2
Figure 2-1

RAS Setup Window ................................................................................................. 1-2
Hardware Status Icon ............................................................................................... 1-2
Example of a Flow Chart of Monitoring the Operational State of aUser Program ............................................................................................................ 2-6
Figure 2-2 RAID Status Transitions .......................................................................................... 2-8
Figure 2-3 Example of a Message Box when a Media Error Occurs ........................................ 2-9
Figure 3-1 RAS Setup Window ................................................................................................. 3-1
Figure 3-2 Items in the Shutdown Setting ................................................................................. 3-3
Figure 3-3 Items in Watchdog Timer Setting ............................................................................ 3-5
Figure 3-4 Items in Drive Failure Prediction (SMART Monitoring) Setting ............................ 3-7
Figure 3-5 Items in the Drive Usage Monitoring Setting .......................................................... 3-8
Figure 3-6 Advanced Setting for the Drive Usage Monitoring ................................................. 3-8
Figure 3-7 Items in the Status Display Digital LEDs Setting .................................................. 3-10
Figure 3-8 Items in the Popup Notification Setting ................................................................. 3-11
Figure 3-9 Advanced Settings for the Popup Notification Setting .......................................... 3-12
Figure 3-10 Format of a Definition File ................................................................................... 3-13
Figure 4-1 Hardware Status Window ......................................................................................... 4-2
Figure 4-2 Example of Displaying the Description of an Icon
(When the Hardware Status is Normal) ................................................................... 4-6
Figure 4-3 Example of Displaying the Description of an Icon
(When the Hardware Status Has an Error) ............................................................... 4-6
Figure 4-4 Menu of the Hardware Status Icon ........................................................................... 4-6
Figure 4-5 Starting the Hardware Status Window ..................................................................... 4-7
Figure 4-6 Hardware Status Window (Error Case) .................................................................. 4-10
Figure 4-7 Example of Popup Message ................................................................................... 4-12
Figure 4-8 Status Display Digital LEDs .................................................................................. 4-14
Figure 4-9 Hardware Status Code ............................................................................................ 4-15
Figure 4-10 Application Status Code ....................................................................................... 4-16
Figure 4-11 Timeout Code ....................................................................................................... 4-17
Figure 4-12 STOP Error Code ................................................................................................. 4-18
Figure 4-13 Example of a Status Display Mode ...................................................................... 4-19
Figure 6-1 Format of Log Information .................................................................................... 6-10
Figure 7-1 Organization of the Folders for Collected Data ....................................................... 7-3
Figure 7-2 Format of Log Information 1 ................................................................................... 7-5
Figure 7-3 Format of Log Information 2 ................................................................................... 7-5
Figure 8-1 Simulation Tool Window ......................................................................................... 8-1
Figure 8-2 Procedure to Use the Simulation Mode .................................................................... 8-3
Figure 8-3 Description of Each Part in the Simulation Tool Window ....................................... 8-6v

TABLES
Table 1-1 Overview of the RAS Feature ................................................................................... 1-1
Table 2-1 State of the Equipment in Terms of Fan Monitoring and State of the MCALL
Contact ....................................................................................................................... 2-1
Table 2-2 State of the Equipment in Terms of Monitoring Temperature inside the Chassis
and State of the MCALL Contact .............................................................................. 2-2
Table 2-3 Status of the RAID and State of the MCALL Contact .............................................. 2-7
Table 2-4 RAID Statuses and their Descriptions ....................................................................... 2-8
Table 3-1 Setup Items in the RAS Setup Window ..................................................................... 3-1
Table 3-2 Section Names and Defined Messages .................................................................... 3-14
Table 3-3 Items Displayed in the Object List for Each Option Selected in the Event List ..... 3-15
Table 4-1 Hardware Status Icon ................................................................................................. 4-5
Table 4-2 Fan Condition and Displayed Information ................................................................ 4-8
Table 4-3 Temperature Condition and Displayed Information .................................................. 4-8
Table 4-4 Drive Condition and Displayed Information ............................................................. 4-9
Table 4-5 RAID Status and Displayed Information ................................................................. 4-10
Table 4-6 Reported Events ....................................................................................................... 4-11
Table 4-7 Messages Displayed ................................................................................................ 4-13
Table 4-8 Hardware Status Codes ............................................................................................ 4-15
Table 4-9 Status Display Modes .............................................................................................. 4-19
Table 4-10 Objects Related to the Hardware Status ................................................................ 4-28
Table 4-11 Objects Related to the RAS Function Settings ...................................................... 4-30
Table 4-12 Objects Related to Operational Modes .................................................................. 4-30
Table 4-13 Objects Related to the Extended MIB for HF-BX ................................................ 4-31
Table 4-14 Objects Related to the Trap Notification (When an Error Occurs) ....................... 4-32
Table 4-15 Objects Related to the Trap Notification(When the Equipment has Recovered from an Error) ........................................... 4-33
Table 4-16 Objects Related to the Trap Notification (Operational Modes) ............................ 4-33
Table 5-1 RAID Status Displayed in the Output of the raidctrl Command ............................... 5-7
Table 5-2 Drive Status Displayed in the Output of the raidctrl Command ................................ 5-7
Table 5-3 Error Messages of the raidctrl Command .................................................................. 5-9
Table 6-1 RAS Library Functions .............................................................................................. 6-1
Table 6-2 List of Actions of WdtControl Specified by dwCmd ................................................ 6-4
Table 6-3 List of Actions of the GendoControlEx Function Specified by dwPort .................... 6-6
Table 6-4 List of Actions of the GendoControlEx Function Specified by dwCmd ................... 6-6
Table 6-5 List of Actions of the GetGendiEx Function Specified by dwPort ........................... 6-8
Table 6-6 List of Values Stored in Disk_Status ....................................................................... 6-12
Table 6-7 Values Stored in Level in the HFB_ARRAY_STATUS Structure ......................... 6-15
Table 6-8 Values Stored in DiskNumber in the HFB_ARRAY_STATUS Structure ............. 6-15
Table 6-9 Values Stored in Status in the HFB_ARRAY_STATUS Structure ........................ 6-15
Table 6-10 Possible Combinations that can be Stored in Status in the
HFB_ARRAY_STATUS Structure ....................................................................... 6-16
Table 6-11 List of Values Specified by dwMode in the SetMode7seg Function .................... 6-19
Table 6-12 List of Provided Sample Programs ........................................................................ 6-20
Table 7-1 Log Files .................................................................................................................... 7-4
Table 8-1 Event Log Entries Recorded by This Function ....................................................... 8-14vi

1. CAPABILITIES OF THE RAS FEATURE

CHAPTER 1 CAPABILITIES OF THE RAS FEATURE
The HF-BX1000/1200 come with the Reliability, Availability, Serviceability (RAS) feature thatyou would expect from a highly reliable industrial computer.
The following is an overview of the RAS feature.
Table 1-1 Overview of the RAS Feature
Category
Monitoring
GUI feature setting
Status check
GUI output
Notification

Control

Shutdown/System reset/Startup suppression

Library functions
Maintenance
Memory dump
/Failure analysis related

Simulation

Item
Hardware status monitoring
Watchdog timer monitoring
RAS Setup window
Hardware status window
Event notification
Popup notification
Status display digital LEDs
Remote notification
Status acquisition using library functions
Automatic shutdown
System reset
Shutdown using library functions
Startup suppression when severe failure occurs
Controlling the general purpose external
contacts
Controlling the status display digital LEDs
RAS library
Memory dump collection
Log information collection window
Maintenance operation support commands
Logging the trend of the temperature inside thechassisHardware status simulation

1-1

1. CAPABILITIES OF THE RAS FEATURE<Monitoring>(1) Hardware status monitoring
Monitors the hardware status of this equipment including the status of the fans and drives aswell as the temperature inside the chassis.
(2) Watchdog timer monitoring
Monitors the state in which the OS or a user program is running by using a watchdog timer
installed in this equipment. This function also offers a library to use the watchdog timer.
<GUI feature setting>(3) RAS Setup window
You can use a graphical user interface to configure RAS feature settings including thecondition of automatic shutdown and the watchdog timer settings.

Figure 1-1

RAS Setup Window<Status check>(4) Hardware status window
Displays the hardware status of this equipment using a graphical interface. There is always an
icon in the notification area of the taskbar to display the hardware status.

Figure 1-2

Hardware Status Icon

1-2

1. CAPABILITIES OF THE RAS FEATURE(5) Event notification
Enables a user application to check the hardware status of this equipment by monitoring thestatus of event objects.
(6) Popup notification
Notifies a user that an error occurred in the hardware of this equipment by displaying popup
messages.
(7) Status display digital LEDs
The status display digital LEDs are on the front of this equipment and notify a user that anerror occurred in the hardware of this equipment. These LEDs can be used by a user
application in order to, for example, notify the failure of the application.
(8) Remote notification
Enables a remote device to check the hardware status of the equipment. This function also
notifies to a remote device whenever the hardware status changes.
(9) Status acquisition using library functions
This function enables a user application to get the hardware status of this equipment by using
the RAS library.
<Control>(10) Automatic shutdown
Automatically shuts down the equipment when fan failure or abnormal temperature inside thechassis. Use “(3) RAS Setup window” to enable or disable the automatic shutdown feature.
(11) System reset
The system resets when a watchdog timer timeout in the equipment is detected. Use “(3) RAS
Setup window” to enable or disable the system reset feature.
(12) Shutdown using library functions
A user application can shut down the equipment using the RAS library.
(13) Startup suppression when severe failure occurs
Suppresses startup of this equipment when failure such as fan failure is detected during OS
startup in order to protect the hardware.
(14) Controlling the general purpose external contacts and the status display digital LEDs
Enables a user to control the general purpose external contacts and the status display digital
LEDs with the RAS library.
Two input and two output general purpose external contacts are available for a user. If you
use those contacts, signals can be input from an external device to this equipment, and signals
can be output from this equipment to an external device.
<Library functions>(15) RAS library interface
Offers library functions for recording log information in addition to the library functions
offered by (2), (9), (12), and (14).

1-3

1. CAPABILITIES OF THE RAS FEATURE<Maintenance / Failure analysis>(16) Memory dump collection
When a failure occurs, for example, this equipment stops unexpectedly, you can save thecontents of the system memory to a file (memory dump file) by pressing Scroll Lock twice
while holding the right Ctrl key. By analyzing the data in this memory dump, you caninvestigate the cause of the failure.
(17) Log information collection window
Allows you to collect log data and memory dump files for this equipment using a graphicaluser interface.
(18) Maintenance operation support commands
These commands include a command used for saving failure information such as memory
dump files and event log files to an external medium.
(19) Logging the trend of the temperature inside the chassis
This function periodically measures the temperature inside the chassis of this equipment andrecords the data into a file.
<Simulation>(20) Hardware status simulation
Simulates the hardware status of this equipment. By using this function, you can test a user
application and check the notification interface of the RAS software without actual hardware
failure.
This manual explains functions (1) through (12), (14), (15), (17), (19), and (20). For details aboutother functions, see “HF-BX1000/1200 INSTRUCTION MANUAL (manual number BX-62-0001)”.

1-4

2. ITEMS MONITORED BY THE RAS FEATURE

CHAPTER 2 ITEMS MONITORED BY THE RAS FEATURE
This chapter explains the items monitored by the RAS Feature.
For information about the hardware specifications of the RAS external contacts interface describedin this chapter and the usage of each contact, see “HF-BX1000/1200 INSTRUCTION MANUAL(manual number BX-62-0001)”.
2.1

Fan Monitoring
The fan monitoring function monitors the multiple fans located in this equipment and notifies
in the following methods when one of the fans malfunctions.
(1) Hardware status window(2) Event notification(3) Popup notification(4) Outputs on the status display digital LEDs
(5) Remote notification(6) Automatic shutdown
For information about items (1) through (5), see “CHAPTER 4 CHECKING THE
HARDWARE STATUS”. For information about item (6), see “5.1 Automatic Shutdown
and System Reset of the Equipment”.
If you use the MCALL contact of the RAS external contacts interface, the external hardware
connected to the RAS external contacts interface can detect malfunction of this equipment.
The following table shows how the state of the MCALL contact changes.

Table 2-1 State of the Equipment in Terms of Fan Monitoring and State of the MCALL Contact
Status of this equipment
When the fans operate normally or have recoveredfrom malfunction
During malfunction of the fans

MCALL contact
Open
ClosedThe MCALL contact of the RAS external contacts interface is not dedicated to fanmonitoring, and therefore, it is not opened when the system recovers from fan malfunction aslong as malfunction are detected in other monitored items.

2-1

2. ITEMS MONITORED BY THE RAS FEATURE

2.2 Monitoring Temperature inside the Chassis
This function monitors the temperature inside the chassis using the temperature sensor in thisequipment and notifies in the following methods when the temperature inside the chassis gets
abnormally high.
(1) Hardware status window(2) Event notification(3) Popup notification(4) Outputs on the status display digital LEDs
(5) Remote notification(6) Automatic shutdown
For information about items (1) through (5), see “CHAPTER 4 CHECKING THE
HARDWARE STATUS”. For information about item (6), see “5.1 Automatic Shutdown
and System Reset of the Equipment”.
If you use the MCALL contact of the RAS external contacts interface, the external hardware
connected to the RAS external contacts interface can detect malfunction of this equipment.
The following table shows how the state of the MCALL contact changes.
Table 2-2 State of the Equipment in Terms of Monitoring Temperature inside the Chassis andState of the MCALL Contact
Status of this equipment
When the temperature is normal or has recoveredfrom being abnormally highWhen the temperature is abnormally high

MCALL contact
Open
ClosedThe MCALL contact of the RAS external contacts interface is not dedicated to monitoring thetemperature inside the chassis, and therefore, it is not opened when the system recovers fromthe abnormally high temperature as long as malfunction are detected in other monitored items.

2-2

2. ITEMS MONITORED BY THE RAS FEATURE

2.3 Drive Failure Prediction Function (SMART Monitoring)
The hard drives in this equipment have the Self-Monitoring, Analysis and Reporting
Technology (SMART) function, which constantly monitors the condition of the drives andanticipates a failure before the failure manifests itself. The drive failure prediction function
notifies in the following methods when there is a possibility that failure may occur in a drivein near future.
(1) Hardware status window(2) Event notification(3) Popup notification(4) Outputs on the status display digital LEDs
(5) Remote notification(6) The hfbDiskStat functions in the RAS library
For details, see “CHAPTER 4 CHECKING THE HARDWARE STATUS”.
This function can be enabled or disabled in the RAS Setup window. If this function isdisabled, notification using the methods above is disabled. For details, see “3.1.3 Using theRAS Setup window”.

NOTICE
When a failure of a drive is anticipated, back up the data immediately and replace
the drive. For information about how to replace a drive, see “HF-BX1000/1200
INSTRUCTION MANUAL (manual number BX-62-0001)”.
NOTE• It is not possible for the Drive Failure Prediction Function to anticipate all
failures. Therefore, a drive may fail before the Drive Failure Prediction
Function anticipates any failures.
• This function can monitor only the drives on the drive bay1 and 2 recognizedat the OS startup. If you connect a new drive or replace a drive with a new
drive, for example, for maintenance, it may take a long time to recognize thenew drive at the first startup after the new drive is connected, and the drive
may not be recognized as a drive to be monitored. If this situation happens,
restart this equipment.

2-3

2. ITEMS MONITORED BY THE RAS FEATURE

2.4 Drive Usage Monitoring
The drive usage monitoring function adds up the power-on hours of a drive in this equipment.
If the total power-on hours exceeds the set value, this function notifies in the methods below.
By using this function, you can keep track of the appropriate timing of replacing a drive andprevent drive failure caused by using the drive for too long.
(1) Hardware status window(2) Event notification(3) Popup notification(4) Remote notification(5) The hfbDiskStat function in the RAS library
For details, see “CHAPTER 4 CHECKING THE HARDWARE STATUS”.
This function can be enabled or disabled in the RAS Setup window. If this function isdisabled, notification using the methods above is disabled. For details, see “3.1.3 Using theRAS Setup window”.
NOTE• This monitoring function is active while the OS is running, that is, from OS
startup to OS shutdown. When the OS is not running, the amount of the drive
power-on hours is not monitored.
• This function records the serial number (unique ID) of a drive in the equipment
in a drive management information file. If you mount a drive that does notmatch the serial number recorded in the drive management information file,the cumulative power-on hours for the drive is automatically reset.
• This function is not designed to anticipate drive failure, but we recommend
replacing a drive when the power-on hours exceeds the set value from theviewpoint of preventive maintenance for components with limited life span. For
information about how to replace a drive, see “HF-BX1000/1200
INSTRUCTION MANUAL (manual number BX-62-0001)”.
• This function can monitor only the drives on the drive bay1 and 2 recognizedat the OS startup. If you connect a new drive or replace a drive with a new
drive, for example, for maintenance, it may take a long time to recognize thenew drive at the first startup after the new drive is connected, and the drive
may not be recognized as a drive to be monitored. If this situation happens,
restart this equipment.

2-4

2. ITEMS MONITORED BY THE RAS FEATURE

2.5 Watchdog Timer Monitoring
This equipment has a built-in watchdog timer and can monitor the operation of the OS and auser program.
• Automatic retriggering feature
The watchdog timer monitoring process in the RAS software automatically retriggers thetimer and monitors the operation of the OS.
• User program operational state monitoring
A user can monitor the operational state of a user program by using dedicated libraryfunctions.
In addition, you can select either one of the following actions to be taken when a timer
timeout occurs.
(1) The system is reset.
(2) The timeout code is displayed on the status display digital LEDs.
(3) A memory dump is generated.
For information about (1), see “5.1.3 System reset due to timeout detection”. For
information about (2), see “4.4.2 Codes to be displayed”. For information about (3), see“5.1.4 Memory dump due to timeout detection”.
Note that you can configure the watchdog timer settings and the action on timeout in the RAS
Setup window. For information about how to use the RAS Setup window, see “3.1.3 Using
the RAS Setup window”.
2.5.1 Automatic retriggering feature for a watchdog timer
The automatic retriggering feature can detects the situation that the watchdog timer
monitoring process in the real-time priority class cannot run for a certain period of time (thesituation that the watchdog timer expires) as an OS hung-up.
To use this feature, in the RAS Setup window, select Automatic retrigger under
Watchdog timer setting.

NOTICE
When an OS hung-up occurs, the processes on the OS may not run asscheduled, and the processing of the equipment may be delayed. As a result, thefacility that uses this equipment may be affected. You must resolve the root
cause of the OS hung-up as soon as possible.
NOTE
In this feature, OS hung-up is defined as a state that a process in the real-time priority
class cannot run for a certain period of time.

2-5

2. ITEMS MONITORED BY THE RAS FEATURE

2.5.2 Using a watchdog timer for monitoring a user program
When you use the watchdog timer for monitoring the operational state of a user program,the user program to be monitored must periodically retrigger the watchdog timer (that is,reset the timeout counter of the watchdog timer to the initial value). Figure 2-1 shows anexample of monitoring the operational state of a user program.

Monitored program

Process a user-definedroutineTrigger thewatchdog timer
Retrigger
Equipment
Watchdog timer

Figure 2-1

Example of a Flow Chart of Monitoring the Operational State of a User Program

If a watchdog timer timeout occurs, that means the monitored program was not be able toretrigger the watchdog timer within the configured timeout for some reasons.
A program can use a watchdog timer by calling the library function WdtControl. For
information about how to use the WdtControl function, see “6.1.3 Watchdog timer control
function (WdtControl)”.
In addition, in the RAS Setup window, select “Retriggered by application program”
under Watchdog timer setting.
NOTE• If you want to stop monitoring using the watchdog timer when a user program exits ordue to shutdown, you must stop the watchdog timer so that a timeout does not occur.
• If you select “Reset” or “Memory dump” for Action at timeout under Watchdog
timer setting in the RAS Setup window, the time it takes to generate timeout islonger than the timeout value set by the application. This is a correct operation.
This situation occurs because it takes about 1.2 to 1.3 seconds for the hardware timer
on this equipment to actually enable the timeout setting set by the application. If thetimeout is set to 30 seconds, reset or memory dump starts about 31 seconds after thetimeout is set.

2-6

2. ITEMS MONITORED BY THE RAS FEATURE

2.6 RAID Monitoring [D Model only]
D Model has a RAID1 feature (hereinafter denoted simply as “RAID”) generally known as“mirror disk (mirroring)”.
The RAID monitoring function monitors the status of the RAID on this equipment. If there isany change in the status of the RAID, this function notifies a user or an application using thefollowing methods.
(1) Hardware status window(2) Event notification(3) Popup notification(4) Outputs on the status display digital LEDs
(5) Remote notification(6) The hfbDiskStat and hfbRaidStat functions in the RAS library(7) RAID configuration control command (raidctrl)
For information about items (1) through (5), see “CHAPTER 4 CHECKING THE
HARDWARE STATUS”.
For information about item (6), see “6.1.5 Get function for the drive condition(hfbDiskStat)”, “6.1.5 Get function for the RAID status (hfbRaidStat) [D Model only]”. For
information about item (7), see “5.3 RAID Configuration Control Command (raidctrl) [DModel only]”.
If you use the MCALL contact of the RAS external contact interface, the external hardware
connected to the RAS external contact interface can detect malfunctions of this equipment.
The following table shows how the state of the MCALL contact changes.
Table 2-3 Status of the RAID and State of the MCALL Contact
RAID status

MCALL contact
NormalOpen
Degraded(*), Unknown, Fail
Closed(*) This includes the case that a media error is enabled and notified.

The MCALL contact of the RAS external contacts interface is not dedicated to monitoring thestatus of the RAID, and therefore, it is not opened when the status of the RAID recovers aslong as malfunctions are detected in other monitored items.

2-7

2. ITEMS MONITORED BY THE RAS FEATURE

2.6.1 State transition of the RAID
Table 2-4 lists RAID statuses and their respective descriptions. Figure 2-2 shows the statetransitions.
Table 2-4 RAID Statuses and their Descriptions
RAID status
Detailed
information
Normal––DegradedRebuild
Fail–
Unknown –Description
Redundant data is intact, and the RAID is operating normally.
One drive failed, and a part of redundant data is corrupted.
The RAID is being rebuilt due to drive replacement or other reason.
Both drives failed, or drives are not connected.
Getting the RAID status failed, or the array configuration is not normal.

NormalMedia error occurs.

One drive fails.
Degraded

Degraded
RAID rebuild
process is complete.
Drive
replacement

Error occurs
in the new drive.

RAID rebuild process iscomplete.
(Read error occurs in
the copy source drive.)

Degraded(Rebuild)

Two drives fail.

Fail

Figure 2-2

RAID Status Transitions

2-8

2. ITEMS MONITORED BY THE RAS FEATURE

2.6.2 Note about media error
Media error is a status where there is a problem in data integrity while the RAID status isnormal. If read errors occur at the copy source drive during a rebuild process, the rebuild
process will complete but the sector data that could not be read is already lost, indicating adata integrity problem.
<Handling a media error as a failure>
The severity of this data integrity problem depends on whether those bad sectors with readerrors are actually used. If those bad sectors are used, there is a real problem in data
integrity. But if not, that is not a problem at all.
This is why this equipment allows you, depending on how the system is operated, to selectwhether a media error is reported. In the default factory settings, a media error is notreported.
Use the RAID configuration control command (raidctrl) to select whether a media error isreported. (For details, see “5.3 RAID Configuration Control Command (raidctrl) [DModel only]”.)A media error can be reported in the following ways:(1) Event notification(2) Outputs on the status display digital LEDs
(3) Remote notification(4) Message box(5) MCALL contact of the RAS external contacts interface

Figure 2-3

Example of a Message Box when a Media Error Occurs

Note that, regardless of the setting for whether a media error is reported, you can check
whether media errors occurred in the following ways:(6) Hardware status window(7) The hfbRaidStat function in the RAS library(8) RAID configuration control command (raidctrl)
For details about (1) to (3) and (6), see “CHAPTER 4 CHECKING THE HARDWARE
STATUS”. For details about (7), see “6.1.6 Get function for the RAID status(hfbRaidStat) [D Model only]”. For details about (8), see “5.3 RAID Configuration
Control Command (raidctrl) [D Model only]”.

2-9This Page Intentionally Left Blank

3. SETTING UP THE RAS FEATURE

CHAPTER 3 SETTING UP THE RAS FEATURE
3.1

RAS Setup Windows

3.1.1 Overview
In the RAS Setup window, the following functions can be set up.
Table 3-1 Setup Items in the RAS Setup Window
Item
Automatic shutdown when detecting fan failure
Shutdown
Automatic shutdown when detecting abnormallysettinghigh temperature
Watchdog timer setting
Drive Failure Prediction (SMART monitoring) setting
Drive usage monitoring setting
Status display digital LEDs setting
Popup notification setting

Figure 3-1 shows the RAS Setup window. The default factory-shipped settings are shown in
the figure.

Figure 3-1

RAS Setup Window

3-1

3. SETTING UP THE RAS FEATURE

3.1.2

Starting the RAS Setup window
To start the RAS Setup window, follow the procedure below.
Before you start this window, you need to log on to the computer as an administrator
account.
1. Click Start.
2. Point to All Programs > RAS Software.
3. Click RAS Setup.
4. If you see the User Account Control window, click Yes.
NOTEThe RAS Setup window cannot be used by multiple users at the same time. If
you use, for example, user switching to try to start instances of this window
from multiple consoles, the following message appears. If you receive thismessage, close the RAS Setup window on another console, and then start theRAS Setup window.

3-2

3. SETTING UP THE RAS FEATURE

3.1.3

Using the RAS Setup window(1) Shutdown setting
You can select whether this equipment is automatically shut down for each of thefollowing cases: a fan failure, and an abnormally high temperature.

Figure 3-2

Items in the Shutdown Settingz “Automatically shutdown if fan failure has been detected” check box• Selected: This equipment will be automatically shutdown (default factory-shipped
setting).
• Cleared: This equipment will not be automatically shutdown.
z “Automatically shutdown if abnormally high temp. has been detected” check box• Selected: This equipment will be automatically shutdown.
• Cleared: This equipment will not be automatically shutdown (default factory-shipped
setting).
If you want to change the current setting, click the check box you want to change.

NOTICE
If this equipment continues to operate while fan failure is detected, internal parts
such as a processor are not cooled down sufficiently, and that may cause thermal
runaway of the system due to malfunction of the equipment or result in damage tothe parts.

3-3

3. SETTING UP THE RAS FEATURE

NOTE• If you clear the “Automatically shutdown if fan failure has been detected”
check box, the following cautionary message is displayed. Enable this function(select the check box) whenever you can.

If you click Cancel when you receive the message above, the check box
reverts back to being selected. If you click OK, the check box is cleared.
• After an automatic shutdown initiated by this function is complete, the power
to this equipment is automatically turned off.

3-4

3. SETTING UP THE RAS FEATURE(2) Watchdog timer setting
You can set up the watchdog timer of this equipment.
You can select one of the following ways of using the watchdog timer:• Not used
• Retriggered by application program• Automatic retrigger
Click the radio button corresponding to the item you want to select.
The default factory setting is “Not used”.

Figure 3-3

Items in Watchdog Timer Setting

Not used:If you select this item, the watchdog timer is stopped. The watchdog timer will nottime out. In addition, you cannot use the watchdog timer by calling the WdtControl
function of the RAS library.
Retriggered by application program:If you select this item, you can monitor the operational state of a user program bycontrolling the watchdog timer using the WdtControl function in the RAS library.
Automatic retrigger:
If you select this item, you can monitor the operation of the OS using the watchdog
timer automatic retriggering feature. In addition, you cannot use the watchdog timer bycalling the WdtControl function of the RAS library.

3-5

3. SETTING UP THE RAS FEATURE

If you select “Retriggered by application program” or “Automatic retrigger”, you
can select the action when a watchdog timer timeout occurs.
z Action on timeout• Not reset: The equipment is not reset. (Default factory setting)
The timeout code is displayed on the status display digital LEDs.
(For information about the timeout code, see “(3) Timeout code” in “4.4.2
Codes to be displayed”.
• Reset: The equipment is reset.
• Memory dump: A memory dump is generated.

NOTICE
If you select “Retriggered by application program” under Watchdog timer
setting and “Not reset” for Action at timeout in the RAS Setup window, set thestatus display digital LEDs to the application status display mode so that thestatus code is not displayed there. Otherwise, the timeout code may beoverwritten by the status code and may not be able to be checked.
NOTE• To make a new watchdog timer setting effective, you must restart theequipment.
When the watchdog timer setting is changed, the following message isdisplayed. Click OK to close the box, and then make sure you restart theequipment.

• If you select “Reset” or “Memory dump” for Action at timeout, the time ittakes to generate timeout is longer than the timeout value set by theapplication. This is a normal operation.
This situation occurs because it takes about 1.2 to 1.3 seconds for the
hardware timer on this equipment to actually enable the timeout setting set by
the application. If the timeout is set to 30 seconds, reset or memory dump
starts about 31 seconds after the timeout is set.
• Even if you select “Memory dump” for Action at timeout, a memory dump
may not be generated depending on the situation, for example, when
Windows stops responding due to an interrupt with a high interrupt request
level (IRQL).

3-6

3. SETTING UP THE RAS FEATURE(3) Drive Failure Prediction (SMART monitoring) setting
You can set up the drive failure prediction (SMART monitoring) setting for the internal
drives in this equipment.

Figure 3-4

Items in Drive Failure Prediction (SMART Monitoring) Settingz “Function is available” check box• Selected: The drive failure prediction is enabled (default factory-shipped setting).
• Cleared: The drive failure prediction is disabled.
If you want to change the current setting, click the check box.
If the drive failure prediction is disabled, you cannot use the notification functions
described in “2.3 Drive Failure Prediction Function (SMART Monitoring)” such as
indicating a predicted drive failure.
z Watching interval
To set the watching interval, type a value in single-byte numeric characters in the boxthat follows Watching interval. Type an integer value between 1 and 24 (in hours).
The default factory-shipped setting is 4 (hours). If the drive failure prediction isdisabled, this item cannot be configured.

3-7

3. SETTING UP THE RAS FEATURE(4) Drive usage monitoring setting
You can set up the drive usage monitoring setting. By clicking Advanced, you can set
up the advanced settings of this function.

Figure 3-5

Items in the Drive Usage Monitoring Settingz “Function is available” check box• Selected: The drive usage monitoring is enabled (default factory-shipped setting).
• Cleared: The drive usage monitoring is disabled.
If you want to change the current setting, click the check box you want to change.
If the drive usage monitoring is disabled, you cannot use the functions described in“2.4 Drive Usage Monitoring” such as indicating if the value of the drive power-on
hours exceeds the threshold.
z Advanced button
Click Advanced to display the following window.

Figure 3-6

Advanced Setting for the Drive Usage Monitoring

3-8

3. SETTING UP THE RAS FEATURE

In the Advanced window, you can set up a threshold for the drive power-on hours sothat you can be notified when the value of the drive power-on hours exceeds thethreshold. To set the notification threshold, from the Object list, select the drive youwant to set up. Type the value for the threshold in single-byte characters in the box in “Itreports when the used hours passes
hours.” Then click OK.
Enter an integer value in hours ranging from 100 to 20000 in the step of 100 (100(minimum), 200, ..., 20000 (maximum)). The default factory-shipped setting is 20000(hours). If you want to clear the current cumulative power-on hours when click Reset toclear the value. Then the following message is displayed.

If you click OK when you receive the message, the value of the current cumulative
power-on hours is cleared. Click Cancel to leave the value as is. If the drive usage
monitoring is disabled, this item cannot be set.
If you changed the settings in the Advanced window and want to make the change
effective, click OK.
If you do not want the change, click Cancel. The window is closed and the change isdiscarded.

3-9

3. SETTING UP THE RAS FEATURE(5) Status display digital LEDs setting
You can set up the display mode of the status display digital LEDs located on the frontof this equipment.

Figure 3-7

Items in the Status Display Digital LEDs Settingz “Show Hardware status” check box• Selected: Hardware status display mode (default factory-shipped setting).
• Cleared: Application status display mode.
If you want to change the current setting, click the check box.
For details about the function of the status display digital LEDs including its display
modes, see “4.4 Status Display Digital LEDs Function”.

3-10

3. SETTING UP THE RAS FEATURE(6) Popup notification setting
You can set up the popup notification setting. By clicking Advanced, you can set up theadvanced settings of this function.

Figure 3-8

Items in the Popup Notification Settingz “Function is available” check box• Selected: The popup notification is enabled.
• Cleared: The popup notification is disabled (default factory-shipped setting).
If you want to change the current setting, click the check box.
If the popup notification is disabled, you cannot use the popup notification featuredescribed in “4.3 Popup Notification”.

3-11

3. SETTING UP THE RAS FEATUREz Advanced button
Click Advanced to display the following window.

Other than D Model
Figure 3-9

D ModelAdvanced Settings for the Popup Notification Setting[Events]• Fan failure• Abnormally high temp.
• Drive failure prediction (SMART)• Drive usage excess (When the drive power-on (=used) hours exceeds the threshold)• RAID error is detected (D Model only)
You can disable or enable popup notification for each of the items above.
z Check box for each item
• Selected: The popup notification is enabled. (factory-shipped default setting)• Cleared: The popup notification is disabled.
If you want to change the current setting, click the check box.
[Message editing]
You can edit popup notification messages. And you can check the messages after you
edit them. For information about how to edit and check the messages, see “3.1.4
Editing popup notification messages”.
If you changed the advanced setting and want to make the change effective, click OK.
If you do not want the change, click Cancel. Then the window is closed and thechange is inapplicable.
(7) Making the change you made in (1) through (6) effective or discard the changes
If you changed the settings in (1) through (6) and want to make the change effective, in
the RAS Setup window, click OK. If you do not want to change the setting, click
Cancel. Then the RAS Setup window is closed and the changes are discarded.

3-12

3. SETTING UP THE RAS FEATURE

3.1.4

Editing popup notification messages(1) Editing popup notification messages
If you want to edit messages used for popup notification, click Edit. Notepad is launched
and the message definition file for popup notification is opened. Edit the messages in theformat described below.
NOTE
While you are editing messages, you cannot do the following:• Clicking Edit.
• Clicking Set default.
• Closing the RAS Setup window (clicking OK or Cancel).
If you do one of the above, the following cautionary message is displayed.

If you click OK when you receive the message, you go back to the RAS Setup
window.
 Format of a definition file
The format of a definition file is as follows.
;-- Example of the definition of messages -[CS-FAN]

Section

Line1=""
Line2=""
Line3="Revolution of case fan deteriorated remarkably."[CPU-FAN]

Value

Key

Line1=""
Line2=""
Line3="Revolution of cpu fan deteriorated remarkably."

Figure 3-10

Format of a Definition FileA definition file consists of sections, keys, and the values of the keys.
Each section contains keys and their values. A key and its value are separated by an equal
sign (=).
Lines that start with a semicolon (;) are comment lines.

3-13

3. SETTING UP THE RAS FEATURE

 Description in a definition file
1. Section
The table below shows a list of section names you can define for this function and an
explanation of the message you define for each section.
Table 3-2 Section Names and Defined Messages
Section name
[CS-FAN][CPU-FAN][TEMP][HDD1-SMART][HDD2-SMART][HDD1-OFFLINE][HDD2-OFFLINE][HDD1-OVERRUN][HDD2-OVERRUN]

Defined message
A message displayed when a case fan failure is detected.
A message displayed when a CPU fan failure is detected.
A message displayed when an abnormal temperature inside the chassis isdetected.
A message displayed when a drive failure prediction (SMART) is detected
for the drive bay1.
A message displayed when a drive failure prediction (SMART) is detected
for the drive bay2.
A message displayed when a RAID failure is detected due to a drive failure
at drive bay1. (*)
A message displayed when a RAID failure is detected due to a drive failure
at drive bay2. (*)
A message displayed when the drive power-on (=used) hours exceeds thedetermined value for the drive bay1.
A message displayed when the drive power-on (=used) hours exceeds thedetermined value for the drive bay2.

(*) D Model only.

2. Keys
For a key, specify the line number of a line displayed as a part of the popup message.
In this function, you can use the keys “Line1” through “Line5” for each section.
If you specify Line6 and so on for keys, those keys are ignored.
3. Values
Specify one line of message displayed as a part of the popup message for a value.
For each key, a maximum of 50 bytes of characters (up to 25 double-byte characters)
can be assigned. If you specify more than 50 bytes of characters, the characters at the51th byte and after are ignored.
If the line includes space characters, the whole value should be enclosed in double
quotation marks (“”). If the value is empty, it is treated as a newline character.
NOTE• When you save the change, make sure you use Save in the menu. Otherwise,
the change you made may not be saved properly.
• While you are editing a definition file, do not use another application to edit thesame file. If you edit a definition file from multiple applications at the sametime, the change may not be saved properly.
• When you edit a popup notification message, make sure that the message
clearly states that an error occurred. If you continue to use this equipment
while error remains, your system may be affected significantly.

3-14

3. SETTING UP THE RAS FEATURE(2) Checking popup notification messages
You can check the change you made in the message for each of the following items:• Fan failure• Abnormally high temp.
• Drive failure prediction• Drive usage excess (When the drive power-on (=used) hours exceeds the threshold)• RAID error is detected. (D Model only)
The following shows how to check the change you made in the message.
1. In the Event list, select the event you want to check.
In this list, only the items under Events selected using the check boxes are displayed.
If no items under Events are selected using the check boxes, you cannot select an itemfrom the Event list.

<Example of Selecting Fan failure>
2. In the Object list, select the object you want to check.
Items in this list depend on the item you selected in step 1.

<Example of selecting case fan>
The table below shows items displayed in the Object list for each option you select inthe Event list.
Table 3-3

Items Displayed in the Object List for Each Option Selected in the Event List
Option in the Event list

Items in the Object list
Case fan, CPU fan
Temperature inside the chassis
Drive bay1, Drive bay2

Fan failure
Abnormally high temp.
Drive failure prediction
Drive usage excess
RAID error is detected.

3-15

3. SETTING UP THE RAS FEATURE

3. Click Display message. A popup notification message is displayed based on thechange you made. After you confirm that the message is OK, click OK in the popup.

If the message is not edited or there is something wrong in the message definition file,the following message is displayed. Click OK to go back to the RAS Setup window.
Correct the change you made in the message.

(3) Restoring default messages
If you want to set the popup notification messages back to the default, click Set default.
The following message will appear. Click Yes. Then the changes you made in themessage definition file are discarded.

If you click No, the changes are not deleted and the messages do not revert back to thedefault.

3-16

4. CHECKING THE HARDWARE STATUS

CHAPTER 4 CHECKING THE HARDWARE STATUS
You can check the hardware status of this equipment by using the following methods.
(1) Check by using GUIs
You can check the hardware status of this equipment by using a graphical interface. For details,
see “4.1 Hardware Status Window”.
(2) Check with a user application
A user application can check the hardware status of this equipment by monitoring the status of
event objects. For details, see “4.2 RAS Event Notification”.
A user application can also get the hardware status of this equipment by using the RAS library.
For details, see “4.6 Status Acquisition by Using the RAS Library”.
(3) Check on the desktop of this equipment
A popup message is displayed to notify that an error occurred in the hardware of this equipment.
For details, see “4.3 Popup Notification”.
(4) Check by using the status display digital LEDs on the front of this equipment
The status display digital LEDs are on the front of this equipment and notify a user that an error
has occurred in the hardware of this equipment. On the LEDs, a user application can display any
code. You can use the LEDs, for example, for a user defined failure notification to maintenancepersonnel. For details, see “4.4 Status Display Digital LEDs Function”.
(5) Check from a remote device
A remote device can check the hardware status of this equipment. A remote device can also be
notified whenever the hardware status changes. For details, see “4.5 Remote Notification”.

4-1

4. CHECKING THE HARDWARE STATUS

4.1

Hardware Status Window

4.1.1 Overview
After you log on to this equipment, there will always be an icon in the notification area ofthe taskbar to display the hardware status. If you double-click this icon or if you right-click
the icon to display a popup menu and click Display Hardware status, detailed information
about the hardware status of this equipment is displayed.
This window displays the following information:• Fan condition• Temperature condition inside the chassis• Drive status (including failure prediction by SMART Monitoring)• Drive power-on (=used) hours• RAID status (D Model only)

Other than D Model

D ModelFigure 4-1

Hardware Status Window

4-2

4. CHECKING THE HARDWARE STATUS

NOTICE
When the Hardware status window shows an error in hardware, resolve theerror immediately.
NOTE• This window can display the status of the drives on the drive bay1 and 2
recognized at the OS startup, not the status of other drives. If you connect a
new drive or replace a drive with a new drive, for example, for maintenance, it
may take a long time to recognize the new drive at the first startup after the
new drive is connected, and the information about the drive may not be
displayed. If this situation happens, restart this equipment.
• For information about how to replace a perishable component, refer to“HF-BX1000/1200 INSTRUCTION MANUAL (manual number BX-62-0001)”.

4-3

4. CHECKING THE HARDWARE STATUS

4.1.2 Hardware status icon
After you log on to this equipment, there will always be an icon in the notification area ofthe taskbar to display the hardware status.

Note that, in the default factory settings, the icon is not shown. If you click the arrow at theside of the notification area, the icon will appear. If you want to always show the icon in the
notification area of the taskbar, click Customize and configure the icon to be always shownin the notification area.

NOTE
In rare cases, the registration of the hardware status icon to the taskbar may
fail, and the following message may be displayed. If this happens, follow theprocedure below to retry the registration of the hardware status icon.

1. Click OK in the message above.
2. Point to Start > All Programs > Startup, and click RAS Status.

4-4

4. CHECKING THE HARDWARE STATUS(1) List of displayed icons and description of each icon
Table 4-1 shows a list of displayed icons and a description of each icon. A description of
the displayed icon is shown when you point the mouse cursor to the icon.
Table 4-1 Hardware Status Icon
No.

Hardwarestatus1

NormalIcon

Description of the icon
Hardware status is normal.

2
Fan failed.
3
Abnormal TEMP detected.
4
Fan failed. Abnormal TEMP detected.
5
Fan failed. Drive failure possible.
6
Abnormal TEMP detected. Drive failure possible.
7
Fan failed. Abnormal TEMP detected. Drive failure possible.
8Error
Fan failed. Time of drive exceeded.
9
Abnormal TEMP detected. Time of drive exceeded.
10
Fan failed. Abnormal TEMP detected. Time of drive exceeded.
11
RAID error detected.
12
Fan failed. RAID error detected.
13
Abnormal temperature detected. RAID error detected.
14
Fan failed. Abnormal temperature detected. RAID error detected.
15
Drive failure possible.
Caution
16
Time of drive exceeded.
Nos. 5 through 7 and 15: When both “Time of drive exceed.” and “Drive failure possible.” happen at thesame time, the description of the icon does not show “Time of drive exceeded.”Nos. 11 through 14: These descriptions apply to D Model only. When both “Drive failure possible.” (or“Time of drive exceeded.”) and disconnection of a drive due to RAID error(OFFLINE) happen at the same time, the description of the icon does not show “Drive
failure possible.” (or “Time of drive exceeded.”).
Nos. 15 and 16: If a hardware status error is detected at the same time, the icon for a hardware status error
is displayed.

4-5

4. CHECKING THE HARDWARE STATUS

Figures 4-2 and 4-3 show examples of displaying the description of an icon when the
hardware status of this equipment is normal and when the hardware status has an error.

Figure 4-2

Example of Displaying the Description of an Icon (When the Hardware
Status is Normal)

Figure 4-3

Example of Displaying the Description of an Icon (When the Hardware
Status Has an Error)(2) Menu of the hardware status icon
If you right-click the icon, a popup menu is displayed.

Right-click the icon to display a
popup menu.

Figure 4-4 Menu of the Hardware Status Iconz Display Hardware status
Click it to display the Hardware status window.
z Undisplay the icon
Click it to delete the icon from the notification area of the taskbar.

4-6

4. CHECKING THE HARDWARE STATUS

4.1.3 Hardware status window
The Hardware status window shows the details of the hardware status of this equipment.
Figure 4-5 shows how to start the Hardware status window.

2. The Hardware status window opens.

Notification area of the taskbar

1. Double-click the hardware status icon.
Alternately, right-click the icon to display a popup menu
and click “Display hardware status” on the menu.

Figure 4-5 Starting the Hardware Status Window

4-7

4. CHECKING THE HARDWARE STATUS(1) Description of the window
1. Fan condition
Shows the current status of the fans.
Table 4-2
Fan condition

Fan Condition and Displayed Information
Icon

Information

NormalFan is working normally.

Excessively low rotation
speed

Fan failure is detected.
For details, refer to the event log.

2. Temperature condition
Shows the current status of the temperature inside the chassis.
Table 4-3 Temperature Condition and Displayed Information
Temperature status

Icon

Information

NormalPresent temperature is normal.

Abnormally hightemperature

Temperature in the unit has exceeded theupper limit.

4-8

4. CHECKING THE HARDWARE STATUS

3. Drive condition
Shows the current status of the drives. In the following areas, the drive conditions ofdrive bay1 and 2 are displayed.
Table 4-4 Drive Condition and Displayed Information
No.
1

2
3
4

5

Drive condition
If SMART
monitoringis enabled
NormalIf SMART
monitoringis disabled89Information
Healthy.

SMART is not available.

Failure anticipation by
SMART

Drive
usage
excess

6

7

Icon

Error

A failure may be imminent.

If SMART
monitoringis enabled
If SMART
monitoringis disabled

Used hours exceeded prescribed value.

Used hours exceeded prescribed value.

The drive isoffline.

OFFLINE.

The driveis being
rebuilt.

REBUILD.

Unknown

Unknown.

Not mounted

Not Connected.

Nos. 6 through 8: These descriptions apply to D Model only.
No. 9: This description does not apply to D Model.

NOTICE
When failure of a drive is anticipated by SMART, the drive may experiencehardware failure in near future. We recommend you to back up the data andreplace the drive.
4. Drive used hours
The drive used hours (cumulative hours up to date) is displayed. The value of the
cumulative hours is updated every hour between 0 and 100 hours and every ten hours
after that. The range of the cumulative hours that can be displayed is between 0 and99990 (hours). If the drive usage monitoring is disabled, the drive used hours cannot
be displayed.

4-9

4. CHECKING THE HARDWARE STATUS

5. RAID status [D Model only]
The RAID status is displayed.
Table 4-5 RAID Status and Displayed Information

No.
1
2
3
4
5

RAID status
Detailed
information
Normal––Displayed information[Optimal][Optimal (Media Error)][Degrade][Degrade (Media Error)][Degrade (Rebuild: xx%)]

DegradedRebuild

6
7

Fail

–

8

Unknown –[Degrade (Rebuild: xx%,Media Error)][Fail]

Note

Media error occurs.

xx: Progress of the rebuild
process
xx: Progress of the rebuild
process
Media error occurs.
The system has stopped. Thismessage may not be displayed.

[Unknown]

6. Refresh button
If you click this button, the latest hardware status is acquired and the information in
the window is refreshed.
7. OK button
Click this button to close the Hardware status window.
Figure 4-6 shows an example of the Hardware status window (D model) when a hardware
error is detected.

Figure 4-6

Hardware Status Window (Error Case)

4-10

4. CHECKING THE HARDWARE STATUS

4.2 RAS Event Notification
4.2.1 Overview
When an event that must be reported to a user such as hardware failure occurs, this function
notifies the event to an application by setting an event object to the signaled state.
An application can detect an event such as hardware failure by monitoring when the event
object is set to the signaled state.
The event object is reset to the nonsignaled state when the cause of the event is cleared.
4.2.2 Detecting an event
Follow the procedure below to detect an event:
1. Use the OpenEvent Windows API function to get the handle to the event object.
Specify SYNCHRONIZE for the parameter dwDesiredAccess (the access to the event
object).
2. Use the WaitForSingleObject or WaitForMultipleObject Windows API function tomonitor when the event object is set to the signaled state.
Table 4-6 is a list of events to be reported to a user and their respective event objects.
Table 4-6 Reported Events
No.
Event
Event object name
1 A case fan failure occurred.
HFB_CSFAN_ERR_EVENT
2 A CPU fan failure occurred.
HFB_CPUFAN_ERR_EVENT
The temperature inside the chassis became
3
HFB_TEMP_ERR_EVENT
abnormal.
4 SMART anticipated failure in one of the drives.
HFB_HDD_PREDICT_EVENT
The power-on (=used) hours exceeded the5
HFB_HDD_OVERRUN_EVENT
threshold in one of the drives.
6 The RAID status is normal.
HFB_RAID_OPTIMAL_EVENT
7 The RAID status is not normal.
HFB_RAID_DEGRADE_EVENT
No. 4: This includes the case that getting the failure prediction status of the drive fails.
Nos. 6 and 7: Apply to D Model only.
No.7: This includes the case that a media error is enabled and notified.

NOTE
When you use an event object in a program, you need to add “Global\” to thebeginning of the name of the event object.
4.2.3 Example of using event objects
We provide a sample program in C (FanErr.c) to show how to monitor event objects. For
information about the name of the sample program and where you can find it, see “6.2
Sample Programs”.

4-11

4. CHECKING THE HARDWARE STATUS

4.3

Popup Notification

4.3.1 Overview
When an event that must be reported to a user such as hardware failure occurred, thisfunction notifies the event to a user by displaying a popup message on the desktop. Using
this function, a user can know an event such as hardware failure occurred.
More specifically, a popup message is displayed in the following cases:z A fan failure occurred.
z The temperature inside the chassis becomes abnormal.
z SMART anticipates drive failure.
z The drive power-on (=used) hours exceeded the threshold.
z RAID error is detected. (D Model only)
Figure 4-7 shows an example of popup message notification when a power fan failure has
occurred.

Click the Close button [×]to close the window.

Click OK to close the window.

Figure 4-7

Example of Popup Message

4-12

4. CHECKING THE HARDWARE STATUS

4.3.2

Messages to be displayed
The following table shows a list of popup notification messages this function outputs.
It should be noted that you can edit those messages. For information about how to edit
messages, see “3.1.4 Editing popup notification messages”.
Table 4-7 Messages Displayed

No.
Event
1 A case fan failure occurs.
2 A CPU fan failure occurs.
The temperature inside the chassis
3
becomes abnormal.

Popup notification message
Revolutions of fan at case deteriorated remarkably.
Revolutions of CPU fan deteriorated remarkably.
Temperature exceeded prescribed value.

A failure may be imminent on the drive of the drive
bay%1.
The value of the drive power-on
Used hours on the drive of the drive bay%1 exceeded5(=used) hours exceeds the threshold. prescribed value.
6 A RAID error occurs.
RAID status is DEGRADE. (Drive bay%1)
Nos. 4, 5, and 6: %1 denotes the drive bay number.
No.4: This includes the case that getting the failure prediction status of the drive fails.
No.6: Supported only by D Model only.
4

4.3.3

SMART anticipates drive failure.

Popup notification settings
This function can be enabled or disabled in the RAS Setup window. In the default factoryshipped setting, this function is disabled. If this function is disabled, popup messages are notdisplayed.
For details, see “3.1.3 Using the RAS Setup window”.

4-13

4. CHECKING THE HARDWARE STATUS

4.4

Status Display Digital LEDs Function

4.4.1 Overview
When an event that must be reported to a user such as hardware failure occurs, this function
notifies the event to a user by displaying a status code on the status display digital LEDs
located on the front of this equipment. Using this function, a user can know an event such as
hardware failure occurred.
In addition, a user application can output any status code on the status display digital LEDs
by using library functions. The LED output consists of 2-digit hexadecimal code and statusindication LEDs.

The system status is displayedin two-digit hexadecimal code.

Status indication LEDs①②①: RAS status②: Application status③: BIOS status③

Figure 4-8

Status Display Digital LEDs

4-14

4. CHECKING THE HARDWARE STATUS

4.4.2

Codes to be displayed(1) Hardware status code
A hardware status code is displayed when an error has occurred in the hardware status of
this equipment. If the hardware status is normal, a hardware status code is not displayed.
When a hardware status code is displayed, the leftmost LED in the status indication
LEDs is lit.
[If hardware status is normal][If hardware status is not normal]

Off

Figure 4-9

On

Hardware Status Code

Table 4-8 shows a list of hardware status codes.
Table 4-8 Hardware Status Codes
No. Status code
Cause
Priority1
11Case fan failure
2
2
12
CPU fan failure
321
The temperature inside the chassis becomes abnormal.
3
4
31
A failure is anticipated for the drive on drive bay1.
4
5
32
A failure is anticipated for the drive on drive bay2.
6
41
Drive bay1 is offline.
742
Drive bay2 is offline.
84b
RAID is in a fail status.
1
94c
RAID is in an unknown status.
104dMedia error on RAID
Nos. 6 through 10: Those status codes are displayed for D Model only.
No.8: When the RAID is in a fail status, the system cannot operate normally, and “4b”
may not be displayed.
No.10: This code is displayed if media error is configured to be reported as an error.

If multiple failures occur at the same time, the status code with the highest priority (codewith the smallest value in the Priority column in Table 4-8) is displayed. If multiple
failures with the same priority occur at the same time, the status code of the last detected
failure is displayed.

4-15

4. CHECKING THE HARDWARE STATUS(2) Application status code
An application status code is displayed by a user application by using library functions
provided by this function.
When an application status code is displayed, the center LED in the status indication
LEDs is lit.

On

Figure 4-10

Application Status Code

4-16

4. CHECKING THE HARDWARE STATUS(3) Timeout code
The timeout code is an error code that is displayed when a watchdog timer timeout
occurs. The timeout code is displayed only if “Not reset” is selected for Action attimeout under Watchdog timer setting in the RAS Setup window. The timeout code isdisplayed as flashing “88” regardless of the status display mode. For information about
the status display modes, see “4.4.3 Status display modes”.

Figure 4-11

Timeout CodeNOTEThe ON/OFF statuses of the status indication LEDs do not change before andafter the timeout code is displayed. For example, if an application status code isdisplayed before the timeout code is displayed, the center status indication LED
remains on.

NOTICE
If you select “Retriggered by application program” under Watchdog timer
setting and “Not reset” for Action at timeout in the RAS Setup window, set thestatus display digital LEDs to the application status display mode so that thestatus code is not displayed there. Otherwise, the timeout code may beoverwritten by the status code and may not be able to be checked.

4-17

4. CHECKING THE HARDWARE STATUS(4) STOP error code
The STOP error code “80” is displayed when a STOP error (blue screen) has occurred
during system operation for some reason. Regardless of the status display mode, “80” isdisplayed with higher priority than the timeout code. For information about the status
display modes, see “4.4.3 Status display modes”.
When the STOP error code is displayed, all LEDs in the status indication LEDs are lit.

On

Figure 4-12 STOP Error CodeFor information about the priority of displaying each code, see “4.4.4 Priorities ofdisplayed codes”.

4-18

4. CHECKING THE HARDWARE STATUS

4.4.3

Status display modes
This function has two display modes: “hardware status display mode” and “application
status display mode”.
Table 4-9 Status Display Modes
Status display mode
Hardware status display mode

Application status display mode

Description
When the hardware status is normal, an application status
code is displayed. When the hardware status has an error, ahardware status code has the higher priority to be displayed.
Only an application code is displayed.
Even when the hardware status has an error, the hardware
status code is not displayed.

The status display mode can be configured in the RAS Setup window. The default factoryshipped setting is the hardware status display mode.
For information about how to use the RAS Setup window, see “3.1.3 Using the RAS
Setup window”.
Note that if the hardware status is normal and there is no application status code to display,
the status display digital LEDs are all off.
Figure 4-13 shows an example of what is displayed in the hardware status display mode.
Dotted lines in Figure 4-13 denote the respective display modes, and the thick line denotes
the transition of the state of the status display digital LEDs.
Recovery from
hardware error

Recovery from
hardware error
Hardware status
code is displayed

Hardwareerror occurs

Hardwareerror occurs

Application status
code is displayed

User application
stops using the LEDs

Status display
digital LED is off
User application
starts using the LEDs

Figure 4-13

LEDs arerequested byuser applications

Example of a Status Display Mode

4-19

Time ->

4. CHECKING THE HARDWARE STATUS

4.4.4

Priorities of displayed codes
The following shows the priorities of the codes displayed by this feature.
(1) In the hardware status display mode
Code class
Priority order
STOP error code
1
Timeout codeor2
Status code (*1)(*1) Hardware status code or application status code

• STOP error code has the highest priority.
• Between the timeout code and a status code, the one that occurs later has precedence.
• The priority of a hardware status code differs depending on its cause. For details, see“4.4.2 Codes to be displayed”.
(2) In the application status display mode.
Code class
STOP error code
Timeout codeor
Status code (*2)(*2) Application status code

Priority order
1
2• STOP error code has the highest priority.
• Between the timeout code and a status code, the one that occurs later has precedence.
4.4.5

Status display digital LEDs control functions
The functions shown in Table 4-11 are offered as library functions for controlling the status
display digital LEDs. For details about the library functions, see “6.1 RAS Library
Interface”.
z Display an application status code: Use the SetStCode7seg function.
z Turns off the currently displayed application status code: Use the TurnOff7seg function.
z Sets the status display mode: Use the SetMode7seg function.

4-20

4. CHECKING THE HARDWARE STATUS

4.5 Remote Notification
4.5.1 Overview
If you use this function, from a remote device through the network, you can check hardware
conditions that can only be checked beside this equipment without this function. Even when
hardware conditions cannot be checked beside this equipment because, for example, thesystem administrator is away from this equipment or this equipment is built into the facility,
the hardware conditions can be checked from a remote device.
This function uses Simple Network Management Protocol (SNMP) to notify hardware
conditions. This allows you to use commercially available network management softwarethat supports SNMP and to monitor distributed instances of this equipment and otherdevices all from one location.
NOTE• The remote notification uses SNMP, a protocol in the application layer of the
TCP/IP, and User Datagram Protocol (UDP) in the transport layer. Thatmeans if the network load is high, hardware conditions may not be received
properly.
• The remote notification uses the SNMP service, a standard feature ofWindows®. For information about how to enable the standard Windows®
SNMP service, see “4.5.3 Enabling the remote notification”.

4-21

4. CHECKING THE HARDWARE STATUS

4.5.2 Hardware conditions that can be acquired by using remote notification
The following hardware conditions and settings can be acquired from a remote device:• Fan condition• Temperature condition inside the chassis• Drive condition• RAID status (D Model only)• RAS function settings• Operational mode (normal mode)• Version information of the extended Management Information Base (MIB) for HF-BX.
The following transitions of the hardware conditions are notified by using a trap.
(1) Fan condition• Normal → Error• Error → Normal(2) Temperature condition inside the chassis• Normal → Error• Error → Normal(3) Drive condition• Normal → Failure anticipated• Normal → Used hours exceeded the threshold(4) RAID status (D Model only)• Optimal → Error (Degrade, Unknown, or Fail)• Error (Degrade, Unknown, or Fail) → Optimal(5) Operational mode
• HF-BX stopped → Started in normal mode
• Running in normal mode → Running in simulation mode

4-22

4. CHECKING THE HARDWARE STATUS

4.5.3 Enabling the remote notification
This function is disabled in the default factory-shipped settings. The remote notification uses
the standard Windows® SNMP service. If you enable the SNMP service, the remotenotification is enabled.
When you use the remote notification, follow the procedure below to enable the SNMP
service:(1) Starting the “SNMP Service Properties” window
1. If you are not logged on to the computer as an administrator, log on to the computer as
an administrator.
2. Follow the procedure below to start the Services window.
• Click Start and then Control Panel.
• Double-click System and Security > Administrative Tools > Services.
• If you see the “User Account Control” window, click Yes.
3. Double-click SNMP Service to start the “SNMP Service Properties” window.

4-23

4. CHECKING THE HARDWARE STATUS(2) SNMP security configuration
1. In the “SNMP Service Properties” window, select the Security tab.

2. If you want to send a trap message whenever authentication fails, select the “Sendauthentication trap” check box.
3. Under “Accepted community names,” click Add. The “SNMP Service
Configuration” window is displayed. In the “Community rights” list, select READ
ONLY. In the Community Name box, type the community name you want, and clickAdd.

4. Specify whether to accept SNMP packets from hosts.
If you want to accept SNMP packets from any manager on the network:• Select Accept SNMP packets from any host.
If you want to restrict SNMP packets:• Select Accept SNMP packets from these hosts.
• Click Add.
• The “SNMP Service Configuration” window is displayed. Enter the host name, IP
or IPX address of a host you want to accept the SNMP packets from, and click Add.

5. In the “SNMP Service Properties” window, click Apply.

4-24

4. CHECKING THE HARDWARE STATUS(3) SNMP trap configuration
1. In the “SNMP Service Properties” window, select the Traps tab.

2. Under Community name, type the name of the community that trap messages aresent to, and click “Add to list.”
3. Under Trap destinations, click Add. The “SNMP Service Configuration” window
is displayed. Enter the host name, IP or IPX address of a destination you want to send
traps to, and click Add.

4. In the “SNMP Service Properties” window, click Apply.

4-25

4. CHECKING THE HARDWARE STATUS(4) Starting the SNMP service
1. In the “SNMP Services Properties” window, select the General tab.

2. Click Start. The SNMP service starts and the remote notification for the hardware
status is enabled.
3. In order to start the SNMP service automatically at the next OS startup, in the Startup
type list, select Automatic.
4. In the “SNMP Service Properties” window, click OK.
NOTE• If when the SNMP starts, there is an error that is configured to be notified byusing a trap, the trap is sent at the timing when the SNMP starts.
• If Windows Firewall is configured to block the SNMP service, you cannot
acquire the hardware status from a remote device.
SNMP service can pass through Windows Firewall by default, and you do nothave to go through the following procedure. But if you set up the firewall toblock SNMP service, follow the procedure below to undo it.
1. If you are not logged on to the computer as an administrator, log on to thecomputer as an administrator.
2. Click Start and then click Control Panel. Click “System and Security.”
3. Under Windows Firewall, click “Allow a program through Windows
Firewall.”
4. If you see the “User Account Control” window, click Yes.

4-26

4. CHECKING THE HARDWARE STATUS

5. The “Allowed Programs” window appears. Click Change settings, andunder “Allowed programs and features,” select the “SNMP Service”
check box.

6. Click OK.

4-27

4. CHECKING THE HARDWARE STATUS

4.5.4 Objects in the extended MIB for HF-BX
In order to acquire the hardware status of this equipment from a remote device, use theextended MIB for HF-BX. Note that the extended MIB for HF-BX is the same MIB as theextended MIB for HF-W offered for the HITACHI INDUSTRIAL COMPUTER HF-W
series. This subsection provides a list of objects defined in the extended MIB for HF-BX
and a description of those objects.
(1) Objects related to the hardware conditions and settings
Table 4-10 shows a list of the objects related to the hardware status and a description of
those objects. The object ID of each object is obtained by either replacing the following“x” with the object in the following table or replacing the following “y” with the object
number in the table.
Object ID: .iso.org.dod.internet.private.enterprises.Hitachi.systemExMib.
hfwExMib.hfwRasStatus.x (x is an object in the table below)or.1.3.6.1.4.1.116.5.45.1.y (y is an object number in the table below)

Table 4-10 Objects Related to the Hardware Status
(1/2)
No.

ObjectnumberObjectDescription

1

hfwFan1

2

hfwFan.fanNumber

1.1

3

hfwFan.fanTable.fanEntry.fanIndex

1.2.1.1

Fan condition group
The number of monitoredfans
Index number of fanEntry

4

hfwFan.fanTable.fanEntry.fanName

1.2.1.2

Fan name

5

hfwFan.fanTable.fanEntry.fanStatus

1.2.1.3

Fan condition

6

hfwTemp2

7

hfwTemp.tempNumber

2.1

8

hfwTemp.tempTable.TempEntry.tempIndex

2.2.1.1

9

hfwTemp.tempTable.TempEntry.tempName

2.2.1.2

10

hfwTemp.tempTable.TempEntry.tempStatus

2.2.1.3

11

hfwHdd3

12

hfwHdd.hddNumber

3.1

13

hfwHdd.hddTable.hddEntry.hddIndex

3.2.1.1

Drive condition
group
Number of monitored drivebays
Index number of hddEntry

14

hfwHdd.hddTable.hddEntry.hddStatus

3.2.1.2

Drive condition

Temperature condition
group
Number of monitored
temperatures
Index number of tempEntry
Name of the temperature tobemonitored
Temperature condition

4-28

Description of the values–––
CS fan: Case fan
CPU fan: CPU fan
1: Normal
2: Error–––Internal temperature:
Temperature inside the chassis
1: Normal
2: Error–––
1: Healthy
2: Not mounted
3: Failure anticipated
5: Used hours exceeded thethreshold
7: Offline
8: Rebuild
99: Unknown4. CHECKING THE HARDWARE STATUS

(2/2)
No.

ObjectObjectnumberDescription

15

hfwHdd.hddTable.hddEntry.hddUseTime

3.2.1.3

16
17
18

hfwRaidhfwRaid.raidNumber
hfwRaid.raidTable.raidEntry.raidIndex

4
4.1
4.2.1.1

Drive power-on (=used)hours(in hours)
RAID status group
Number of monitored arrays
Index number of raidEntry

19

hfwRaid.raidTable.raidEntry.raidStatus

4.2.1.2

RAID status20

hfwRaid.raidTable.raidEntry.raidLevel

4.2.1.3

21

hfwRaid.raidTable.raidEntry.raidProgress

4.2.1.4

22

hfwRaid.raidTable.raidEntry.raidMediaError

4.2.1.5

RAID level
Progress of the rebuild
process (in %)Whether media error
occurred

Description of the values––––
1: Optimal
2: Degrade
4: Unknown
5: Fail
1: RAID1–
1: No media error occurred.
2: Media error occurred.

No.2: For this equipment, the value is set to 2.
No.7: For this equipment, the value is set to 1.
No.12: The number of internal drives that can be mounted in the HF-BX is set for the number of monitored drive bays.
For this equipment, the number is 2.
No.17: For A Model, the value is set to 0.
Nos. 18 to 22: Supported by D Model only. For A Model, the value is not set.

4-29

4. CHECKING THE HARDWARE STATUS

Table 4-11 shows a list of the objects related to the RAS function settings and a
description of those objects. The object ID of each object is obtained by either replacing
the following “x” with the object in the following table or replacing the following “y”
with the object number in the table.
Object ID: .iso.org.dod.internet.private.enterprises.Hitachi.systemExMib.
hfwExMib.hfwRasSetting.x (x is an object in the table below)or.1.3.6.1.4.1.116.5.45.2.y (y is an object number in the table below)

Table 4-11

Objects Related to the RAS Function Settings
ObjectnumberNo.

ObjectDescription

1

hfwFanAutoShutdown

1

Automatic shutdown when a fan failure occurred2

hfwTempAutoShutdown

2

Automatic shutdown when the temperature isabnormal3

hfwSmartEnableSetting

4

Drive Failure Prediction (SMART monitoring)

Description of thevalues1: Enabled
2: Disabled
1: Enabled
2: Disabled
1: Enabled
2: Disabled

Table 4-12 shows a list of the objects related to operational modes and a description of
those objects. The object ID of each object is obtained by either replacing the following“x” with the object in the following table or replacing the following “y” with the object
number in the table.
Object ID: .iso.org.dod.internet.private.enterprises.Hitachi.systemExMib.
hfwExMib.hfwRasInfo.x (x is an object in the table below)or.1.3.6.1.4.1.116.5.45.3.y (y is an object number in the table below)

Table 4-12 Objects Related to Operational Modes
No.
1

ObjecthfwRasMode

Objectnumber
1

Description
Operation mode

4-30

Description of the values
1: Normal mode
2: Simulation mode

4. CHECKING THE HARDWARE STATUS

Table 4-13 shows a list of the objects related to the version information of the extended
MIB for HF-BX and a description of those objects. The object ID of each object isobtained by either replacing the following “x” with the object in the following table orreplacing the following “y” with the object number in the table.
Object ID: .iso.org.dod.internet.private.enterprises.Hitachi.system.
hfw.hfwExMibInfo.x (x is an object in the table below)or.1.3.6.1.4.1.116.3.45.1.y (y is an object number in the table below)

Table 4-13 Objects Related to the Extended MIB for HF-BX
No.
1
2

ObjectVersion
RevisionObjectnumber1
3

Description
Version number of the extended MIB for HF-BX
Revision number of the extended MIB for HF-BX

4-31

Description of thevalues––4. CHECKING THE HARDWARE STATUS(2) Objects related to the trap notification
Table 4-14 shows a list of the objects related to the trap notification when an error occurs
as well as a description and notification data for those objects. The enterprise ID for thetrap notification when an error occurs is as follows.
Enterprise ID: iso.org.dod.internet.private.enterprises.Hitachi.systemAP.
hfwMibTrap.hfwRasErrorTrap
or.1.3.6.1.4.1.116.7.45.1

Table 4-14 Objects Related to the Trap Notification (When an Error Occurs)
No.

ObjectTrap
number

hfwFanError
1

A fan failure occurs.
1

hfwTempError232

hddIndex3

A failure is
anticipated for thedrive.

The drive power-on(=used) hours
exceeded thethreshold.

hddIndex

hfwHddOverRun
44

hfwArrayError

Notification data
Object used
fanNamefanStatus
hfwFanStMsg
tempName
tempStatus
hfwTempStMsg

The temperatureinside the chassis
becomes abnormal.

hfwSmartDetect

5

Description

7

hddStatus
hfwSmartStMsg

hddStatus
hfwHddUseTimeStMsg

A RAID error occurs. raidIndex
hfwArrayStMsg

Value
Name of the failed fan
2: Error
Revolution of %1 deteriorated remarkably.
Internal temperature
2: ErrorInternal temperature exceeded prescribedvalue.
The drive bay number of the drive
for which a failure is anticipated by SMART
3: Failure anticipated
A failure may be imminent on the drive ofthe drive bay%2.
The drive bay number of the drive for which
the power-on hours exceeded the threshold
5: Used hours exceeded the threshold.
Used hours on the drive of the drive bay%2
exceeded prescribed value.
1
An error occurred on Array%4.

No.1: %1 denotes the name of the failed fan.
Nos. 3 and 4: %2 denotes the drive bay number.
No.5: %4 denotes the number of the array with an error. For this equipment, the array number is always 1.

4-32

4. CHECKING THE HARDWARE STATUS

Table 4-15 shows a list of the objects related to the trap notification when the equipment
has recovered from an error and a description of those objects. The enterprise ID for thetrap notification when the equipment has recovered from an error is as follows.
Enterprise ID: iso.org.dod.internet.private.enterprises.Hitachi.systemAP.
hfwMibTrap.hfwRasRecoverTrap
or.1.3.6.1.4.1.116.7.45.2

Table 4-15 Objects Related to the Trap Notification (When the Equipment has Recoveredfrom an Error)
No.

ObjectTrap
number

hfwFanRecover1

1
hfwTempRecover2

3

2
hfwArrayRecoverNotification data

Description

Object used
Recovery from fan
fanNamefailurefanStatus
hfwFanStMsg
Recovery from
tempNameabnormal temperature tempStatus
in the chassis
hfwTempStMsg
Recovery from RAID raidIndex
error
hfwArrayStMsg

7

Value
Name of the recovered fan
1: Normal
Revolutions of %1 returned to normal value.
Internal temperature
1: Normal
Internal temperature returned to prescribedvalue.
1
Array%3 is restored.

No.1: %1 denotes the name of the recovered fan.
No.3: %3 denotes the number of the array that recovered from an error. For this equipment, the array number is always 1.

Table 4-16 shows a list of the objects related to the trap notification when the equipment
has started in normal mode and a description of those objects. The enterprise ID for thetrap notification related to operational modes is as follows.
Enterprise ID: iso.org.dod.internet.private.enterprises.Hitachi.systemAP.
hfwMibTrap.hfwRasInfoTrap
or.1.3.6.1.4.1.116.7.45.3

Table 4-16 Objects Related to the Trap Notification (Operational Modes)
No.

ObjectTrap
number1

hfwRasService
Started1

2

hfwSimulation
ModeStarted

2

Notification data

Description

Object used
Startup in normal mode hfwRasMode
hfwRasStartMsg
Transition to simulation hfwRasModemode
hfwRasStartMsg

4-33

Value
1: Normal mode
RAS Service is running.
2: Simulation mode
RAS Service switched to Simulation
Mode.

4. CHECKING THE HARDWARE STATUS

4.5.5 Extended MIB file for HF-BX
The extended MIB file for HF-BX is as follows.
Extended MIB file for HF-BX: %ProgramFiles%\HFWRAS\mib\hfwExMib.mib

4-34

4. CHECKING THE HARDWARE STATUS

4.6

Status Acquisition by Using the RAS Library
By using the RAS library functions, the following hardware conditions can be acquired. For
details about the library functions, see “6.1 RAS Library Interface”.
z To acquire the drive condition: Use the hfbDiskStat function.
z To acquire the RAID status: Use the hfbRaidStat function.

4-35

This Page Intentionally Left Blank

5. CONTROLLING THE HARDWARE

CHAPTER 5 CONTROLLING THE HARDWARE
The RAS feature can have the following controls over this equipment.
(1) Automatic shutdown of the equipment
When a hardware error occurs or a remote shutdown request through the contact input isdetected, the equipment can be automatically shut down. For details, see “5.1 Automatic
Shutdown and System Reset of the Equipment”.
(2) System reset of the equipment
When a watchdog timer timeout occurs, a system reset can be performed. For details, see “5.1
Automatic Shutdown and System Reset of the Equipment”.
(3) Memory dump of the equipment
When a watchdog timer timeout occurs, a memory dump can be generated. For details, see “5.1
Automatic Shutdown and System Reset of the Equipment”.
(4) Controlling the hardware by using the RAS library
A user application can control the hardware of this equipment by using the RAS library. For
details, see “5.2 Controlling the Hardware by Using the RAS Library”.
(5) The RAID status display and control using the RAID configuration control command
The status of a drive in the RAID can be displayed. You can also configure whether to notify amedia error. For details, see “5.3 RAID Configuration Control Command (raidctrl) [D Modelonly]”.

5-1

5. CONTROLLING THE HARDWARE

5.1

Automatic Shutdown and System Reset of the Equipment
This function automatically shuts down the equipment when running the equipment would
pose a danger when fan failure or abnormally high temperature is detected. By doing so, you
can protect internal parts such as a processor from thermal degradation and prevent thermal
runaway of the system due to malfunction of this equipment. The equipment can be also
automatically shut down by a remote shutdown request input from an external device. In
addition, you can perform a system reset on the equipment or generate a memory dump whena watchdog timer timeout in the equipment is detected.

5.1.1 Automatic shutdown when detecting fan failure
When the equipment detects an error in one of the fans, the equipment automatically shuts
down.
• This function can be enabled or disabled in the RAS Setup window. In the default factoryshipped setting, this function is enabled. For details, see “3.1.3 Using the RAS Setup
window”.
• After an automatic shutdown initiated by this function is complete, the power is turned off.
• Alternatively; a user application can detect a fan failure using a RAS event and shut down
the equipment. For information about a RAS event, see “4.2 RAS Event Notification”.

NOTICEz If this equipment continues to operate with fan failure detected, internal parts
such as a processor are not cooled down sufficiently, and that may cause
thermal runaway of the system due to malfunction of the equipment or result indamage to the parts. If possible, enable the automatic shutdown feature.
z If the automatic shutdown feature is not used, have a user application detect a
fan failure using a RAS event and shut down the equipment.
NOTE
For information about how to replace a fan, refer to “HF-BX1000/1200
INSTRUCTION MANUAL (manual number BX-62-0001)”.

5-2

5. CONTROLLING THE HARDWARE

5.1.2 Automatic shutdown when detecting abnormally high temperature
When the temperature sensor in this equipment detects the temperature is abnormally highinside the chassis, the equipment automatically shuts down.
• This function can be enabled or disabled in the RAS Setup window. In the default factory
setting, this function is disabled. For details, see “3.1.3 Using the RAS Setup window”.
• After an automatic shutdown initiated by this function is complete, the power is turned off.
• Alternatively; a user application can detect abnormally high temperature using a RAS
event and shut down the equipment. For information about a RAS event, see “4.2 RAS
Event Notification”.
NOTE• If the temperature inside the chassis is high, parts can be degraded rapidly
due to heat. Then it is not advisable to continue to use this equipment also interms of the life span of the components inside. On the other hand, if thetemperature is abnormally high when the fans are working properly, theabnormally high temperature must be caused by an external factor such as
malfunctioning air conditioning at the location of the equipment. You canisolate the cause of the abnormally high temperature while the equipment isrunning. Because of this, this function is disabled in the default factoryshipped setting,• If you continue to operate this equipment after abnormally high temperature is
detected and the temperature further rises to a dangerous level, theequipment is forcibly shut down and the power is turned off regardless ofwhether this function is disabled.
5.1.3 Automatic shutdown when a remote shutdown request through the contact input is detected
This equipment is automatically shut down when the remote shutdown contact (RMTSTDN
contact) in the RAS external contacts interface is closed. By using this function, you canshut down this equipment from a remote location.
• After an automatic shutdown initiated by this function is complete, the power is turned off.
5.1.4 System reset due to timeout detection
The system resets when a watchdog timer timeout in the equipment is detected.
• In the RAS Setup window, you can configure whether to enable a system reset using thisfeature. For details, see “(2) Watchdog timer setting” in “3.1.3 Using the RAS Setup
window”.
• If the system is reset by this feature, the equipment is automatically restarted.
5.1.5 Memory dump due to timeout detection
A memory dump is generated when a watchdog timer timeout in the equipment is detected.
• In the RAS Setup window, you can configure whether to enable memory dump using thisfeature. For details, see “(2) Watchdog timer setting” in “3.1.3 Using the RAS Setup
window”.
• If a memory dump is generated by this feature, the equipment is automatically restarted.
The STOP error code when a memory dump is generated is as follow.
• STOP error code: 0x00009222

5-3

5. CONTROLLING THE HARDWARE

NOTE• A memory dump may not be generated depending on the situation, forexample, when Windows stops responding due to an interrupt with a highinterrupt request level (IRQL).

5-4

5. CONTROLLING THE HARDWARE

5.2 Controlling the Hardware by Using the RAS Library
By using the RAS library functions, you can shut down the system and the status display
digital LEDs. For details about the library functions, see “6.1 RAS Library Interface”.
z To shut down the system: Use the BSSysShut function.
z To control the watchdog timer: Use the WdtControl function.
z To control the general purpose external contact outputs: Use the GendoControlEx
functions.
z To control the general purpose external contact inputs: Use the GetGendiEx functions.
z To control the status display digital LEDs: Use the SetStCode7seg, TurnOff7seg, and
SetMode7seg functions.

5-5

5. CONTROLLING THE HARDWARE

5.3

RAID Configuration Control Command (raidctrl) [D Model only]
The raidctrl command shows the status of the RAID and its drives and configures the setting
for whether to notify a media error. The following shows how to use this command. This
command can be launched at the command prompt.
<Name>
raidctrl - RAID drive status display and configuration control, media error notification
setting update<Syntax>
raidctrl [/NOTIFY {ON|OFF} ]<Description of the function>
This command offers one of the following functions depending on the specified options.
• With no options: The status of the RAID and the drives in the RAID will be displayed.
• When /NOTIFY option is specified: The command configures the setting for whether tonotify when a media error is generated.
NOTE• You need to have administrator privileges to execute the following actions.
Log on to the computer using an administrator account to do so. If User
Account Control (UAC) is enabled, start the command prompt as anadministrator according to “APPENDIX A RUNNING COMMAND PROMPTAS AN ADMINISTRATOR”, and then execute the raidctrl command.
In addition, you cannot execute those actions from a remote session.
• Do not run multiple instances of this command at the same time.

5-6

5. CONTROLLING THE HARDWARE(1) Displaying the status of the RAID and its drives (with no options)If you execute the raidctrl command without any options, the command will output thestatus of the RAID and the drives in the RAID on this equipment. Tables 5-1 and 5-2 show
the status of the RAID and drives displayed in the output.
Table 5-1

RAID Status Displayed in the Output of the raidctrl CommandNo.
Displayed Status
Description
1 OPTIMALThe RAID is working properly.
2 DEGRADE
The RAID is being degraded.
3 DEGRADE (REBUILD xx%)
The RAID is under a rebuild process.
4 FAILThe RAID failed.
5 UNKNOWN
Unknown status
Nos.1 through 3: If a media error occurs, “MEDIA ERROR” is attached to the end of thedisplayed status.
(Example) If a media error occurs when the RAID is operating normally:
OPTIMAL (MEDIA ERROR)

Table 5-2 Drive Status Displayed in the Output of the raidctrl Command
No.
1
2
3
4

Displayed Status
ONLINEOFFLINEREBUILDUNKNOWN

Description
The drive is working properly.
The drive is disconnected from the RAID.
The RAID is under a rebuild (copy) process.
Unknown status

The following is an example of the output when the raidctrl command is executed without
options.
C:\>raidctrl
ARRAY STATUS
1
DEGRADEDRIVE STATUS
1
ONLINE2
OFFLINEC:\>

5-7

5. CONTROLLING THE HARDWARE(2) Configuring whether to notify a media error (with the /NOTIFY option)
If you execute the raidctrl command with /NOTIFY option, you can configure whether tonotify a media error.
You need to have administrator privileges to specify ON or OFF for this option andchange the setting. Log on to the computer using an administrator account and thenexecute the command. If you do not have administrator privileges when you run thecommand, an error message is displayed and the command exits.
If the /NOTIFY option is specified alone, the current notification setting is displayed.
In the default factory settings, a media error is not notified.
The following are examples of executing the command with the /NOTIFY option.
• To check the media error notification setting: raidctrl /NOTIFY
C:\ >raidctrl /NOTIFY
MEDIA ERROR Notify Setting:ON
C:\ >• If a media error is notified: raidctrl /NOTIFY ON• If a media error is not notified: raidctrl /NOTIFY OFF

5-8

5. CONTROLLING THE HARDWARE<Diagnosis>
When the raidctrl command finishes normally, it returns exit code 0.
If the command returns abnormally, one of the error messages listed in Table 5-3 isdisplayed, and the command returns an exit code other than 0.
Table 5-3 Error Messages of the raidctrl Command
No.
Error message
1 Usage:raidctrl [/NOTIFY [{ON|OFF}]]
2
3

4

5

6

Description
There is an error in the specified options.
Specify correct options.
Invalid argument. (%1)
Specified option %1 is not correct.
An error occurred in %1. errorcode
An unexpected error (%2) occurred in the function (%1).
= %2
Retry the command. If the same error message persists,
restart this equipment.
You do not have the privilege to execute You do not have administrator privileges.
this command option.
Log on to the computer using an administrator accountPlease execute this command option
and run the command again. If User Account Control
again on “Administrator: Command(UAC) is enabled, start the command prompt with
Prompt”.
administrator privileges and run the command.
Access denied.
You cannot use this command with this option from a
Log on console session,
remote session.
And execute this command option again Log on to a console session and run the command again.
on “Administrator: Command
If User Account Control (UAC) is enabled, start thePrompt”.
command prompt with administrator privileges and run
the command.
raidctrl: This function was executed on The command is executed on a model other than D
a non-RAID model.
Model.
This command can be executed on D Model only.

5-9

This Page Intentionally Left Blank

6. LIBRARY FUNCTIONSCHAPTER 6 LIBRARY FUNCTIONS
A user application can get and control the hardware status of this equipment by using the RAS
library.
For information about the hardware specifications of the RAS external contacts interface describedin this chapter and the usage of each contact, see “HF-BX1000/1200 INSTRUCTION MANUAL(manual number BX-62-0001)”.
6.1 RAS Library Interface
6.1.1 Overview
This chapter describes the interface to the functions provided by the RAS library.
Table 6-1 shows a list of RAS library functions.
Table 6-1 RAS Library Functions
No.
Function name
1 BSSysShut
2 WdtControl
3
4
5
6
7
8
9
10

Use

Shuts down the equipment.
Retriggers, gets the status of, and stops the watchdog timer.
Opens and closes the general purpose external contact outputs
GendoControlEx(GENDO0, GENDO1).
Gets the status of the general purpose external contact inputs
GetGendiEx(GENDI0, GENDI1).
Records a specified message (characters) in this equipment’s
MconWriteMessage
own log files.
hfbDiskStat
Acquires the status of the drive.
hfbRaidStat
Acquires the RAID status.
Outputs an application status code on the status display digital
SetStCode7seg
LEDs.
Clears an application status code on the status display digital
TurnOff7seg
LEDs.
Configures the status display mode of the status display digital
SetMode7seg
LEDs.

DLL
hfbras.dll

ctrl7seg.dll

Those functions mentioned above are offered in the DLLs (hfbras.dll and ctrl7seg.dll).
The functions offered by hfbras.dll and ctrl7seg.dll can be called from Visual Basic®. When
you call functions number 1 through 5 and 8 through 10 from Visual Basic®, add “_VB” tothe end of the name of each function. Function parameters are the same. For example, when
you call the WdtControl function from Visual Basic®, use the function name
“WdtControl_VB”.
The following files are provided as import libraries:%ProgramFiles%\HFWRAS\lib\hfbras.lib%ProgramFiles%\HFWRAS\lib\ctrl7seg.lib
When you use a library, link the corresponding import library.

6-1

6. LIBRARY FUNCTIONS

The following files are provided as header files for the libraries:%ProgramFiles%\HFWRAS\include\hfbras.h%ProgramFiles%\HFWRAS\include\ctrl7seg.h
When you use a library in C, include the corresponding header file.

6-2

6. LIBRARY FUNCTIONS

6.1.2

Shutdown function (BSSysShut)<Name>BSSysShut - System shutdown<Syntax>#include <hfbras.h>int BSSysShut(reboot)int reboot: /*Reboot flag*/<Description>
BSSysShut shuts down the system.
The reboot argument is used for specifying whether to reboot the system after the shutdown.
reboot = 0: The power to this equipment is turned off after the shutdown.
reboot ≠ 0: The system reboots after the shutdown.
<Diagnosis>
0: Successful completion (System shutdown process has started)
1: Shutdown privilege acquisition error
2: Internal error (OS shutdown failed)<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.

6-3

6. LIBRARY FUNCTIONS

6.1.3 Watchdog timer control function (WdtControl)<Name>
WdtControl - Watchdog timer control<Syntax>#include <hfbras.h>
BOOL WdtControl(DWORD dwCmd, PDWORD pdwCount);<Description>
This function performs the action specified by dwCmd on the watchdog timer.
In order to use this function, in the RAS Setup window, select Retriggered by application
program under Watchdog timer setting. If the watchdog timer setting is different, this function
terminates with an error. If you call the GetLastError Windows API function, an error code
HFB_WDT_NONMANUAL is returned.
Also, when you control the watchdog timer by using this function, call the function with theinterval of five seconds or more. If you have called the function without this interval, this function
terminates with an error. If you call the GetLastError Windows API function, an error code
ERROR_BUSY(0xAA) is returned.
Each parameter of this function is explained below.
dwCmd:
This parameter specifies which action is performed on the watchdog timer. The following
options are available for this parameter.
Table 6-2

List of Actions of WdtControl Specified by dwCmd

dwCmd
WDT_SET (0x00)
WDT_STOP (0x01)

Explanation of the action
Specifies the timeout (in seconds).
Stops the watchdog timer.

If a value other than the above is specified, this function terminates with an error. If you call the
GetLastError Windows API function, an error code HFB_INVALID_PARAMETER is
returned.
pdwCount:If dwCmd is WDT_SET, you can configure the timeout of the watchdog timer by specifying thetimeout of the watchdog timer in the variable pointed by pdwCount and calling this function.
Specify a value between 10 and 63 in seconds. If a value other than the above is specified, thisfunction terminates with an error. If you call the GetLastError Windows API function, an error
code HFB_INVALID_PARAMETER is returned.
When this function returns, the value of the variable pointed by pdwCount is undefined. Do not
use the value.
If dwCmd is WDT_STOP, the value of pdwCount is ignored. When this function returns, thevalue of the variable pointed by pdwCount is undefined. Do not use the value.

6-4

6. LIBRARY FUNCTIONS

NOTE• If you want to stop monitoring using the watchdog timer when a user program
exits or due to shutdown, you must stop the watchdog timer so that a timeout
does not occur.
• If you select “Reset” or “Memory dump” for Action at timeout under
Watchdog timer setting in the RAS Setup window, the time it takes togenerate timeout is longer than the timeout value set by the application. Thisis a correct operation.
This situation occurs because it takes about 1.2 to 1.3 seconds for the
hardware timer on this equipment to actually enable the timeout setting set by
the application. If the timeout is set to 30 seconds, reset or memory dump
starts about 31 seconds after the timeout is set.
<Diagnosis>
If this function completes successfully, the function returns TRUE. If this function terminates withan error, the function returns FALSE.
When this function terminates with an error, call the GetLastError Windows API function to get
the error code. Error codes returned by this function on its own are as follows.
Error code (value)
HFB_INVALID_PARAMETER(0x2001)
HFB_WDT_NONMANUAL(0x2002)
HFB_NOT_INITIALIZE(0x2005)
HFB_INTERNAL_ERROR(0x2007)

Description
There is an error in the specified parameters.
This function cannot be used because Retriggered byapplication program is not selected under Watchdog
timer setting in the RAS Setup window.
Startup of the RAS software has not completed yet.
An internal error has been generated.

Other error codes come from the Windows API functions used by this function. For details about
those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.
For information about how to monitor the operational state of a user program using the watchdog
timer, see “2.7.2 Using a watchdog timer for monitoring a user program”.

6-5

6. LIBRARY FUNCTIONS

6.1.4 Control functions for the general purpose external contact outputs (GendoControlEx)
Use the GendoControlEx functions to control the outputs to the general purpose external
contacts of the RAS external contacts interface.
<Name>
GendoControlEx - Output control for the general purpose external contacts (GENDO0, GENDO1)<Syntax>#include <hfbras.h>
BOOL GendoControlEx(DWORD dwPort, DWORD dwCmd);<Description>
This function performs the action specified by dwCmd on the general purpose external contact(GENDO0, GENDO1) of the RAS external contacts interface specified by dwPort.
Table 6-3 shows a list of actions that can be specified by dwPort.
Table 6-3

List of Actions of the GendoControlEx Function Specified by dwPort

dwPort
GENDO0_PORT (0x01)
GENDO1_PORT (0x02)

Explanation of the action
Performs the action on the general purpose external
contact (GENDO0).
Performs the action on the general purpose external
contact (GENDO1).

Table 6-4 shows a list of actions that can be specified by dwCmd.
Table 6-4

List of Actions of the GendoControlEx Function Specified by dwCmd

dwCmd
GENDO_OPEN (0x00)
GENDO_CLOSE (0x01)

Explanation of the action
Opens the general purpose external contact specified by
dwPort.
Closes the general purpose external contact specified by
dwPort.

If a value other than the above is specified, this function terminates with an error. If you call the
GetLastError Windows API function, an error code HFB_INVALID_PARAMETER is returned.

6-6

6. LIBRARY FUNCTIONS<Diagnosis>
If this function completes successfully, the function returns TRUE. If this function terminates withan error, the function returns FALSE.
When this function terminates with an error, call the GetLastError Windows API function to get
the error code. Error codes returned by this function on its own are as follows.
Error code (value)
HFB_INVALID_PARAMETER(0x2001)
HFB_NOT_INITIALIZE(0x2005)
HFB_INTERNAL_ERROR(0x2007)
HFB_NOT_SUPPORT(0x2008)

Description
There is an error in the specified parameters.
Startup of the RAS software has not completed yet.
An internal error has been generated.
This function is not supported in non-HF-BX.

Other error codes come from the Windows API functions used by this function. For details about
those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.

6-7

6. LIBRARY FUNCTIONS

6.1.5 Get functions for the general purpose external contact inputs (GetGendiEx)
Use the GetGendiEx functions to get the inputs for the general purpose external contacts of
the RAS external contacts interface.
<Name>
GetGendiEx - Status acquisition of the general purpose external contact inputs (GENDO0,
GENDO1)<Syntax>#include <hfbras.h>
BOOL GetGendiEx(DWORD dwPort);<Description>
This function gets the status of the general purpose external contact inputs (GENDI0, GENDI1) of
the RAS external contacts interface.
Table 6-5 shows a list of actions that can be specified by dwPort.
Table 6-5

List of Actions of the GetGendiEx Function Specified by dwPort

dwPortGENDI0_PORT (0x01)
GENDI1_PORT (0x02)

Explanation of the action
Gets the status of the general purpose external contact(GENDI0).
Gets the status of the general purpose external contact(GENDI1).

If a value other than the above is specified, this function terminates with an error. If you call the
GetLastError Windows API function, an error code HFB_INVALID_PARAMETER is returned.
<Return values>
1: The external contact specified by dwPort is closed.
0: The external contact specified by dwPort is open.
0xffffffff: The function terminates with an error.

6-8

6. LIBRARY FUNCTIONS<Diagnosis>
If this function terminates with an error, the function returns 0xffffffff.
When this function terminates with an error, call the GetLastError Windows API function to get
the error code. Error codes returned by this function on its own are as follows.
Error code (value)
HFB_INVALID_PARAMETER(0x2001)
HFB_NOT_INITIALIZE(0x2005)
HFB_INTERNAL_ERROR(0x2007)
HFB_NOT_SUPPORT(0x2008)

Description
There is an error in the specified parameters.
Startup of the RAS software has not completed yet.
An internal error has been generated.
This function is not supported in non-HF-BX.

Other error codes come from the Windows API functions used by this function. For details about
those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.

6-9

6. LIBRARY FUNCTIONS

6.1.6

Log function (MConWriteMessage)<Name>
MConWriteMessage - Logging<Syntax>#include <hfbras.h>
VOID WINAPI MConWriteMessage(LPSTR lpBuffer)；<Description>
The MConWriteMessage function writes the specified message (characters) to a log file (filename: hfwrasa.log or hfwrasb.log).
The message is written along with the time stamp.
Two log files are available and the size of each file is 64 KB. When the size of the log recorded in
the currently used log file exceeds 64 KB, the log file used for logging is switched to another log
file.
The parameters of this function are explained below.
lpBuffer:
This parameter specifies a pointer to a string that contains the message (characters) to be
written.
In order to easily identify the application that records each log entry, specify a message thatstarts with the name of the application, for example.
<Checking log information>
This function records log information in the text format in the following files.
• %ProgramFiles%\HFWRAS\log\hfwrasa.log• %ProgramFiles%\HFWRAS\log\hfwrasb.log
You can check log information by opening the files above using an text editor such as Notepad.
The format of log information is as follows.
YYYY/MM/DD hh:mm:ss - Specified log information
YYYY/MM/DD hh:mm:ss - Specified log information
YYYY/MM/DD hh:mm:ss - Specified log information:

Figure 6-1

YYYY: Year (in AD)
MM: Month
DD: Dayhh: Hour (24-hour clock)
mm: Minute
ss: Second

Format of Log Information

Initially, each of the above files is filled with EOF (ASCII code: 0x1a).

6-10

6. LIBRARY FUNCTIONS<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.

NOTICE
Log function exits (asynchronously) without waiting for the data to be actually
written to a log file. That means this function does not return an error even whenwriting to a log file fails for some reason. We recommend important information
be recorded in the OS event log.
NOTE
• In order to reduce the amount of resources used, this function, for example,
opens and closes a pipe every time the function is called. That means thisfunction has relatively large overhead. Even when you record multiple lines ofmessage, use one function call to output the message.
• This function does not support a Unicode string. Always use an ANSI string.
The log entry for the message is stored in a text file. In a text file, thecombination of two characters “\r\n” is recognized as a newline.
If you want to include a newline in a string specified by lpbuffer, insert “\r\n” inthe string.

6-11

6. LIBRARY FUNCTIONS

6.1.7 Get function for the drive condition (hfbDiskStat)<Name>
hfbDiskStat - Drive status acquisition<Syntax>#include <hfbras.h>
BOOL hfbDiskStat(PHFW_DISK_STATUS phfbDiskStatus);<Description>
The hfbDiskStat function stores the drive conditions to a structure pointed by phfbDiskStatus.
The parameters of this function are explained below.
phfwDiskStatus:
This parameter specifies a pointer to an HFB_DISK_STATUS structure shown below that storesthe drive conditions.
typedef struct HFB_DISK_STATUS{
DWORD
Disk_Count;
DWORD
Disk_Status[16];//Drive condition} HFB_DISK_STATUS, *PHFB_DISK_STATUS;
Disk_Count stores “2”, the number of drive bays on this equipment.
Disk_Status[n] stores the condition of the drive on the drive bay (n + 1). Table 6-6 lists thevalue that represents each status. Upper 16 bits are reserved. The values of those reserved bits
are undefined. Do not use those bits.
Table 6-6

List of Values Stored in Disk_Status

Defined value
Description
DISKSTAT_HEALTHY
The drive is working properly.
(0x00000001)
DISKSTAT_SMART
Drive failure prediction (SMART) is detected. (*1)(0x00000008)
DISKSTAT_NOT_CONNECTED A drive is not connected. (*3)(0x00000010)
DISKSTAT_UNKNOWN
The drive condition could not be acquired.
(0x00000020)
DISKSTAT_OVERRUN
The drive power-on (=used) hours exceeded the(0x00000040)
threshold. (*2)
DISKSTAT_OFFLINE
The drive is disconnected from the RAID. (*4)(0x00000002)
DISKSTAT_REBUILD
A new drive is connected to the RAID and is being(0x00000004)
rebuilt. (*4)(*1) This value is not stored if the drive failure prediction is not enabled.
(*2) This value is not stored if the drive usage monitoring is not enabled.
(*3) This value is stored if the equipment is non-D Model.
(*4) This value is stored if the equipment is D Model.

6-12

6. LIBRARY FUNCTIONSNote that if multiple conditions exist at the same time, the logical sum of the values shown in
Table 6-6 is stored.
(Example) If drive failure prediction (SMART) is detected and the drive power-on (=used) hours
exceeded the threshold at the same time:
DISKSTAT_SMART | DISKSTAT_OVERRUN (0x48)<Diagnosis>
If this function completes successfully, the function returns TRUE. If this function terminates withan error, the function returns FALSE. When this function terminates with an error, the value
stored in phfwDiskStatus is invalid.
When this function terminates with an error, call the GetLastError Windows API function to get
the error code. Error codes returned by this function on its own are as follows.
Error code (value)
Description
HFB_STORAGE_INVALID_PARAMETER There is an error in the specified parameters.
(0x20000001)
HFB_STORAGE_NOT_INITIALIZE
Startup of the RAS software has not completed yet.
(0x20000002)
HFB_STORAGE_INTERNAL_ERROR
An internal error has been generated.
(0x20000003)

Other error codes come from the Windows API functions used by this function. For details about
those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name of thesample program and where you can find it, see “6.2 Sample Programs”.

6-13

6. LIBRARY FUNCTIONS

6.1.8 Get function for the RAID status (hfbRaidStat) [D Model only]<Name>
hfbRaidStat - RAID status acquisition<Syntax>#include <hfbras.h>
BOOL hfbRaidStat (PHFW_RAID_STATUS phfbRaidStatus);<Description of the function>
The hfbRaidStat function stores the RAID status to a structure pointed to by phfbRaidStatus.
The parameters of this function are explained below.
phfbRaidStatus:
Specifies the pointer to the HFB_RAID_STATUS structure (shown below) where the RAID
status is stored.
typedef struct HFB_RAID_STATUS{
DWORDArray_Count;// Number of monitored arrays
HFB_ARRAY_STATUS
Array[16];// Array information} HFB_RAID_STATUS, *PHFB_RAID_STATUS ;Array_Count shows the number of monitored RAID arrays on this equipment (1).
Each element of Array shows the status of the corresponding RAID. The number of valid
elements is returned in Array_Count. (This value is 1, which means only Array[0] is valid.) The
elements after that are reserved. The values of those reserved elements are NULL. Do not accessthose elements. The HFB_ARRAY_STATUS structure is defined as follows.
typedef struct HFB_ARRAY_STATUS{
DWORD
Level;//RAID level
DWORD
Disk_Number; //Drives in the RAIDDWORDStatus;//RAID status
DWORD
Progress;//Progress (0 - 99[%])}HFB_ARRAY_STATUS, *PHFB_ARRAY_STATUS ;6-14

6. LIBRARY FUNCTIONS

Level stores the RAID level. The meaning of each value that can be stored in Level is as follows.
Table 6-7 Values Stored in Level in the HFB_ARRAY_STATUS Structure
No.
Defined value
1 HFB_RAID1 (0x00000001)

Description
RAID 1 is set up.

DiskNumber stores the value that indicates the drive bays used by the RAID. The stored value is alogical sum of some of the following.
Table 6-8 Values Stored in DiskNumber in the HFB_ARRAY_STATUS Structure
No.
Defined value
1 HFB_DISK1 (0x00000001)
2 HFB_DISK2 (0x00000002)

Description
Drive bay1 is used by the RAID.
Drive bay2 is used by the RAID.

Status stores the value that indicates the RAID status. The stored value is a logical sum of some of
the following. Numbers.1 through 4 denote RAID statuses, and numbers 5 and 6 denote detailed
information.
Table 6-9 Values Stored in Status in the HFB_ARRAY_STATUS Structure
No.
1
2
3
4
5
6

Defined value
HFB_RAID_OPTIMAL(0x00000001)
HFB_RAID_DEGRADE(0x00000004)
HFB_RAID_UNKNOWN(0x00000008)
HFB_RAID_FAIL(0x00000010)
HFB_RAID_REBUILD(0x00010000)
HFB_RAID_MEDIA_ERROR(0x00020000)

Description
The RAID is working properly.
The RAID is degenerated.
The RAID status is unknown.
The RAID failed.
One of the drives is under the rebuild process.
A media error has occurred.

For example, while the rebuild process is ongoing, the RAID status is Degraded(HFB_RAID_DEGRADE) and the detailed information is Rebuild (HFB_RAID_REBUILD).
Therefore, the logical sum of those two (HFB_RAID_DEGRADE| HFB_RAID_REBUILD(0x00010004)) is stored in Status.

6-15

6. LIBRARY FUNCTIONS

Possible combinations are as follows.
Table 6-10

Possible Combinations that can be Stored in Status in
the HFB_ARRAY_STATUS Structure

No.
RAID status
Detailed information
1 HFB_RAID_OPTIMAL
None
2
HFB_RAID_MEDIA_ERROR
3 HFB_RAID_DEGRADE
None
4
HFB_RAID_MEDIA_ERROR5
HFB_RAID_REBUILD
6
HFB_RAID_REBUILD | HFB_RAID_MEDIA_ERROR
7 HFB_RAID_UNKNOWN
None
8 HFB_RAID_FAIL
None
No.8: The system cannot operate normally, and the value may not be acquired.

Progress stores the progress of the rebuild process. If the RAID status value (Status) does notcontain HFB_RAID_REBUILD, 0 is stored.
<Diagnosis>
This function returns TRUE if it completes successfully, and it returns FALSE if it terminateswith an error. When this function terminates with an error, the value stored in phfbRaidStatus isinvalid. You can call the GetLastError Windows API function to get the error code. Error codes
returned by this function on its own are as follows.
Error code (value)
HFB_STORAGE_INVALID_PARAMETER(0x20000001)
HFB_STORAGE_NOT_INITIALIZE(0x20000002)
HFB_STORAGE_INTERNAL_ERROR(0x20000003)
HFB_STORAGE_NOT_RAID(0x20000101)

Description
There is an error in the specified parameters.
Startup of the RAS software has not completed
yet.
An internal error has been generated.
This equipment on which this function is being
executed is not a D Model.

Other error codes come from the Windows API functions used by this function. For details about
those error codes, refer to Windows API help.
<Sample program>
The following is a sample from a C program that uses this function. For information about thename of the sample program and where you can find it, see “6.2 Sample Programs”.

6-16

6. LIBRARY FUNCTIONS

6.1.9

Status display digital LEDs control functions (SetStCode7seg, TurnOff7seg, SetMode7seg)(1) Application status code display function (SetStCode7seg)<Name>
SetStCode7seg - Displaying an application status code
<Syntax>#include <ctrl7seg.h>
BOOL SetStCode7seg(DWORD dwStCode);<Description>
This function outputs an application status code on the status display digital LEDs. On thestatus display digital LEDs, the value specified by this function is displayed in hexadecimal.
The parameters of this function are explained below.
dwStCode:This parameter specifies an application status code to be displayed on the LEDs. You canspecify a value between 0 and 255. If a value other than the above is specified, this function
terminates with an error. If you call the GetLastError Windows API function, an error code
CTRL7SEG_INVALID_PARAMETER is returned.
<Diagnosis>
If this function completes successfully, the function returns TRUE as a return value. If thisfunction terminates with an error, the function returns FALSE.
When this function terminates with an error, call the GetLastError Windows API function to
get the error code. Error codes returned by this function on its own are as follows.
Error code (value)
CTRL7SEG_INVALID_PARAMETER(0x2001)

Description
There is an error in the specified parameters.

Other error codes come from the Windows API functions used by this function. For details
about those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name ofthe sample program and where you can find it, see “6.2 Sample Programs”.

6-17

6. LIBRARY FUNCTIONS(2) Application status code clear function (TurnOff7seg)<Name>
TurnOff7seg - Turning off an application status code
<Syntax>#include <ctrl7seg.h>
BOOL TurnOff7seg(VOID);<Description>
This function clears the application status code currently displayed on the status display digital
LEDs. When this function is called, the status display digital LEDs are turned off.
<Diagnosis>
If this function completes successfully, the function returns TRUE as a return value. If thisfunction terminates with an error, the function returns FALSE.
When this function terminates with an error, call the GetLastError Windows API function to
get the error code. The error code comes from the Windows API functions used by thisfunction. For details about those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name ofthe sample program and where you can find it, see “6.2 Sample Programs”.

6-18

6. LIBRARY FUNCTIONS(3) Status display mode setup function (SetMode7seg)<Name>
SetMode7seg - Setting up the status display mode
<Syntax>#include <ctrl7seg.h>
BOOL SetMode7seg(DWORD dwMode);<Description>
This function configures the status display mode of the status display digital LEDs.
The parameters of this function are explained below.
dwMode:This parameter specifies the “status display mode” of the status display digital LEDs.
Table 6-11 shows a list of values that can be specified by dwMode.
Table 6-11

List of Values Specified by dwMode in the SetMode7seg Function

dwModeAPPST_MODE (0x00)
RASST_MODE (0x01)

Explanation of the action
Selects the application status display mode.
Selects the status display mode.

If a value other than the above is specified, this function terminates with an error. If you callthe GetLastError Windows API function, an error code
CTRL7SEG_INVALID_PARAMETER is returned.
<Diagnosis>
If this function completes successfully, the function returns TRUE as a return value. If thisfunction terminates with an error, the function returns FALSE.
When this function terminates with an error, call the GetLastError Windows API function to
get the error code. Error codes returned by this function on its own are as follows.
Error code (value)
Description
CTRL7SEG_INVALID_PARAMETER There is an error in the specified parameters.
(0x2001)

Other error codes come from the Windows API functions used by this function. For details
about those error codes, refer to the Windows API help.
<Sample program>
We provide a sample program that uses this function in C. For information about the name ofthe sample program and where you can find it, see “6.2 Sample Programs”.

6-19

6. LIBRARY FUNCTIONS

6.2 Sample Programs
Sample program file in C that use RAS library functions are stored in the %ProgramFiles%\HFWRAS\sample directory. Use those files for reference when you develop a program orcheck the operation of those functions.
The following Table 6-12 shows a list of sample programs.
Table 6-12
No.
1
2
3
4
5
6
7

File nameshutd.c
wdt.c
gendoex.cgendiex.c
MCon.chfbDiskStat.c
hfbRaidStat.c

8

7seg.c9

FanErr.c

List of Provided Sample Programs

Description
A sample program for the BSSysshut function
A sample program for the WdtControl function
A sample program for the GendoControlEx function
A sample program for the GetGendiEx function
A sample program for the MconWriteMessage function
A sample program for the hfbDiskStat function
A sample program that uses the hfbRaidStat function
A sample program for the status display digital LEDs control functions(SetStCode7seg, TurnOff7seg, and SetMode7seg)
A sample program for detecting a RAS event (For information about the
RAS event notification, see “4.2 RAS Event Notification”.)

6-20

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSISCHAPTER 7 FEATURES RELATED TO MAINTENANCE AND
FAILURE ANALYSIS
7.1

Log Information Collection Window

7.1.1 Overview
In the log information collection window, you can take the following actions by using agraphical user interface.
(1) Collecting log data
This function saves the data used for preventive maintenance and post-failure analysis of
the problem. The data is compressed and saved as one file (File name: logsave.dat).
(2) Collecting memory dump files
This function collects the memory dump files saved by the OS. The data is saved as acompressed file (File name: memory.mcf). At the same time, minimum memory dump
files are also collected.
For information about how to decompress the saved files and the contents of the files,
refer to “7.4 Maintenance Operation Commands” in the HF-BX1000/1200
INSTRUCTION MANUAL (manual number BX-62-0001).

NOTICECPU load increases while memory dump files are being collected. While CPU
load is high, operation of user applications can be disturbed. Make sure that you
do not collect memory dump files using the log information collection window
while the applications for business use are running on this equipment.
7.1.2 Starting the log information collection window
To start the log information collection window, follow the procedure below:
You need to have administrator privileges to use this window. Log on to the computer using
an administrator account and start the window.
1. Click Start.
2. Point to All Programs > RAS Software.
3. Click RAS Maintenance Support.
4. If you see the “User Account Control” window, click Yes.
NOTE
The log information collection window cannot be used by multiple users at thesame time. If you use, for example, user switching to try to start instances of thelog information collection window from multiple consoles, an error may occur. If
an error occurs, close the log information collection window on another console,and then start the window.

7-1

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS

7.1.3 Using the log information collection window
1. The log information collection window appears. By default, both the “Gather log data”
and “Gather memory dump files” check boxes are selected. If you do not need one ofthose two, clear the check box for the one you do not need, and then click Continue.

2. If the “Gather memory dump files” check box is selected, you will receive the following
message. Click OK. If you click Cancel, you go back to the log information collection
window without executing the maintenance operation.

3. The following dialog box is displayed. Specify the destination directory to save and click
OK. If you want to cancel the maintenance operation, click Cancel. If you click Cancel,
you go back to the log information collection window without executing the maintenance
operation.

7-2

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS

4. The information selected at step 1 is collected. During the process, a window is displayed
to show the progress. If the process finishes successfully, the following window appears.

5. A directory is created under the directory specified as the destination directory to save.
The name of the directory is assigned based on the date and time of the operation. Under
the directory just created, collected data is saved.
SpecifieddirectoryYYMMDD_
hhmm directory(*1)

logsave.dat : Log data file (*2)

memory.mcf: Memory dump filewindows
directory

Minidump: Minimum memory dump files
directory are stored(*1) The name of the directory is “YYMMDD_hhmm”.
YY: Lower two digits of the year, MM: Month, DD: Day, hh: Hour, mm: Minute
Example: If you perform the maintenance operation at 13:59 on Jan 1, 2006
Directory name: “060101_1359”(*2) The following data is saved.
• If Gather log data is selected: logsave.dat• If Gather memory dump files are selected: memory.mcf and minimum memory dump files

Figure 7-1
7.1.4

Organization of the Folders for Collected Data

Finishing the log information collection window
To close the log information collection window, click Cancel.

7-3

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS

7.2

Logging the Trend of the Temperature inside the Chassis

7.2.1 Overview
This function periodically measures the temperature inside the chassis of this equipment andrecords the data into a log file. You can adjust the logging interval for the temperature inside
the chassis by using the logging interval setup command. The default setting for the logging
interval is 60 minutes. You can select the setting from three options: 10, 30, and 60 minutes.
7.2.2

Log files
The temperature inside the chassis is recorded in a log file at the specified logging intervals.
When this equipment runs continuously for 8 hours or more, the highest and lowest
temperatures in 8 hours are also recorded every 8 hours. For either file, if the log gets full,
log entries are overwritten from the first entry.
Table 7-1 shows the name of each log file.
Table 7-1
Parent folder

Log Files

File nametemp.csv%ProgramFiles%\HFWRAS\log
temp_mm.csv

Description
The temperature inside the chassis is recorded inthis file at the logging intervals.
(Maximum of 51200 entries)
The highest and lowest temperatures in 8 hours arerecorded in this file.
(Maximum of 1100 entries)<Checking log information>
You can check log information by opening the log files using an application such as
Notepad. The files are in the csv format. You can use spreadsheet or database software toload the log information and draw graphs.
You can also use the log information collection window and the logsave command tocollect those log files. For information about how to use the logsave command, refer to“7.5.1 Log information collection command (logsave)” in the “HF-BX1000/1200
INSTRUCTION MANUAL (manual number BX-62-0001)”.

7-4

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS<Log information format>
The format of log information is as follows.
(1) temp.csv
YYYY/MM/DD hh:mm:ss, yxxx::

YYYY: Year, MM: Month, DD: Day, hh: hour (24-hour clock), mm: minute, ss: second,y: Sign (+ or -), xxx: (Temperature (°C))
If acquiring the temperature fails, xxx is replaced with “---”.

Figure 7-2

Format of Log Information 1(2) temp_mm.csv
YYYY/MM/DD hh:mm:ss, yxxx, yzzz::
YYYY: Year, MM: Month, DD: Day, hh: hour (24-hour clock), mm: minute, ss: second,y: Sign (+ or -), xxx: (Highest temperature (°C))
y: Sign (+ or -), zzz: (Lowest temperature (°C))

Figure 7-3

Format of Log Information 2

7-5

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS

7.2.3

Logging interval setup command<Name>
tmplogset - Setting up the logging interval<Syntax>
tmplogset<Function>
This command configures the interval for logging the trend of the temperature inside the chassis.
The following shows how to use the command.
1. Start Command Prompt.
You need to have administrator privileges to run this command. Log on to the computer as anadministrator account and start Command Prompt.
If User Account Control (UAC) is enabled, start the command prompt as an administrator
according to “APPENDIX A RUNNING COMMAND PROMPT AS AN
ADMINISTRATOR”.
2. At the command prompt, run the tmplogset command. The following initial screen is displayed
along with the current setting.
>tmplogset
Logging time of the cycle：60 minutes
1. Change at logging cycle [10,30,60 minutes]
2. Exit：_

3. If you type 2 in the initial screen, the tmplogset command exits without changing the setting. If
you type 1 and then press Enter, the following message is displayed.
Please select new time of the cycle.
When the return is input, it becomes like a present setting.
1. 10 minutes
2. 30 minutes
3. 60 minutes：_

7-6

7. FEATURES RELATED TO MAINTENANCE AND FAILURE ANALYSIS

4. Type the number corresponding to the new interval you want to select and press Enter. If thenumber you typed is out of range, the following message is displayed to prompt you to type acorrect number.
The entered setting is invalid.
Please enter a setting again. [input range: 1-3]

5. If you type a number between 1 and 3, the following message is displayed. The “×” below
denotes the number you entered.
New logging time of the cycle is ×.
Is this value set?(y-YES/n-NO)：_

6. If you press y and then press Enter, the logging interval is updated to the new value and thecommand exits. The new setting becomes effective when the command exits. If you want toconfirm the change, run this command again and check the initial screen.
If you do not want to change the logging interval, press n and press Enter. The following
message is displayed and the command exits without changing the setting.
The setting takes no effect, because you enter the letter ‘n’.

If you do not have administrator privileges when you run the command, the following message
is displayed and the command exits.
>tmplogset
You do not have the privilege to run this command.
Please run this command again on “Administrator: Command Prompt”.

If an internal error occurs when you run the command, the following message is displayed andthe command exits.
Error: Systemcall failed. (API Name：Error Code)In the message above, “API Name” actually shows the name of the Windows API with theerror. “Error Code” shows the error code in hexadecimal. If this message is displayed, run thecommand again.

7-7This Page Intentionally Left Blank

8. SIMULATING THE HARDWARE STATUS

CHAPTER 8 SIMULATING THE HARDWARE STATUS
8.1

Hardware Status Simulation

8.1.1 Overview
This function simulates the hardware status of this equipment. By simulating the hardware
status, you can test a user application and check the notification interface of the RAS
software without actual hardware failure.
When the hardware status is simulated, the RAS software is set to a special mode called“simulation mode”. In “simulation mode”, monitoring of the actual hardware status isdisabled. You must never use this equipment in simulation mode for business use.
This function simulates the following hardware conditions.
• Fan condition• Temperature condition inside the chassis• Drive condition (including drive failure prediction (SMART monitoring) condition andwhether the used hours exceeded the threshold)• RAID status (D Model only)

Figure 8-1

Simulation Tool Window

The monitoring function of the RAS software detects change in the simulated hardware
status and notifies the change through various interfaces.
For information about the interfaces used for notification, see the following sections in thismanual.
• Fan condition: “2.1 Fan Monitoring”• Temperature condition inside the chassis: “2.2 Monitoring Temperature inside the
Chassis”• Drive condition: “2.3 Drive Failure Prediction Function (SMART Monitoring)” and “2.4Drive Usage Monitoring”• RAID status: “2.6 RAID Monitoring”

8-1

8. SIMULATING THE HARDWARE STATUS

NOTICE
While the equipment is running in simulation mode, monitoring of the actual
hardware status is disabled. Errors including fan failure and abnormal
temperature cannot be detected. You must never use this equipment insimulation mode for business use. Use the simulation function only for testing auser application and checking the notification interface of the RAS software.
NOTE• In simulation mode, when the drive failure prediction function records an event(Event ID: 265) of SMART detection in the event log, a string “XXXXXXXX” isused for the model name of the drive.
Also note that you cannot simulate a situation that the drive condition is“Unknown” or multiple conditions (for example, SMART detection and used
hours exceeded) occur at the same time.
• RAID status is automatically updated based on the condition of the drives.
Note that you cannot simulate a situation in which the RAID status is“Unknown” or “Fail” or a situation in which media errors occur.

8-2

8. SIMULATING THE HARDWARE STATUS

8.1.2 Using the simulation function
Run the simulation mode start command at the command prompt to set the RAS software to
the “simulation mode”. When the RAS software transitions to the “simulation mode”, theSimulation Tool window appears on the screen.
You can use this window to simulate the condition of hardware devices. Note that in order
to exit the simulation mode, you need to restart this equipment.
This subsection explains the procedure of using the simulation mode.
(1) Overview of the procedure of using the simulation function
The figure below shows a rough flow chart of using this function. From when thesimulation mode start command is executed until when OS shutdown completes, the
RAS software runs in “simulation mode”.

START
Start the equipment.
Log on to the OS.

Execute the simulation mode
start command.

For details, see (2).

Perform hardware failure tests in the
Simulation Tool window.

For details, see (3).

Close the Simulation Tool windowor start shutdown.

For details, see (4).

Running insimulation mode

Shutdown process

The equipment is turned offor restarted.
END

Figure 8-2 Procedure to Use the Simulation Mode

8-3

8. SIMULATING THE HARDWARE STATUS(2) Starting the simulation mode
To start the simulation mode, run the simulation mode start command (simrasstartcommand) at the command prompt.
NOTE• The simulation mode cannot be started from a remote desktop. Before you
start the simulation mode, other logged-on users must log off.
• If the RAS software has already detected hardware failure, the simulation
mode cannot be started. Remove the cause of the failure before using thesimulation mode.
1. Start Command Prompt.
You need to have administrator privileges to run the simulation mode start command.
Log on to the computer using an administrator account and start Command Prompt.
If User Account Control (UAC) is enabled, start the command prompt as anadministrator according to “APPENDIX A RUNNING COMMAND PROMPT AS
AN ADMINISTRATOR”.
2. At the command prompt, type the following, and then press Enter.
\%SystemDrive%\"Program Files"\HFWRAS\sim\simrasstart
3. You will receive the following message about exiting the simulation mode. Click OK.
If you click Cancel, the simulation mode does not start.

4. You will receive the following message to notify that the simulation mode starts.
Click OK. If you click Cancel, the simulation mode does not start.

8-4

8. SIMULATING THE HARDWARE STATUS

5. The Simulation Tool window appears. After this point on, this equipment runs insimulation mode. Monitoring hardware failure is now disabled.
NOTE
While the equipment is running in simulation mode, the Windows® Exclamation
sound is played twice every 10 seconds. (Only when speakers are connected.)

8-5

8. SIMULATING THE HARDWARE STATUS(3) Using the Simulation Tool window
When the RAS software transitions to the simulation mode, the Simulation Tool
window appears as shown in the following figure.
You can use the Simulation Tool window to change the condition of hardware devices.
When the Simulation Tool window starts, all hardware devices are set to the normal
status.

Shows the name ofa simulated device.

Shows the currently set
status of the target device.

Click Apply to apply
the “Setting”.

Figure 8-3

Shows a new status
to be simulated.

Click End to exit thesimulation mode.

Description of Each Part in the Simulation Tool Windowz TargetShows the name of each simulated hardware device.
Category
Fan condition
Temperature condition
inside the chassis
Drive condition

TargetCase fan, CPU fan
Internal Temperature
Drive bay1, Drive bay2

8-6

8. SIMULATING THE HARDWARE STATUS

z Status
Shows the currently set status of each simulated hardware device. The followingshows a list of statuses for each hardware device.
TargetCase fan, CPU fan
Internal Temperature
Drive bay1, Drive bay2

StatusNormal, Error
Normal, Error
Healthy, SMART Detected, Overrun,
Offline (*1), Rebuild (*1),
Not Connected (*2)(*1) D Model only(*2) Non-D Model (only for drive bay2)

Immediately after the Simulation Tool window starts, all hardware devices are set to“Normal” or “Healthy”.
z SettingShows a new status to be simulated for each target hardware device.
If no status to be simulated is set, “---” is displayed. (Immediately after the
Simulation Tool window starts, “---” is displayed for all hardware devices.)z Apply button
If you click this button, all “Setting” are applied to the “Status” of hardware devices.
The monitoring function of the RAS software detects change in the “Status” of the
hardware devices and notifies the change through various interfaces.
NOTE
A new hardware status is applied to the notification interface of the RAS
software when the following time elapses after you click Apply in the
Simulation Tool window. Wait for the time specified below before you checkthe result of simulation.
• Fan condition: About 10 seconds later• Temperature condition inside the chassis: About 15 seconds later• Drive condition: About 5 seconds later

8-7

8. SIMULATING THE HARDWARE STATUS

z End button
If you click this button, shutdown is executed to exit the simulation mode. Before
shutdown is executed, the following message is displayed. Save the data, for example,
and then click OK. If you click Cancel, the Simulation Tool window does not exit.

NOTE
Even if the Simulation Tool window exits due to an internal error or the like,shutdown is executed automatically to exit the simulation mode. Before
shutdown is executed, the following message is displayed. Save the data, forexample, and then click OK.

z Minimize button ([_] button)
Click the Minimize button at the upper right corner of the Simulation Tool window
to minimize the Simulation Tool window. Note that when the window is minimized,
the simulation mode does not exit.
z Close button ([×] button)
Click the Close button at the upper right corner of the Simulation Tool window to
execute shutdown and exit the simulation mode. The behavior after this button isclicked is the same as when you click End.

8-8

8. SIMULATING THE HARDWARE STATUS

The following procedure shows how to simulate a hardware status using the Simulation
Tool window.
1. Right-click a hardware item you want to simulate. A popup menu is displayed. The
menu lists the statuses you can select based on the current hardware status.

2. If you select a status you want to simulate on the popup menu, the selected status isdisplayed in “Setting”.

3. To apply the status displayed in “Setting” to the hardware status, click Apply. As aresult, the “Status” in the Simulation Tool window is updated.

8-9

8. SIMULATING THE HARDWARE STATUS

NOTE
If the “Setting” is not selected (that is, “---” is shown) or is the same as the“Status” when you click Apply, the current “Status” does not change.
The following shows a list of items on the popup menu that are displayed when you
right-click each hardware item.
On the popup menu, the current status and the statuses that the current status cantransition to are displayed. Note that if the current status is the only status that can bedisplayed on the menu, “None” is displayed shaded on the menu.
z Fan
No.
Current status
1 Normal
2 Error

Statuses in the popup menu
Normal, Error

Note

Statuses in the popup menu
Normal, Error

Note

Statuses in the popup menu
Healthy, SMART Detected,
Overrun, Not Connected
SMART Detected Healthy, SMART Detected,
Not Connected
OverrunHealthy, Overrun, Not Connected
Not Connected
Healthy, Not Connected

Notez Internal Temperature
No.
Current status
1 Normal
2 Errorz Drive<Other than D Model>
No.
Current status
1 Healthy(*1)2(*1) (*2)34(*1) (*2)(*1) (*3)(*1) In the case of models other than D Model, the equipment never starts without
drive bay1 being mounted, and consequently, Not connected” is not displayedfor drive bay1 on the popup menu.
(*2) Transition from “SMART Detected” or “Overrun” to “Healthy” means that thetarget drive is replaced with a new one and that the new drive is connected.
(*3) We suppose transition from “Not Connected” means a new drive is connected.
Consequently, transition to “SMART Detected” or “Overrun” is not allowed.

8-10

8. SIMULATING THE HARDWARE STATUS<D Model>No.
Current status
1 Healthy
23
45Statuses in the popup menu
Healthy, SMART Detected, Overrun,
Offline
SMART Detected SMART Detected, Offline
OverrunOverrun, Offline
OfflineOffline, Rebuild
Rebuild
Healthy, Offline, Rebuild

Note
(*1)
(*2)
(*2)
(*3) (*4)(*1) If the RAID status is “Degrade”, “Offline” is not displayed.
(*2) If the RAID status is “Degrade”, “None” is the only item on the menu and isgrayed out.
(*3) Transition of the status from “Rebuild” to “Healthy” means the rebuild process
is complete.
(*4) We suppose transition from “Rebuild” means a new drive is connected.
Consequently, transition to “SMART Detected” or “Overrun” is not allowed.

8-11

8. SIMULATING THE HARDWARE STATUS(4) Exiting the simulation mode
To exit the simulation mode, you need to restart this equipment.
For this reason, when the Simulation Tool window exits, this equipment is
automatically shut down in order to exit the simulation mode.
There is no limitation for how the equipment can restart in order to exit the simulation
mode. In the same way as normal mode, this equipment restarts in the following cases orreasons.
• Shutdown is executed on the Start menu.
• A system shutdown API function such as the BSSysshut and ExitWindowsEx functions
is executed.
• Automatic shutdown occurs when detecting fan failure or abnormal temperature inside
the chassis.
• Ctrl + Alt + Del is pressed and using the power button at the lower right corner of thescreen, the equipment is shut down.
• A blue screen appears because, for example, the reset button is pressed.
• System reset occurs or a blue screen appears.
• The power is forcibly turned off using the power switch.
• The End button or the Close button [×] in the Simulation Tool window is clicked.
• The Simulation Tool window is terminated with an error.
NOTE• As explained above, the simulation mode exits when the equipment restarts
after automatic shutdown caused by simulated fan failure or abnormal
temperature inside the chassis. To start the simulation mode again, executethe simulation mode start command.
When you execute shutdown or logoff, the following message is displayed to
notify that the simulation mode will exit and that the system will shut down.

• When a remote connection is used, shutdown process can be delayed when
shutdown is executed due to a reason listed above.

8-12

8. SIMULATING THE HARDWARE STATUS

8.1.3 Precautions when you use the Simulation Tool window(1) When the new status to be simulated is finalized
From when you select a new status to be simulated from a popup menu on the
Simulation Tool window until when you click Apply, the new status to be simulated is
not finalized and you can change it. The actual status used for simulation is the one
shown in “Setting” in the Simulation Tool window when you click Apply.
(2) Simulating the status of the drives in the RAID
In the case of D Model, the RAID status is determined by the simulation of the conditionof the drives used in the RAID. In some cases, if you select a new status to be simulated
for both drives, the condition of the first drive you selected may change depending on
the condition of the second drive you selected. The following example illustrates thecase where “Offline” is selected for both drives.
1. Select Offline for drive bay1. Then, select Offline for drive bay2.

2. When Offline is selected for drive bay2, the condition of the drive bay1 is changed
back to “---” (Not selected).

8-13

8. SIMULATING THE HARDWARE STATUS

8.1.4 Event log entries
In order to clearly show which log entries for hardware failure originate from the simulation
function, this function records event log entries listed in the following table.
Note that a log entry with Event ID 252 is recorded at the timing when you click Apply in
the Simulation Tool window. This log entry is recorded even when all “Settings” are notspecified.
Table 8-1 Event Log Entries Recorded by This Function
Event ID
250
251

Type
Category
Description
Information HFBSIM The Simulation Mode started.
Information HFBSIM The Simulation Mode ended.
The following conditions were set atthe Simulation Mode.
Case fan: %1
252
HFBSIM_SYS Information HFBSIM CPU fan: %2
Internal Temperature: %3
Drive bay1: %4
Drive bay2: %5
The %x above denotes the corresponding Setting in the Simulation Tool window.

8.1.5

SourceHFBSIM_SYSHFBSIM_SYS

Remote notification
This function notifies of the transition of the RAS software to simulation mode using trap
notification so that an SNMP manager that monitors this equipment in a remote location canknow that the hardware statuses it acquires and the trap notifications for hardware failure(and hardware recovery) it receives are generated in simulation mode. In addition, the object
value for the operational mode of the RAS software is changed to the one for the simulation
mode.
NOTE
The contents of the hardware status that can be acquired and a trap notificationthat can be notified are the same as in the normal mode. For details about theobjects of the extended MIB for HF-BX, see “4.5 Remote Notification”.

8-14

APPENDIX A

APPENDIX ARUNNING COMMAND PROMPT AS AN ADMINISTRATORRUNNING COMMAND PROMPT AS AN
ADMINISTRATOR

The following procedure shows how to run Command Prompt as an administrator.
1. Log on to the computer using an administrator account.
2. Click Start.
3. Click All Programs.
4. Click Accessories.
5. Right-click Command Prompt and click Run as administrator.
(If the administrator account you used for log on is a built-in administrator account, simply click
Command Prompt.)
If you see the User Account Control window, click Yes.

A-1

This Page Intentionally Left Blank

APPENDIX BCHECKING THE RAS SOFTWARE VERSIONAPPENDIX B CHECKING THE RAS SOFTWARE VERSION
The following shows the procedure for checking the RAS software version.
1. Log on to the computer using an administrator account.
2. Click Start > Control Panel.
3. Click Programs > Programs and Features.
4. The Uninstall or change a program window appears. Click RAS Software in the list.
5. Check the Product version.

B-1

This Page Intentionally Left Blank