Table of Contents

Advertisement

Quick Links

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

Advertisement

Table of Contents
loading

Summary of Contents for Qsan 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 Copyright © Copyright 2017 QSAN Technology, Inc. All rights reserved. No part of this document may be reproduced or transmitted without written permission from QSAN Technology, Inc. January 2017 This edition applies to QSAN XCubeDAS series CLI (Command-Line Interface). QSAN believes the information in this publication is accurate as of its publication date.
  • Page 3: Notices

    Information contained in this manual has been reviewed for accuracy. But it could include typographical errors or technical inaccuracies. Changes are made to the document periodically. These changes will be incorporated in new editions of the publication. QSAN may make improvements or changes in the products. All features, functionality, and product specifications are subject to change without prior notice or obligation.
  • Page 4 To illustrate them as completely as possible, the examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 5: Table Of Contents

    Table of Contents Notices ..........................i Preface .......................... vii About This Manual ......................... vii Related Documents ........................vii Technical Support .......................... vii Information, Tip, and Caution ....................... viii Conventions ........................... viii Getting Started with CLI ..................1 1.1. System Requirement and Setup ..................1 1.2.
  • Page 6 Support and Other Resources................37 3.1. Getting Technical Support ....................37 3.2. Accessing Product Updates ..................... 37 3.3. Documentation Feedback ....................38 Appendix ........................39 End-User License Agreement (EULA) ..................39 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 7 Figures Figure 1-1 Appearance of a Console Cable ..................1 Figure 1-2 Connect the Console Cable ..................... 2 Figure 1-3 The Procedures of 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 .............
  • Page 8 Table 2-1 Port Description ......................14 Table 2-2 Temperature Sensor Description .................. 32 Table 2-3 Voltage Description ......................33 Table 2-4 Fan Description ....................... 34 Table 2-5 Fan Description ....................... 35 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 9: Preface

    XCubeDAS CLI User’s Manual  Compatibility Matrix White Papers   Application Notes Technical Support Do you have any questions or need help trouble-shooting a problem? Please contact QSAN Support, we will reply to you as soon as possible. Preface...
  • Page 10: Information, Tip, And Caution

    The following table describes the typographic conventions used in this manual. Conventions Description Bold Indicates text on a window, other than the window title, including menus, menu options, buttons, fields, and labels. Example: Click the OK button. viii © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 11 <Italic> Indicates a variable, which is a placeholder for actual text provided by the user or system. Example: copy <source-file> <target-file>. [ ] square Indicates optional values. brackets Example: [ a | b ] indicates that you can choose a, b, or nothing. { } braces Indicates required or expected values.
  • Page 13: Getting Started With Cli

    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.
  • Page 14: Figure 1-2 Connect The Console Cable

    3. Here we first demonstrate HyperTerminal. The console settings are on the following. Baud rate: 115200, 8 data bit, no parity, 1 stop bit, and no flow control Terminal type: vt100 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 15 Getting Started with CLI...
  • Page 16: Figure 1-3 The Procedures Of Setup Serial Console By Hyperterminal

    Figure 1-3 The Procedures of Setup Serial Console by HyperTerminal 4. If you are using PuTTY instead, please refer to below © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 17: Figure 1-4 The Procedures Of Setup Serial Console By Putty

    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. Getting Started with CLI...
  • Page 18: How To Use Cli

    Identify the system or the disk drive slot Section 2.4.4 logout Exit CLI Section 2.4.7 port Show the status and WWN of SAS ports Section 2.3.1 Show PSU information of the system Section 2.6.3 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 19 reboot Reboot the system Section 2.4.5 rtdft Restore all settings to factory default Section 2.4.3 sensor Show temperature, voltage, PSU, and fan information Section 2.6.5 setpwd Change the password Section 2.2.3 shutdown Shutdown the system Section 2.4.6 Show system information Section 2.4.1 sysname...
  • Page 20: Cli Command Sets

    Command help Description Display all supported commands or specific command’s usage. Syntax help [<command>] Parameters <command> Optional. Show the usage of the specific CLI command. Example 1. List all supported commands © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 21: General System Settings

    CLI > help ------------------------------------------------------------------------------ Command Description ------------------------------------------------------------------------------ buzzer Turn off system buzzer clrlog Clear all event logs of the system date Set the system time or show the system time disk Show installed disk information (slot location, vendor, model) evtlog Display event logs of the system Show cooling fan information fwdl...
  • Page 22: Set The System Name (Sysname)

    Show the current system name, and then change it. CLI > sysname The system name is XD5300-D402E8 CLI > sysname set QSANDAS-001 The current system name is QSANDAS-001 CLI > sysname The system name is QSANDAS-001 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 23: Set Date And Time (Date)

    2.2.2. Set Date and Time (date) Command date Description Show or set the system date and time. Syntax date [set <YYYYMMDDHHMMSS>] Parameters set <YYYYMMDDHHMMSS> Optional. Specify 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)
  • Page 24: Set Password (Setpwd)

    The new password is set to QSANadmin CLI > setpwd Current password is QSANadmin 2.2.4. Assign an Enclosure ID (id) Command Description Assign an enclosure ID number to the system for management. © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 25: Storage Management

    Syntax id [<enclosureID>] Parameters <enclosureID> Optional, set enclosure id number. The enclosure ID is a number ranges from 1 to 15. Example Set the system’s enclosure ID number to 3. CLI > id The system's enclosure ID is 1 CLI > id 5 Set the system's enclosure ID number to 5 CLI >...
  • Page 26: Show Disk Information (Disk)

    6G: The connection is SAS2 6Gb/s. DOWN: No connection to this port.  2.3.2. Show Disk Information (disk) Command disk Description Show the information of all installed drives in the system. Syntax © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 27: Set Zone Configurations (Zone)

    disk Parameters none Example Show the installed drives status. CLI > disk Quantity of installed drive: 8 Slot Vendor Model Link Type --------------------------------------------------------------------------- TOSHIBA AL14SEB120N 500003963823B652 TOSHIBA AL14SEB120N 500003963823B64E TOSHIBA AL14SEB120N 500003963823B52E TOSHIBA AL14SEB120N 500003963823B656 SEAGATE ST500NM0001 5000C50041C2FCBD SEAGATE ST500NM0001 5000C500420D54C1 SEAGATE ST500NM0001...
  • Page 28 1. Display the current zoning of the system. The default zoning setting is that all SAS ports can access all disk drives. CLI > zone ------------------------------------------------------------------------------ Current Zoning ------------------------------------------------------------------------------ Port# Accessible Drive Slot# --------------------------------------- The SAS zoning diagram is on the following. © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 29: Figure 2-1 All Sas Ports Access All Disk Drives Diagram

    Figure 2-1 All SAS Ports Access All Disk Drives Diagram 2. Set SAS ports and disk 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.
  • Page 30: Figure 2-2 Sas Ports And Disk Drives Divided Into Two Groups Diagram

    New Zoning ------------------------------------------------------------------------------ Port# Accessible Drive Slot# --------------------------------------- 1 2 3 4 5 6 7 8 9 10 11 12 1 2 3 4 5 6 7 8 9 10 11 12 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 31 Notice! You must reset system to take effect... CLI > zone set h3 h4 h5 13 14 15 16 17 18 19 20 21 22 23 24 ------------------------------------------------------------------------------ Original Zoning ------------------------------------------------------------------------------ Port# Accessible Drive Slot# --------------------------------------- 1 2 3 4 5 6 7 8 9 10 11 12 1 2 3 4 5 6 7 8 9 10 11 12 ------------------------------------------------------------------------------ New Zoning...
  • Page 32: Figure 2-3 Sas Ports And Disk Drives Divided Into Five Groups Diagram

    CLI > zone set h2 6 7 8 9 10 CLI > zone set h3 11 12 13 14 15 CLI > zone set h4 16 17 18 19 20 CLI > zone set h5 21 22 23 24 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 33: Maintenance

    ------------------------------------------------------------------------------ New Zoning ------------------------------------------------------------------------------ Port# Accessible Drive Slot# --------------------------------------- 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 Notice! You must reset system to take effect... 4.
  • Page 34: Firmware Download (Fwdl)

    2.4.2. Firmware Download (fwdl) Command fwdl Description Download firmware code for upgrade. Use XModem protocol to transmit the file to the firmware region. Please prepare new controller firmware file named “xxxx.bin” in local hard © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 35 drive. You may use UART communication tool like HyperTerminal to select the firmware file. After firmware downloading, it needs to reboot system to take effect. Syntax fwdl Parameters None Example Firmware upgrade procedures are on the following. 1. Download new firmware code. CLI >...
  • Page 36: Reset To Factory Defaults (Rtdft)

    Send 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/download 2.4.3. Reset to Factory Defaults (rtdft) Command rtdft Description ©...
  • Page 37: Identify The System Or The Disk Drive Slot (Ident)

    Restore the system name, password, event log and zone setting to factory default settings. All event logs will also be cleared. Syntax rtdft Parameter none Example Restore password and serial number to factory default. CLI > rtdft The system name, password, event log, zone setting are restored to default settings You must reset system to take effect...
  • Page 38: Reboot The System (Reboot)

    For the front and rear view about the UID LEDs, please refer to chapter 2, System Components Overview in the XCubeDAS Hardware Owner’s Manual. 2.4.5. Reboot the System (reboot) Command reboot Description © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 39: Shutdown The System (Shutdown)

    Reboot the system to make the setting effective. Syntax reboot Parameters none Example Reboot the system. 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.
  • Page 40: Logout (Logout)

    Log Center This section includes the following command sets. evtlog: Show event logs of the system   clrlog: Clear all event logs of the system buzzer: Turn off the buzzer  © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 41: Show Event Logs (Evtlog)

    2.5.1. Show Event Logs (evtlog) Command evtlog Description Show the system event logs for analysis or maintenance. Syntax 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:57.135>:CTRL 1:IPC became ready 2.5.2.
  • Page 42: Mute The Buzzer (Buzzer)

    Parameter Set off to turn off buzzer Example Mute the buzzer. CLI > buzzer off The system's buzzer is off 2.6. Monitoring the Enclosure This section includes the following command sets. © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 43: Show Temperature Information (Temp)

    temp: Show temperature information of the system  volt: Show voltage information of the system   psu: Show PSU (Power Supply Unit) information of the system fan: Show fan information of the system  sensor: Show temperature, voltage, PSU, and fan information ...
  • Page 44: Show Voltage Information (Volt)

    WARN: The thermal sensor detected a warning error condition.  FAIL: The thermal sensor is not accessible.  2.6.2. Show Voltage Information (volt) Command volt Description Show the voltage sensors information of the system. Syntax volt Parameters none Example © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 45: Show Psu Information (Psu)

    Check the 16 voltage sensors in system. CLI > volt Quantity of voltage sensors: 16 Voltage Sensor Value Status ----------------------------------------------- Ctrl 1 Volt +3.3V 3.32V Ctrl 1 Volt +12V 12.24V Ctrl 1 Volt +5V standby 5.10V Ctrl 1 Volt +3.3V standby 3.32V Ctrl 1 Volt +1.8V 1.81V...
  • Page 46: Show Fan Information (Fan)

     FAIL: The PSU is not accessible or abnormal.  2.6.4. Show Fan Information (fan) Command Description Show the information of cooling devices. Syntax Parameters none Example Show the fan speed. © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 47: Show Sensors Information (Sensor)

    CLI > fan Quantity of cooling fan: 4 Cooling Fan Status ---------------------------------------- FAN 1 5465 FAN 2 5443 FAN 3 5443 FAN 4 5465 Table 2-5 Fan Description Column Name Description Status The status of the fan:  OK: The fan module is present and work correctly. ...
  • Page 48 Quantity of power supply unit: 2 Power Supply Status -------------------------- PSU 1 PSU 2 Quantity of cooling fan: 4 Cooling Fan Status ---------------------------------------- FAN 1 5465 FAN 2 5443 FAN 3 5443 FAN 4 5465 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
  • Page 49: Support And Other Resources

    Information for Technical Support The following system information is necessary for technical support, please refer to following for what and where to get the information of your XCubeDAS series model. 3.2. Accessing Product Updates To download product updates, please visit QSAN website: https://qsan.com/download...
  • Page 50: Documentation Feedback

    3.3. Documentation Feedback QSAN is committed to providing 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, include the document title, part number, revision, and publication date located on the front cover of the document.
  • Page 51: Appendix

    EULA. Any right beyond this EULA will not be granted. Intellectual Property Right Intellectual property rights relative to the Product are the property of QSAN or its licensor(s). User will not acquire any intellectual property by this EULA.
  • Page 52 WARRANTY OF ANY KIND. QSAN MAKES NO WARRANTY THAT THE PRODUCT WILL BE FREE OF BUGS, ERRORS, VIRUSES OR OTHER DEFECTS. IN NO EVENT WILL QSAN BE LIABLE FOR THE COST OF COVER OR FOR ANY DIRECT, INDIRECT, SPECIAL, PUNITIVE, INCIDENTAL, CONSEQUENTIAL OR SIMILAR DAMAGES OR...
  • Page 53 QSAN may assign its rights and obligations under this EULA to any third party without  condition.  This EULA 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 ...

Table of Contents