QNAP SAS JBOD CLI 1.0 User manual

SAS JBOD CLI 1.0
TL-R1220Sep-RP
TL-R1620Sep-RP
User Guide
Document Version: 1
15/03/2021

Contents
1. Setting Up Access to the CLI
2. Accessing the CLI from a Terminal Emulator
3. Conventions and CLI Commands
Device Access.............................................................................................................................................. 5
Help.......................................................................................................................................................... 5
Log Out Shell............................................................................................................................................6
Nickname..................................................................................................................................................6
Set Password........................................................................................................................................... 7
System Commands.......................................................................................................................................7
System Info...............................................................................................................................................7
System Status.......................................................................................................................................... 8
Get SAS Address..................................................................................................................................... 8
Route Table Read.....................................................................................................................................9
Display Info for All Physical Layers.......................................................................................................... 9
Display or Reset All Physical Layer Counters........................................................................................ 10
Device Control.............................................................................................................................................11
Link Rate.................................................................................................................................................11
Link Rate Control....................................................................................................................................12
Fan Speed..............................................................................................................................................13
Fan Speed Control................................................................................................................................. 13
Enable or Disable EDFB.........................................................................................................................14
Locate Disk.............................................................................................................................................14
Enable or Disable Buzzer.......................................................................................................................15
Zone....................................................................................................................................................... 15
Reset Expander......................................................................................................................................17
Command-Line Interface User Guide
1

1. Setting Up Access to the CLI
QNAP SAS JBOD enclosures come with a command-line interface (CLI) that you can use to configure the
enclosures from a terminal emulator on a Windows, macOS, or Linux computer.
This task requires a console cable and a USB adapter. The console cable came with your SAS JBOD, but
the USB adpater is a separate purchase. Ensure that a USB connector on the adapter matches a USB port
on your computer.
1. Power on the device.
2. Connect one end of the console cable to the 3.5 mm line-out jack.
For details on the location of the 3.5 mm line-out jack, see the Rear Panel in your SAS JBOD User
Guide.
3. Connect the other end of the console cable to the USB adapter.
4. Locate an open USB port on your computer and plug in the USB connector from the adapter.
Command-Line Interface User Guide
Setting Up Access to the CLI 2

2. Accessing the CLI from a Terminal Emulator
For Windows, you must use a terminal emulator to access the CLI. For macOS and Linux, you can use the
Terminal. QNAP uses Tera Term, an open-source terminal emulator for Windows, for this User Guide. This
task requires that your computer is already successfully connected to the SAS JBOD.
1. Download Tera Term from https://ttssh2.osdn.jp/index.html.en, and then follow the on-screen
instructions to install the software.
2. Open Tera Term.
The Tera Term: New connection window opens.
3. Click Cancel.
4. Go to Setup > Serial Port .
The Tera Term: Serial port setup and connection window opens.
5. Check the port connection.
a.
Right-click , and then select Device Manager.
The Device Manager window opens.
b. Click Ports (COM & LPT), and then check the port connected to the SAS JBOD.
6. Select the Port and Speed.
a. Select the port that is connected to the SAS JBOD.
b. Select 115200 as the speed.
Note
Depending on the terminal emulator you use, you may be required to enter the port and speed.
Command-Line Interface User Guide
Accessing the CLI from a Terminal Emulator 3

7. Optional: Configure the remaining options.
8. Click New open.
9. Press ENTER.
The SAS JBOD connects to Tera Term.
10. Enter the default password.
Note
The default password is 00000000.
You can now use the CLI.
Command-Line Interface User Guide
Accessing the CLI from a Terminal Emulator 4

3. Conventions and CLI Commands
The following table describes the typographic conventions used in the documentation.
Convention Description
[] This convention indicates optional values.
Example: [a | b] indicates that you can choose a, b, or none.
{} This convention indicates required values.
Example: {a | b} indicates that you must choose a or b.
| This convention indicates that you have a choice between two or more
choices.
<> This convention indicates placeholder text that is replaced by the user
or the system.
This following table covers all available CLI commands. Each command topic includes at least three of the
following sections.
Section Description
Description This section describes the purpose of the command.
Command This section is the main or entire command you enter in the CLI.
Syntax This section shows any mandatory or optional parameters you add to
the main command.
For details on how to differentiate between optional or mandatory
parameters, see Conventions.
Parameters This section is any mandatory or optional argument or arguments and
their possible values you enter in the CLI.
Examples This section shows an example or examples of the command in the
CLI.
Device Access
The CLI commands in this section are related to device access.
Help
Description
Display all available commands.
Command
help
Command-Line Interface User Guide
Conventions and CLI Commands 5

Examples
Log Out Shell
Description
Log out of the CLI.
Command
lo
Examples
Nickname
Description
Display or change the device nickname.
Command
nickname
Syntax
nickname [<xxx>]
Parameters
<xxx>
Command-Line Interface User Guide
Conventions and CLI Commands 6

Enter the device's new nickname.
Examples
The following example shows the current nickname of the device and then changes the nickname.
Set Password
Description
Set a new login password for CLI.
Command
setpass
Note
Enter a maximum of eight ASCII characters for the new password.
Examples
The following example sets the new password to 00000000.
System Commands
The CLI commands in this section are related to system control.
System Info
Description
Display system and firmware information.
Command
systeminfo
Command-Line Interface User Guide
Conventions and CLI Commands 7

Examples
System Status
Description
Display the chip and ENC temperatures.
Command
system status
Examples
Get SAS Address
Description
Display the SAS addresses of connected ports.
Command
sasaddr
Examples
Command-Line Interface User Guide
Conventions and CLI Commands 8

Route Table Read
Description
Display the default route and the routes for specific destination addresses.
Command
rtr
Syntax
rtr [d | z | dz]
Parameters
Parameter/Value Description
None Display enabled routes with a non-zero SAS address.
dDisplay disabled routes.
zDisplay routes with no SAS address.
dz Display all routes.
Examples
The following example shows the default output.
Display Info for All Physical Layers
Description
Display information about physical layers.
Command
phyinfo
Syntax
phyinfo [help | edfb | power | up | cable | <phynum>]
Parameters
Parameter/Value Description
None Display the default output.
Command-Line Interface User Guide
Conventions and CLI Commands 9

Parameter/Value Description
help Display phy help information.
edfb Display EDFB information.
power Display power management information.
up Display connected physical layers.
cable Display cable management information.
<phynum> Display number information about specified physical layers.
Examples
The following example shows the default output.
The following example shows cable management information.
Display or Reset All Physical Layer Counters
Description
Display or reset physical layer counters.
Command-Line Interface User Guide
Conventions and CLI Commands 10

Command
counters
Syntax
counters [config | event | reset]
Parameters
Parameter/Value Description
None Display error counters and generic braodcast counters of a physical
layer.
config Display event configuration of a physical layer.
event Display event counters of a physical layer.
reset Reset all counters of a physical layer.
Examples
The following example shows the default output.
Device Control
The CLI commands in this section are related to device commands.
Link Rate
Description
Display the maximum and minimum speed that the SAS JBOD can communicate with other linked devices.
Command-Line Interface User Guide
Conventions and CLI Commands 11

Command
link
Examples
Link Rate Control
Description
Set the highest and lowest speed of a physical layer.
Syntax
link {<phynumber> <maximum speed> <minimum speed>}
Parameters
Parameter/Value Description
<phynumber> Specify the the physical layer number.
<maximum speed> Set the maximum speed.
Note
You can set speeds to 3, 6, or 12.
<minimum speed> Set the minimum speed.
Note
You can set speeds to 3, 6, or 12.
Examples
The following example sets phy 0 to a maximum and minimum speed of six and three.
Command-Line Interface User Guide
Conventions and CLI Commands 12

Fan Speed
Description
Display the name, speed status, current speed, and the overall status of the fan.
Command
fan
Examples
Fan Speed Control
Description
Set the fan speed.
Command
fan
Syntax
fan {<fan speed>}
Parameters
<fan speed>
Enter auto or a number between one to seven.
Examples
The following example changes the fan speed to automatic to match the device's current state.
The following example changes the fan speed to two.
Command-Line Interface User Guide
Conventions and CLI Commands 13

Enable or Disable EDFB
Description
Enable or disable EDFB.
Command
edfb
Syntax
edfb {on | off}
Parameters
Parameter/Value Description
on Enable EDFB.
off Disable EDFB.
Examples
The following example enables and then disables EDFB.
Locate Disk
Description
Locate a disk by its position.
Command
locate
Syntax
locate {<disk number>}
Parameter
<disk number>
Enter a disk number.
Command-Line Interface User Guide
Conventions and CLI Commands 14

Example
The following example locates disk one.
Enable or Disable Buzzer
Description
Enable or disable the buzzer.
Command
buzzer
Syntax
buzzer {on | off}
Parameters
Parameter/Value Description
on Enable the buzzer.
off Disable the buzzer.
Examples
The following example enables and disables the buzzer.
Zone
Description
Configure the zone information.
Command
phyzone
Syntax
phyzone {on | off | default | get | clr <group number> | clr all | <group
number> <start slot> <end slot> <SAS port>}
Command-Line Interface User Guide
Conventions and CLI Commands 15

Parameters
Parameter/Value Description
on Enable the zone.
off Disable the zone.
default Set the zone to the default setting.
get Display the zone status and the current group.
clr Clear the zone settings.
<group number> Set the zone to the specified group number.
Note
Enter a number between zero and seven.
<start slot> Set the zone group to start with the specified slot number.
<end slot> Set the zone group to end with the specified slot number.
<sas port> Set the zone to the specified SAS port.
Note
Enter a SAS port between c1 to c4.
Examples
The following example sets the zone on, off, and to its default setting.
The following example clears all zone settings and then displays the zone status.
The following example clears the settings in zone zero and then displays the zone status.
Command-Line Interface User Guide
Conventions and CLI Commands 16

The following example sets the zone group to zero with a specified start and end slot and SAS port as one,
eight, and c1 and then displays the zone status.
Reset Expander
Description
Reset the device.
Command
reset
Note
After resetting the device, you are required to enter the device password.
Example
Command-Line Interface User Guide
Conventions and CLI Commands 17