background image

 

 

 

Getting Started with CLI

 

1.

 

Getting Started with CLI 

 

Thank you for purchasing QSAN Technology, Inc. products. XCubeDAS XD5300 series CLI 
(Command-Line Interface) are intended for system administrators, developers, or engineers 
to manage the system. It provides command sets to set system settings, show SAS ports 
and disk drives status, set zone configurations, show system information, download and 
upgrade firmware, monitor system log, and enclosure information including system 
temperature, voltage, PSU (Power Supply Unit), and fan speed. 

1.1.

 

System Requirement and Setup 

The XD5300 series uses the console port as the command line interface. Please use the 
console cable in the accessory box, and connect it between the controller and the 
server/host. The CLI function can be accessed by using terminal emulator on a 
management host that directly connected to the serial port of the XCubeDAS series. 

The following procedure will help you to setup the serial console via the console cable that 
is enclosed in the shipping carton. The following image is the appearance of the console 
cable. 

 

 

Figure 1-1 

Appearance of a Console Cable 

 

Procedures to Setup the Serial Console

 

1.

 

Setup the serial cable between the controller and one server/host like in the below 
image. 

 

Summary of Contents for XCubeDAS Series

Page 1: ...XCubeDAS Series CLI User s Manual Applicable Models XD5324D XD5324S XD5316D XD5316S XD5312D XD5312S XD5326D XD5326S QSAN Technology Inc www QSAN com...

Page 2: ...of its publication date The information is subject to change without notice Trademarks QSAN the QSAN logo XCubeDAS and QSAN com are trademarks or registered trademarks of QSAN Technology Inc Microsof...

Page 3: ...r SFF 26 disk 2U Chassis XD5326S Single Controller SFF 26 disk 2U Chassis Information contained in this manual has been reviewed for accuracy But it could include typographical errors or technical ina...

Page 4: ...pplicable data for their specific environment This information contains examples of data and reports used in daily business operations To illustrate them as completely as possible the examples include...

Page 5: ...Password setpwd 12 2 2 4 Assign an Enclosure ID id 12 2 3 Storage Management 13 2 3 1 Show SAS Port Information port 13 2 3 2 Show Disk Information disk 14 2 3 3 Set Zone Configurations zone 15 2 4 Ma...

Page 6: ...oltage Information volt 32 2 6 3 Show PSU Information psu 33 2 6 4 Show Fan Information fan 34 2 6 5 Show Sensors Information sensor 35 3 Support and Other Resources 37 3 1 Getting Technical Support 3...

Page 7: ...Setup Serial Console by HyperTerminal 4 Figure 1 4 The Procedures of Setup Serial Console by PuTTY 5 Figure 2 1 All SAS Ports Access All Disk Drives Diagram 17 Figure 2 2 SAS Ports and Disk Drives Di...

Page 8: ...Reserved Tables Table 1 1 Command Line Description 6 Table 1 2 CLI Command List 6 Table 2 1 Port Description 14 Table 2 2 Temperature Sensor Description 32 Table 2 3 Voltage Description 33 Table 2 4...

Page 9: ...isassemble or upgrade the equipment s components by yourself Doing so may violate your warranty and expose you to electric shock Refer all servicing to authorized service personnel Please always follo...

Page 10: ...draw attention to important safety and operational information INFORMATION INFORMATION provides useful knowledge definition or terminology for reference TIP TIP provides helpful suggestions for perfor...

Page 11: ...Indicates optional values Example a b indicates that you can choose a b or nothing braces Indicates required or expected values Example a b indicates that you must choose either a or b vertical bar In...

Page 12: ......

Page 13: ...eed 1 1 System Requirement and Setup The XD5300 series uses the console port as the command line interface Please use the console cable in the accessory box and connect it between the controller and t...

Page 14: ...the console after the connection is made INFORMATION For more information about terminal software please refer to HyperTerminal http www hilgraeve com hyperterminal PuTTY http www putty org 3 Here we...

Page 15: ...Getting Started with CLI 3...

Page 16: ...4 Copyright 2017 QSAN Technology Inc All Right Reserved Figure 1 3 The Procedures of Setup Serial Console by HyperTerminal 4 If you are using PuTTY instead please refer to below...

Page 17: ...Getting Started with CLI 5 Figure 1 4 The Procedures of Setup Serial Console by PuTTY 5 Users should be able to login the controller system via console cable by following the procedures above...

Page 18: ...1 2 CLI Command List Command Description Details buzzer Turn off the buzzer Section 2 5 3 clrlog Clear all event logs of the system Section 2 5 2 date Show or set the system time Section 2 2 2 disk Sh...

Page 19: ...ion Section 2 6 5 setpwd Change the password Section 2 2 3 shutdown Shutdown the system Section 2 4 6 sys Show system information Section 2 4 1 sysname Show or set the system name Section 2 2 1 temp S...

Page 20: ...pose and note about usage Syntax The command s syntax Parameters Descriptions of command s parameters Example One or more examples of command s usage The usage of each CLI command is described in the...

Page 21: ...boot Reboot the system rtdft Reset all setting to factory default sensor Display system s sensors information serv Change service port output setpwd Change the password shutdown Shutdown the system sy...

Page 22: ...ame Optional specify the system name for easy recognition The default system name is the model name plus the last 6 digits of serial number e g XD5300 D40000 The maximum length of the system name is 3...

Page 23: ...fy the system date and time YYYY the year MM the month DD the day number 1 31 HH the hour 0 23 MM the minutes 0 59 SS the seconds 0 59 Example Show the current system date and time and then change it...

Page 24: ...ew password to access the system factory default is 1234 The maximum length of the password is 16 characters Valid characters are A Z a z 0 9 _ Example CLI setpwd Current password is 1234 CLI setpwd Q...

Page 25: ...closure ID is 1 CLI id 5 Set the system s enclosure ID number to 5 CLI id The system s enclosure ID is 5 2 3 Storage Management This section includes the following command sets port Show the status an...

Page 26: ...RL1 Port 5 DOWN CTRL2 Port 1 DOWN CTRL2 Port 2 12G 500605B00929A321 CTRL2 Port 3 DOWN CTRL2 Port 4 DOWN CTRL2 Port 5 DOWN Table 2 1 Port Description Column Name Description LINK The connection link ra...

Page 27: ...GATE ST500NM0001 6G SAS 5000C500420D54C1 07 SEAGATE ST500NM0001 6G SAS 5000C50041C292B5 08 SEAGATE ST500NM0001 6G SAS 5000C50041C34281 09 SEAGATE ST500NM0001 6G SAS 5000C50041B655F1 10 SEAGATE ST500NM...

Page 28: ...ing settings 3 set set zone configuration h1 h2 h3 h4 h5 hX indicate SAS port X 1 2 3 4 5 N N indicates drive slot N specify all drive slots Example 1 Display the current zoning of the system The defa...

Page 29: ...isk drives which are divided into two groups You can configure the zoning setting for each port according to requirement Here is an example of two zones of SAS ports and disk drives SAS port 1 and 2 c...

Page 30: ...ivided into Two Groups Diagram The SAS zoning configuration is on the following CLI zone set h1 h2 1 2 3 4 5 6 7 8 9 10 11 12 Original Zoning Port Accessible Drive Slot 1 All 2 All 3 All 4 All 5 All N...

Page 31: ...11 12 3 13 14 15 16 17 18 19 20 21 22 23 24 4 13 14 15 16 17 18 19 20 21 22 23 24 5 13 14 15 16 17 18 19 20 21 22 23 24 Notice You must reset system to take effect 3 Set SAS ports and disk drives whic...

Page 32: ...gure 2 3 SAS Ports and Disk Drives Divided into Five Groups Diagram The SAS zoning configuration is on the following CLI zone set h1 1 2 3 4 5 CLI zone set h2 6 7 8 9 10 CLI zone set h3 11 12 13 14 15...

Page 33: ...r Clear current zoning and set to default zoning You must reset system to take effect 2 4 Maintenance This section includes the following command sets sys Show system information fwdl Download firmwar...

Page 34: ...ID XD5300 Backplane ID QW424 Enclosure Logical Identifier 5001378000124690 Enclosure Product Serial No QW42401378124690 Firmware Information Revision 1 0 0 Creation Time 2017 01 19 03 28 22 Manufactu...

Page 35: ...re upgrade procedures are on the following 1 Download new firmware code CLI fwdl Please Use XModem Protocol for File Transmission Use Q Or q to quit Download before starting XModem 2 Use HyperTerminal...

Page 36: ...nd File 3 After the transmission completes reboot the system to tack effect CLI reboot System will reboot later INFORMATION To download the product firmware please visit QSAN website https qsan com do...

Page 37: ...red to default settings You must reset system to take effect 2 4 4 Identify the System or the Disk Drive Slot ident Command idnet Description Identify system or disk drive slot for maintenance or mana...

Page 38: ...D later CLI ident system on The system s UID LED is on CLI ident system off The system s UID LED is off 2 Identify the drive slot 3 for maintenance use Blinking amber LED on drive slot 3 CLI ident slo...

Page 39: ...stem CLI reboot System will reboot later TIP In dual controller model reboot the system will reboot the controller 1 first and then controller 2 after 30 seconds 2 4 6 Shutdown the System shutdown Com...

Page 40: ...shut down later 2 4 7 Logout logout Command logout Description Exit CLI Syntax logout Parameters None Example Logout to exit CLI CLI logout 2 5 Log Center This section includes the following command s...

Page 41: ...x evtlog Parameter none Example Show system event logs CLI evtlog Jan 18 2017 03 57 56 237 PLATFORM Firmware initialization started Jan 18 2017 03 57 56 259 CTRL 1 Peer ctrl present Jan 18 2017 03 57...

Page 42: ...he system s event logs are cleared 2 5 3 Mute the Buzzer buzzer Command buzzer Description Turn off the buzzer Syntax buzzer off Parameter off Set off to turn off buzzer Example Mute the buzzer CLI bu...

Page 43: ...m sensor Show temperature voltage PSU and fan information INFORMATION For more information about system components please refer to chapter 2 System Components Overview in the XCubeDAS Hardware Owner s...

Page 44: ...9C OK 75 65 5 0 Ctrl 2 SAS Expander 65C OK 95 90 5 0 Backplane Location Left 30C OK 70 65 5 0 Backplane Location Middle 34C OK 70 65 5 0 Backplane Location Right 29C OK 70 65 5 0 Table 2 2 Temperature...

Page 45: ...3 3V standby 3 32V OK Ctrl 2 Volt 1 8V 1 81V OK Ctrl 2 Volt 0 9V 0 92V OK Backplane 12V 12 00V OK Backplane 5V 5 05V OK Backplane 3 3V 3 30V OK Backplane 3 3V standby 3 31V OK Table 2 3 Voltage Descri...

Page 46: ...2 Power Supply Status PSU 1 OK PSU 2 OK Table 2 4 Fan Description Column Name Description Status The status of the PSU OK The PSU is present and work correctly FAIL The PSU is not accessible or abnor...

Page 47: ...e status of the fan OK The fan module is present and work correctly FAIL The fan module is not accessible or abnormal behavior 2 6 5 Show Sensors Information sensor Command sensor Description Show all...

Page 48: ...Location Middle 34C OK 70 65 5 0 Backplane Location Right 29C OK 70 65 5 0 Quantity of voltage sensors 16 Voltage Sensor Value Status Ctrl 1 Volt 3 3V 3 32V OK Ctrl 1 Volt 12V 12 24V OK Ctrl 1 Volt 5V...

Page 49: ...s 09 30 18 00 Monday Friday UTC 8 Via Skype Chat Skype ID qsan support Service hours 09 30 02 00 Monday Friday UTC 8 Summer time 09 30 01 00 Via Email support qsan com Information to Collect Product n...

Page 50: ...oviding documentation that meets and exceeds your expectations To help us improve the documentation email any errors suggestions or comments to docsfeedback qsan com When submitting your feedback incl...

Page 51: ...ive non transferable non distributable non assignable non sub licensable license to install and use the Product pursuant to the terms of this EULA Any right beyond this EULA will not be granted Intell...

Page 52: ...DAMAGES OR LIABILITIES WHATSOEVER INCLUDING BUT NOT LIMITED TO LOSS OF DATA INFORMATION REVENUE PROFIT OR BUSINESS ARISING OUT OF OR RELATING TO THE USE OR INABILITY TO USE THE PRODUCT OR OTHERWISE UN...

Page 53: ...LA will be binding upon and will inure to User s successors and permitted assigns This EULA shall be governed by and constructed according to the laws of R O C Any disputes arising from or in connecti...

Reviews: