Qsan XCubeDAS Series User manual

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

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. 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.
Microsoft, Windows, Windows Server, and Hyper-V are trademarks or registered trademarks of
Microsoft Corporation in the United States and/or other countries.
Other trademarks and trade names used in this document to refer to either the entities claiming the
marks and names or their products are the property of their respective owners.

Notices i
Notices
This XCubeDAS hardware owner’s manual is applicable to the following XCubeDAS models:
XCubeDAS Storage System 4U 19” Rack Mount Models
Model Name
Controller Type
Form Factor, Bay Count, and Rack Unit
XD5324D
Dual Controller
LFF 24-disk 4U Chassis
XD5324S
Single Controller
LFF 24-disk 4U Chassis
XCubeDAS Storage System 3U 19”Rack Mount Models
Model Name
Controller Type
Form Factor, Bay Count, and Rack Unit
XD5316D
Dual Controller
LFF 16-disk 3U Chassis
XD5316S
Single Controller
LFF 16-disk 3U Chassis
XCubeDAS Storage System 2U 19”Rack Mount Models
Model Name
Controller Type
Form Factor, Bay Count, and Rack Unit
XD5312D
Dual Controller
LFF 12-disk 2U Chassis
XD5312S
Single Controller
LFF 12-disk 2U Chassis
XD5326D
Dual Controller
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 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. All statements,
information, and recommendations in this document do not constitute a warranty of any
kind, express or implied.
Any performance data contained herein was determined in a controlled environment.
Therefore, the results obtained in other operating environments may vary significantly.
Some measurements may have been made on development-level systems and there is no
guarantee that these measurements will be the same on generally available systems.

ii © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
Furthermore, some measurements may have been estimated through extrapolation. Actual
results may vary. Users of this document should verify the applicable 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 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.

Contents iii
Table of Contents
Notices ............................................................................................................................ i
Preface ..........................................................................................................................vii
About This Manual .........................................................................................................................vii
Related Documents........................................................................................................................vii
Technical Support ..........................................................................................................................vii
Information, Tip, and Caution .......................................................................................................viii
Conventions...................................................................................................................................viii
1. Getting Started with CLI .......................................................................................... 1
1.1. System Requirement and Setup ........................................................................................ 1
1.2. How to Use CLI.................................................................................................................... 6
1.3. CLI Commands ................................................................................................................... 6
2. CLI Command Sets ................................................................................................. 8
2.1. Get Help (help) .................................................................................................................... 8
2.2. General System Settings .................................................................................................... 9
2.2.1. Set the System Name (sysname) ..................................................................... 10
2.2.2. Set Date and Time (date)................................................................................... 11
2.2.3. Set 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. Maintenance...................................................................................................................... 21
2.4.1. Show System Information (sys)........................................................................ 21
2.4.2. Firmware Download (fwdl) ................................................................................ 22
2.4.3. Reset to Factory Defaults (rtdft) ....................................................................... 24
2.4.4. Identify the System or the Disk Drive Slot (ident) ............................................ 25
2.4.5. Reboot the System (reboot) .............................................................................. 26
2.4.6. Shutdown the System (shutdown).................................................................... 27
2.4.7. Logout (logout)................................................................................................... 28
2.5. Log Center ......................................................................................................................... 28
2.5.1. Show Event Logs (evtlog).................................................................................. 29
2.5.2. Clear Event Logs (clrlog) ................................................................................... 29
2.5.3. Mute the Buzzer (buzzer) .................................................................................. 30
2.6. Monitoring the Enclosure ................................................................................................. 30

iv © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
2.6.1. Show Temperature Information (temp)............................................................ 31
2.6.2. Show Voltage 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................................................................................................ 37
3.2. Accessing Product Updates............................................................................................. 37
3.3. Documentation Feedback ................................................................................................ 38
Appendix....................................................................................................................... 39
End-User License Agreement (EULA) .......................................................................................... 39

Contents v
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 ............................................................. 17
Figure 2-2 SAS Ports and Disk Drives Divided into Two Groups Diagram ................................... 18
Figure 2-3 SAS Ports and Disk Drives Divided into Five Groups Diagram.................................... 20
Figure 2-4 Send File.......................................................................................................................... 24

vi © Copyright 2017 QSAN Technology, Inc. All Right 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 Fan Description............................................................................................................... 34
Table 2-5 Fan Description............................................................................................................... 35

Preface vii
Preface
About This Manual
This manual provides technical guidance for designing and implementing QSAN XCubeDAS
series DAS system, and it is intended for use by system administrators, DAS designers,
storage consultants, or anyone who has purchased these products and is familiar with
servers and computer networks, network administration, storage system installation and
configuration, storage area network management, and relevant protocols.
CAUTION:
Do NOT attempt to service, change, disassemble 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 follow the instructions in this owner’s manual.
Related Documents
There are related documents which can be downloaded from the website.
All XCubeDAS Documents
XCubeDAS QIG (Quick Installation Guide)
XCubeDAS Hardware Owner’s Manual
XCubeDAS CubeView User’s Manual
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.

viii © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
Via the Web: https://qsan.com/support
Via Telephone: [phone] extension 136
(Service hours: 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: [e-mail]
Information, Tip, and Caution
This manual uses the following symbols to draw attention to important safety and
operational information.
INFORMATION:
INFORMATION provides useful knowledge, definition, or terminology for
reference.
TIP:
TIP provides helpful suggestions for performing tasks more effectively.
CAUTION:
CAUTION indicates that failure to take a specified action could result in
damage to the system.
Conventions
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.

Preface ix
<Italic>
Indicates a variable, which is a placeholder for actual text provided
by the user or system.
Example: copy <source-file> <target-file>.
[ ] square
brackets
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
Indicates that you have a choice between two or more options or
arguments.
/ Slash
Indicates all options or arguments.
underline
Indicates the default value.
Example: [ a | b ]

Getting Started with CLI 1
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.

2 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
Figure 1-2 Connect the Console Cable
2. You must use terminal software such as HyperTerminal or Putty to open 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 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

Getting Started with CLI 3

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

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.

6 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
1.2. How to Use CLI
Syntax of CLI
A CLI command consists of the following elements: CLI command, sub command and
arguments.
The following is the syntax of a CLI command:
CLI-command [Sub-command] [Arguments]
Table 1-1 Command Line Description
Item
Description
CLI-command
The function name
Sub-command
Combine with CLI-command to clarify operation
Arguments
Maybe none, single or multiple
1.3. CLI Commands
The supported CLI commands are listed on the following table.
Table 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
Show disk drive information
Section 2.3.2
evtlog
Show event logs of the system
Section 2.5.1
fan
Show fan information of the system
Section 2.6.4
fwdl
Download firmware for upgrade
Section 2.4.2
help
List all supported commands or list the usage of a
specific command
Section 2.1
id
Assign an enclosure ID
Section 2.2.4
ident
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
psu
Show PSU information of the system
Section 2.6.3

Getting Started with CLI 7
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
sys
Show system information
Section 2.4.1
sysname
Show or set the system name
Section 2.2.1
temp
Show temperature information of the system
Section 2.6.1
volt
Show voltage information of the system
Section 2.6.2
zone
Show zone settings or set zone configuration
Section 2.3.3

8 © Copyright 2017 QSAN Technology, Inc. All Right Reserved.
2. CLI Command Sets
This chapter is to help you find a command by name. Each command topic includes one or
more of the following sections:
Command The command
Description The command’s purpose 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 following.
2.1. Get Help (help)
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