Download Print this page

Advertisement

Quick Links

BT-63-0004-01

Advertisement

loading

Summary of Contents for Hitachi HF-BT1000

  • Page 1 BT-63-0004-01...
  • Page 2 BT-63-0004-01...
  • Page 3 First Edition, November 2013, BT-63-0004 (out of print) Second Edition, April 2015, BT-63-0004-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 in writing from the publisher.
  • Page 4 SAFETY INSTRUCTIONS Carefully read and fully understand the safety precautions below before operating the equipment. Operate the equipment by following the instructions and procedures described in this manual. Pay attention especially to safety precautions displayed on the equipment or in this manual.
  • Page 5 Do not give a shock to the equipment when unpacking or carrying the equipment. 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.
  • Page 6 SAFETY INSTRUCTIONS (Continued) CAUTION If the equipment drops or is tipped over, personal injury may result. Pay full attention when transporting the equipment. Make sure you do not catch or hit your fingers to cause personal injury when unpacking or carrying the equipment.
  • Page 7 SAFETY INSTRUCTIONS (Continued) 1.3 NOTICE This equipment alone cannot guarantee the system safety. In order to ensure sufficient safety of your system even when this equipment should fail, malfunction, or have program bugs, you must add systemic protections such as building external protective/safety circuits to facilitate safety measures to prevent personal injury and serious accidents.
  • Page 8 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-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”. (See page 2-2.) When an OS hung-up occurs, the processes on the OS may not run as scheduled, and the processing of the equipment may be delayed.
  • Page 9 SAFETY INSTRUCTIONS (Continued) 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 in damage to the parts.
  • Page 10 • Microsoft®, Windows®, Visual C++®, and Visual Basic® are trademarks or registered trademarks 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 are registered trademarks, trademarks, or products of their respective owners.
  • Page 11 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-1 2.3 Drive Failure Prediction Function (SMART Monitoring) ........... 2-2 2.4 Drive Usage Monitoring ......................
  • Page 12 4.5.5 Extended MIB file for HF-BT ..................4-34 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 ......
  • Page 13 FIGURES Figure 1-1 RAS Setup Window ....................1-2 Figure 1-2 Hardware Status Icon ....................1-2 Figure 2-1 Example of a Flow Chart of Monitoring the Operational State of a User Program ......................2-5 Figure 2-2 RAID Status Transitions ..................2-7 Figure 2-3 Example of a Message Box when a Media Error Occurs ........
  • Page 14 TABLES Table 1-1 Overview of the RAS Feature ................... 1-1 Table 2-1 RAID Statuses and their Descriptions ............... 2-7 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 ....................
  • Page 15 This Page Intentionally Left Blank...
  • Page 16 1. CAPABILITIES OF THE RAS FEATURE CHAPTER 1 CAPABILITIES OF THE RAS FEATURE The HF-BT1000 come with the Reliability, Availability, Serviceability (RAS) feature that you would expect from a highly reliable industrial computer. The following is an overview of the RAS feature.
  • Page 17 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 as well 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.
  • Page 18 1. CAPABILITIES OF THE RAS FEATURE (5) Event notification Enables a user application to check the hardware status of this equipment by monitoring the status of event objects. (6) Popup notification Notifies a user that an error occurred in the hardware of this equipment by displaying popup messages.
  • Page 19 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 (14), (16), (18), and (19). For details about other functions, see “HF-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”.
  • Page 20 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. 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.
  • Page 21 RAS 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-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”. NOTE • It is not possible for the Drive Failure Prediction Function to anticipate all failures.
  • Page 22 For information about how to replace a drive, see “HF-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”. • This function can monitor only the drives on the drive bay1 and 2 recognized at the OS startup.
  • Page 23 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 a user program. • Automatic retriggering feature The watchdog timer monitoring process in the RAS software automatically retriggers the timer and monitors the operation of the OS.
  • Page 24 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).
  • Page 25 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 is any change in the status of the RAID, this function notifies a user or an application using the following methods.
  • Page 26 2. ITEMS MONITORED BY THE RAS FEATURE 2.6.1 State transition of the RAID Table 2-1 lists RAID statuses and their respective descriptions. Figure 2-2 shows the state transitions. Table 2-1 RAID Statuses and their Descriptions RAID status Description Detailed information Normal –...
  • Page 27 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 is normal. 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 a data integrity problem.
  • Page 28 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...
  • Page 29 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.
  • Page 30 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 the following cases: a fan failure, and an abnormally high temperature. Figure 3-2 Items in the Shutdown Setting “Automatically shutdown if fan failure has been detected”...
  • Page 31 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.
  • Page 32 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 •...
  • Page 33 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. Action on timeout • Not reset: The equipment is not reset. (Default factory setting) The timeout code is displayed on the status display digital LEDs.
  • Page 34 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) Setting “Function is available”...
  • Page 35 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 Setting “Function is available”...
  • Page 36 3. SETTING UP THE RAS FEATURE In the Advanced window, you can set up a threshold for the drive power-on hours so that you can be notified when the value of the drive power-on hours exceeds the threshold. To set the notification threshold, from the Object list, select the drive you want to set up.
  • Page 37 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 front of this equipment. Figure 3-7 Items in the Status Display Digital LEDs Setting “Show Hardware status”...
  • Page 38 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 the advanced settings of this function. Figure 3-8 Items in the Popup Notification Setting “Function is available” check box •...
  • Page 39 3. SETTING UP THE RAS FEATURE Advanced button Click Advanced to display the following window. Other than D Model D Model Figure 3-9 Advanced Settings for the Popup Notification Setting [Events] • Fan failure • Abnormally high temp. • Drive failure prediction (SMART) •...
  • Page 40 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 the format described below.
  • Page 41 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 Defined message [CS-FAN]...
  • Page 42 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) •...
  • Page 43 3. SETTING UP THE RAS FEATURE 3. Click Display message. A popup notification message is displayed based on the change 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.
  • Page 44 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”.
  • Page 45 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 of the 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.
  • Page 46 If this situation happens, restart this equipment. • For information about how to replace a perishable component, refer to “HF-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”.
  • Page 47 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 of the taskbar to display the hardware status. Note that, in the default factory settings, the icon is not shown. If you click the arrow at the side of the notification area, the icon will appear.
  • Page 48 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 Hardware Icon...
  • Page 49 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)
  • Page 50 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.
  • Page 51 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 and Displayed Information Fan condition Icon Information Normal Fan is working normally. Excessively low rotation Fan failure is detected. speed For details, refer to the event log.
  • Page 52 4. CHECKING THE HARDWARE STATUS 3. Drive condition Shows the current status of the drives. In the following areas, the drive conditions of drive bay1 and 2 are displayed. Table 4-4 Drive Condition and Displayed Information Drive condition Icon Information If SMART monitoring Healthy.
  • Page 53 4. CHECKING THE HARDWARE STATUS 5. RAID status [D Model only] The RAID status is displayed. Table 4-5 RAID Status and Displayed Information RAID status Displayed information Note Detailed information [Optimal] Normal – [Optimal (Media Error)] Media error occurs. [Degrade] –...
  • Page 54 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.
  • Page 55 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, this function 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.
  • Page 56 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 Event Popup notification message...
  • Page 57 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.
  • Page 58 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.
  • Page 59 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.
  • Page 60 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 at timeout under Watchdog timer setting in the RAS Setup window. The timeout code is displayed as flashing “88”...
  • Page 61 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” is displayed with higher priority than the timeout code. For information about the status display modes, see “4.4.3 Status display modes”.
  • Page 62 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 Description When the hardware status is normal, an application status Hardware status display mode code is displayed.
  • Page 63 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 Timeout code Status code (*1) (*1) Hardware status code or application status code •...
  • Page 64 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, the system administrator is away from this equipment or this equipment is built into the facility, the hardware conditions can be checked from a remote device.
  • Page 65 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 •...
  • Page 66 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 remote notification is enabled. When you use the remote notification, follow the procedure below to enable the SNMP service: (1) Starting the “SNMP Service Properties”...
  • Page 67 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 “Send authentication trap” check box. 3. Under “Accepted community names,” click Add. The “SNMP Service Configuration”...
  • Page 68 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 are sent to, and click “Add to list.” 3.
  • Page 69 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.
  • Page 70 4. CHECKING THE HARDWARE STATUS 5. The “Allowed Programs” window appears. Click Change settings, and under “Allowed programs and features,” select the “SNMP Service” check box. 6. Click OK. 4-27...
  • Page 71 MIB for HF-BT. Note that the extended MIB for HF-BT is the same MIB as the extended 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-BT and a description of those objects.
  • Page 72 4. CHECKING THE HARDWARE STATUS (2/2) Object Object Description Description of the values number Drive power-on (=used) hfwHdd.hddTable.hddEntry.hddUseTime 3.2.1.3 hours – (in hours) hfwRaid RAID status group – hfwRaid.raidNumber Number of monitored arrays – hfwRaid.raidTable.raidEntry.raidIndex 4.2.1.1 Index number of raidEntry –...
  • Page 73 “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) .1.3.6.1.4.1.116.5.45.2.y (y is an object number in the table below)
  • Page 74 “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.system. hfw.hfwExMibInfo.x (x is an object in the table below) .1.3.6.1.4.1.116.3.45.1.y (y is an object number in the table below)
  • Page 75 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 the trap notification when an error occurs is as follows. Enterprise ID: iso.org.dod.internet.private.enterprises.Hitachi.systemAP. hfwMibTrap.hfwRasErrorTrap .1.3.6.1.4.1.116.7.45.1...
  • Page 76 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 the trap notification when the equipment has recovered from an error is as follows. Enterprise ID: iso.org.dod.internet.private.enterprises.Hitachi.systemAP. hfwMibTrap.hfwRasRecoverTrap .1.3.6.1.4.1.116.7.45.2...
  • Page 77 4. CHECKING THE HARDWARE STATUS 4.5.5 Extended MIB file for HF-BT The extended MIB file for HF-BT is as follows. Extended MIB file for HF-BT: %ProgramFiles%\HFWRAS\mib\hfwExMib.mib 4-34...
  • Page 78 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”. To acquire the drive condition: Use the hfbDiskStat function. To acquire the RAID status: Use the hfbRaidStat function.
  • Page 79 This Page Intentionally Left Blank...
  • Page 80 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, the equipment can be automatically shut down. For details, see “5.1 Automatic Shutdown and System Reset of the Equipment”.
  • Page 81 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-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”.
  • Page 82 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 high inside 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.
  • Page 83 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”. To shut down the system: Use the BSSysShut function.
  • Page 84 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.
  • Page 85 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 the status 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.
  • Page 86 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 to notify a media error. You need to have administrator privileges to specify ON or OFF for this option and change the setting.
  • Page 87 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 is displayed, and the command returns an exit code other than 0. Table 5-3 Error Messages of the raidctrl Command Error message Description...
  • Page 88 6. LIBRARY FUNCTIONS CHAPTER 6 LIBRARY FUNCTIONS A user application can get and control the hardware status of this equipment by using the RAS library. 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.
  • Page 89 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.
  • Page 90 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.
  • Page 91 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 to generate timeout is longer than the timeout value set by the application.
  • Page 92 6. LIBRARY FUNCTIONS 6.1.4 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 (file name: 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.
  • Page 93 6. LIBRARY FUNCTIONS <Sample program> We provide a sample program that uses this function in C. For information about the name of the sample 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.
  • Page 94 6. LIBRARY FUNCTIONS 6.1.5 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 stores the drive conditions.
  • Page 95 6. LIBRARY FUNCTIONS Note that if multiple conditions exist at the same time, the logical sum of the values shown in Table 6-3 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>...
  • Page 96 6. LIBRARY FUNCTIONS 6.1.6 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.
  • Page 97 6. LIBRARY FUNCTIONS Level stores the RAID level. The meaning of each value that can be stored in Level is as follows. Table 6-4 Values Stored in Level in the HFB_ARRAY_STATUS Structure Defined value Description HFB_RAID1 (0x00000001) RAID 1 is set up. DiskNumber stores the value that indicates the drive bays used by the RAID.
  • Page 98 6. LIBRARY FUNCTIONS Possible combinations are as follows. Table 6-7 Possible Combinations that can be Stored in Status in the HFB_ARRAY_STATUS Structure RAID status Detailed information HFB_RAID_OPTIMAL None HFB_RAID_MEDIA_ERROR HFB_RAID_DEGRADE None HFB_RAID_MEDIA_ERROR HFB_RAID_REBUILD HFB_RAID_REBUILD | HFB_RAID_MEDIA_ERROR HFB_RAID_UNKNOWN None HFB_RAID_FAIL None No.8: The system cannot operate normally, and the value may not be acquired.
  • Page 99 6. LIBRARY FUNCTIONS 6.1.7 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 the status display digital LEDs, the value specified by this function is displayed in hexadecimal.
  • Page 100 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>...
  • Page 101 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”...
  • Page 102 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 or check the operation of those functions. The following Table 6-9 shows a list of sample programs.
  • Page 103 This Page Intentionally Left Blank...
  • Page 104 (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-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002). NOTICE CPU load increases while memory dump files are being collected.
  • Page 105 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 of those two, clear the check box for the one you do not need, and then click Continue.
  • Page 106 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.
  • Page 107 You can also use the log information collection window and the logsave command to collect 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-BT1000 INSTRUCTION MANUAL (manual number BT-62-0002)”.
  • Page 108 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 “---”.
  • Page 109 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.
  • Page 110 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 the number you typed is out of range, the following message is displayed to prompt you to type a correct number.
  • Page 111 This Page Intentionally Left Blank...
  • Page 112 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.
  • Page 113 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 in simulation mode for business use. Use the simulation function only for testing a user application and checking the notification interface of the RAS software.
  • Page 114 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”, the Simulation Tool window appears on the screen. You can use this window to simulate the condition of hardware devices.
  • Page 115 8. SIMULATING THE HARDWARE STATUS (2) Starting the simulation mode To start the simulation mode, run the simulation mode start command (simrasstart command) 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.
  • Page 116 8. SIMULATING THE HARDWARE STATUS 5. The Simulation Tool window appears. After this point on, this equipment runs in simulation 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.)
  • Page 117 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.
  • Page 118 8. SIMULATING THE HARDWARE STATUS Status Shows the currently set status of each simulated hardware device. The following shows a list of statuses for each hardware device. Target Status Case fan, CPU fan Normal, Error Internal Temperature Normal, Error Drive bay1, Drive bay2 Healthy, SMART Detected, Overrun, Offline (*1), Rebuild (*1), Not Connected (*2)
  • Page 119 8. SIMULATING THE HARDWARE STATUS 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.
  • Page 120 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.
  • Page 121 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.
  • Page 122 8. SIMULATING THE HARDWARE STATUS <D Model> Current status Statuses in the popup menu Note Healthy (*1) Healthy, SMART Detected, Overrun, Offline SMART Detected SMART Detected, Offline (*2) Overrun Overrun, Offline (*2) Offline Offline, Rebuild Rebuild Healthy, Offline, Rebuild (*3) (*4) (*1) If the RAID status is “Degrade”, “Offline”...
  • Page 123 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.
  • Page 124 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.
  • Page 125 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.
  • Page 126 APPENDIX A RUNNING COMMAND PROMPT AS AN ADMINISTRATOR APPENDIX A RUNNING 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.
  • Page 127 This Page Intentionally Left Blank...
  • Page 128 APPENDIX B CHECKING THE RAS SOFTWARE VERSION APPENDIX 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.
  • Page 129 This Page Intentionally Left Blank...