Sie sind auf Seite 1von 129

EonNAS Command

Line Interface
User Manual

Version 1.1 (October 2014)


Legal Information
All Infortrend products, including the product customers have purchased from Infortrend, shall be
subject to the latest Standard Warranty Policy available on the Infortrend
website: http://www.infortrend.com/global/Support/Warranty

Infortrend may from time to time modify, update or upgrade the software, firmware or any accompanying
user documentation without any prior notice. Infortrend will provide access to these new software,
firmware or documentation releases from certain download sections of our website or through our
service partners. Customer shall be responsible for maintaining updated version of the software,
firmware or other documentation by downloading or obtaining from Infortrend, and installing designated
updated code, including but not limited to firmware, microcode, basic input/out system code, utility
programs, device drivers, and diagnostics delivered with Infortrend product.

Before installing any software, applications or components provided by a third party, customer should
ensure that they are compatible and interoperable with Infortrend product by checking in advance with
Infortrend. Customer is solely responsible for ensuring the compatibility and interoperability of the third
party’s products with Infortrend product. Customer is further solely responsible for ensuring its systems,
software, and data are adequately backed up as a precaution against possible failures, alternation, or
loss.

For any questions of hardware/ software compatibility, and the update/ upgrade code, customer should
contact Infortrend sales representative or technical support for assistance.

To the extent permitted by applicable laws, Infortrend shall NOT be responsible for any interoperability
or compatibility issues that may arise when (1) products, software, or options not certified and supported
by Infortrend are used; (2) configurations not certified and supported by Infortrend are used; (3) parts
intended for one system are installed in another system of different make or model.

Trademarks Infortrend, the Infortrend logo, SANWatch, ESVA and EonStor are registered
trademarks of Infortrend Technology, Inc. Other names prefixed with “IFT” and
“ES” are trademarks of Infortrend Technology, Inc.

All other names, brands, products or services are trademarks or registered


trademarks of their respective owners.
Contact Information
Customer Support Contact your system vendor or visit the following support sites.

EonStor DS / EonStor Support

ESVA Support

NAS Support

Headquarters Infortrend Technology, Inc.


(Taiwan) 8F, No. 102, Sec. 3, Jhongshan Rd., Jhonghe Dist., New Taipei City 235, Taiwan

Tel: +886-2-2226-0126 Fax: +886-2-2226-0020 Email, Technical Support, Website

Japan Infortrend Japan, Inc.


6F Okayasu Bldg., 1-7-14 Shibaura, Minato-Ku, Tokyo, 105-0023 Japan

Tel: +81-3-5730-6551 Fax: +81-3-5730-6552 Email, Technical Support, Website

Americas Infortrend Corporation


435 Lakeside Dr. Sunnyvale, CA. 94085, USA

Tel: +1-408-988-5088 Fax: +1-408-988-6288 Email, Technical Support, Website

US East Coast Office


4 Northeastern Blvd. Suite 21B, Nashua, NH, 03062, USA

Tel: +1-603-610-6398 Fax: +1-603-610-6383 Email, Technical Support, Website

China Infortrend Technology, Ltd.


Room 1210, West Wing, Tower One, Junefield Plaza No.6 Xuanwumen Street, Xuanwu District,

Beijing, China

Tel: +86-10-6310-6168 Fax: +86-10-6310-6188 Email, Technical Support, Website

Europe (EMEA) Infortrend Europe LTD.


1 Cherrywood, Stag Oak Lane Chineham Business Park Basingstoke, Hampshire RG24 8WF, UK

Tel: +44-1256-707-700 Fax: +44-1256-707-889 Email, Technical Support, Website

Germany/ Infortrend Deutschland GmbH


Email, Technical Support, Website
About This Manual
This manual describes how to access and use the command line interface (CLI)
of EonNAS systems.

Version 1.0  Initial release

Version 1.1  New sections: Monitor storage capacity, Enable prefetch, Configure
sequential access, Implement Password Policy, Monitor System
Performance , Clone a volume from a snapshot image, Configure the timeout
mechanism for mirror tasks

 Changed sections: Start/STOP/RESTART SERVICE (adding Bonjour), ADD


OR DELETE VLAN ASSIGNMENT, VIEW VOLUME STATUS, CREATE
VOLUME, MODIFY VOLUME OPTIONS, VIEW FOLDER STATUS,
CREATE FOLDER, VIEW USER INFO, MODIFY USERS
Table of Contents

Table of Contents .................................................................................................................................................. 5

Before You Start..................................................................................................................................................... 9

Applied Models ............................................................................................................ 9


Understand Command Conventions ........................................................................ 10
Understand Return Codes.......................................................................................... 11

Use CLI Commands............................................................................................................................................. 12

Enter EonNAS CLI...................................................................................................... 12


Get Started with CLI................................................................................................... 14
help .............................................................................................................................. 14
man .............................................................................................................................. 15
cliver ............................................................................................................................ 15
progressbar .................................................................................................................. 15
exit ............................................................................................................................... 16

View System Status ................................................................................................... 17


sysinfo.......................................................................................................................... 17

Enable Services ......................................................................................................... 19


service ......................................................................................................................... 19
Start/stop/restart service ..................................................................................... 19
View service status ............................................................................................. 20
Manage CIFS service ......................................................................................... 21
Manage FTP service ........................................................................................... 21
Manage NFS service .......................................................................................... 22
Manage AFP service ........................................................................................... 23
Manage iSCSI initiators ...................................................................................... 23
Join LDAP directory service ................................................................................ 24
Manage NIS service............................................................................................ 27
Manage VSCAN service ..................................................................................... 27
Manage NDMP service ....................................................................................... 28
Manage RSYNCD service .................................................................................. 29
Manage Fibre Channel initiators ......................................................................... 30

Configure System ...................................................................................................... 32


hostname ..................................................................................................................... 32
Modify hostname for G-models ........................................................................... 32
Modify hostname for R-models ........................................................................... 32
sysconfig ...................................................................................................................... 33
Allow multiple logins............................................................................................ 33
Enable power saving features ............................................................................. 33
Enable cache flush policy ................................................................................... 34
Specify TCP connection’s timeout period............................................................ 34
Configure UPS .................................................................................................... 35
Control system buzzer ........................................................................................ 36
Control LED signals ............................................................................................ 37
Monitor storage capacity ..................................................................................... 38
Enable prefetch ................................................................................................... 41
Configure sequential access ............................................................................... 42
Implement Password Policy ................................................................................ 43
Monitor System Performance.............................................................................. 44
date .............................................................................................................................. 45
Change the hour, minute, or second of system time ........................................... 45
Change the month and date of system time ....................................................... 46
Change the year of system time ......................................................................... 46
View system time ................................................................................................ 47
timezone ...................................................................................................................... 47
dst ................................................................................................................................ 48
View daylight saving time configuration .............................................................. 48
Modify daylight saving time configuration ........................................................... 48
Remove daylight saving time configuration ......................................................... 49
ntp ................................................................................................................................ 49
View NTP settings ............................................................................................... 49
Sync time NTP server ......................................................................................... 50
Sync time with NTP server manually .................................................................. 50
secureadm ................................................................................................................... 50
Display the status of SSL/SSH key files.............................................................. 50
Create SSL certificates and key files................................................................... 51
Create SSH key files ........................................................................................... 51
Export or import SSL certificate .......................................................................... 52

Configure Network Connections .............................................................................. 53


ifconfig ......................................................................................................................... 53
Enable/disable IPv4 interface ............................................................................. 53
Enable DHCP (IPv4) ........................................................................................... 53
Set Static IP (IPv4).............................................................................................. 54
View all IPv4 interfaces ....................................................................................... 54
Enable/disable IPv6 interface ............................................................................. 54
Enable DHCP (IPv6) ........................................................................................... 55
View all IPv6 Interfaces ....................................................................................... 55
dns ............................................................................................................................... 55
dnssuffix ....................................................................................................................... 56
route............................................................................................................................. 57
Add/delete routing rule ........................................................................................ 57
View routing rules ............................................................................................... 58
aggr.............................................................................................................................. 59
Create/modify/delete link aggregation................................................................. 59
View current link aggregation .............................................................................. 59
dladm ........................................................................................................................... 60
Set Jumbo Frame ............................................................................................... 60
View Jumbo Frame ............................................................................................. 60
vlan .............................................................................................................................. 61
View VALN status................................................................................................ 61
Add or delete VLAN assignment ......................................................................... 61

Manage External Devices .......................................................................................... 63


printer........................................................................................................................... 63
View printers and their status .............................................................................. 63
Manage printers .................................................................................................. 64
Manage printing jobs........................................................................................... 65
extdrv ........................................................................................................................... 65
View external drive information ........................................................................... 65
Remove external drive ........................................................................................ 66

Notify System Events ................................................................................................ 67


smtp ............................................................................................................................. 67
Enable/disable SMTP service ............................................................................. 67
Modify SMTP settings ......................................................................................... 67
Send test email ................................................................................................... 68
snmp ............................................................................................................................ 68
Enable/disable SNMP service ............................................................................. 68
Modify SNMP notification settings....................................................................... 69

Manage Storage Space.............................................................................................. 70


pool .............................................................................................................................. 70
Create pool ......................................................................................................... 70
Destroy pool ........................................................................................................ 70
Expand pool ........................................................................................................ 70
Perform media scan ............................................................................................ 71
View pool status .................................................................................................. 71
Assign pool owner............................................................................................... 72
Remove pool drives ............................................................................................ 72
Replace pool drives ............................................................................................ 72
Export pool .......................................................................................................... 73
Import pool .......................................................................................................... 73
vol ................................................................................................................................ 74
View volume status ............................................................................................. 74
Create volume..................................................................................................... 75
Modify Volume Options ....................................................................................... 76
Delete volume ..................................................................................................... 77
Map/unmap volumes........................................................................................... 77
target............................................................................................................................ 78
View target status ............................................................................................... 78
Create iSCSI target ............................................................................................. 79
Delete target ....................................................................................................... 79
Modify target attributes ....................................................................................... 80
Mount volumes onto target ................................................................................. 80
Unmount volumes ............................................................................................... 81
disk .............................................................................................................................. 82
View disk information .......................................................................................... 82
ssd ............................................................................................................................... 84

Manage Folders.......................................................................................................... 85
folder ............................................................................................................................ 85
View folder status................................................................................................ 85
Create folder ....................................................................................................... 86
Delete folder........................................................................................................ 87
fquota ........................................................................................................................... 88
View user’s folder quota...................................................................................... 88
Limit user’s folder quota ...................................................................................... 88
Remove quota limits ........................................................................................... 89
portal ............................................................................................................................ 89
Manage portal folders ......................................................................................... 89
Manage links to portal folder ............................................................................... 90
Manage target folders of a link ............................................................................ 91
share ............................................................................................................................ 92
Share a folder ..................................................................................................... 92
Configure folder’s CIFS/AFP sharing protocol .................................................... 92
Configure folder’s NFS access rights .................................................................. 93
acl ................................................................................................................................ 93
View folder’s ACL privileges ................................................................................ 93
Set folder’s ACL privileges .................................................................................. 94
Remove user/group from folder’s ACL entries .................................................... 95

Manage Users & Groups ........................................................................................... 96


useradmin user, passwd .............................................................................................. 96
View user info ..................................................................................................... 96
Modify users........................................................................................................ 96
Change user password ....................................................................................... 97
Manage user quota ............................................................................................. 98
useradmin group .......................................................................................................... 98
View group info ................................................................................................... 98
Modify groups ..................................................................................................... 99
Export User/Group List ....................................................................................... 99

Perform Backups ..................................................................................................... 100


snapshot .................................................................................................................... 100
View snapshot tasks ......................................................................................... 100
Run snapshot tasks by schedule ...................................................................... 100
Take snapshots manually.................................................................................. 101
Delete snapshot task ........................................................................................ 101
snapimage ................................................................................................................. 102
View snapshot images ...................................................................................... 102
Delete snapshot image ..................................................................................... 102
Roll back snapshot............................................................................................ 103
Browse snapshot image contents ..................................................................... 103
Retrieve file from snapshot image..................................................................... 104
Clone a volume from a snapshot image............................................................ 104
mirror ......................................................................................................................... 105
View pool mirror tasks ....................................................................................... 105
Create and modify mirror .................................................................................. 106
Delete mirror task.............................................................................................. 107
Start or stop mirror task .................................................................................... 107
Query available disk space on target system .................................................... 108
Configure the timeout mechanism for mirror tasks............................................ 108
replicate ..................................................................................................................... 109
View remote replication tasks ........................................................................... 109
Create and modify remote replication task ......................................................... 110
Delete remote replication task............................................................................ 111
Launch or stop remote replication task .............................................................. 111
Restore data from destination ............................................................................ 111
Configure the timeout mechanism for replication tasks...................................... 112
extbackup ................................................................................................................... 112
View external backup task status ....................................................................... 112
Create external backup task .............................................................................. 113
Delete external backup task ............................................................................... 113
Launch external backup task ............................................................................. 114
Stop ongoing external backup task .................................................................... 114
evault .......................................................................................................................... 115
View Enterprise Vault Snapshot tasks................................................................ 115
Create and manage scheduled Enterprise Vault Snapshot task ........................ 115
Launch Enterprise Vault Snapshot task ............................................................. 116
Restore data from destination ............................................................................ 116
Delete enterprise vault snapshot task ................................................................ 117
schedule ..................................................................................................................... 117
View backup schedules ..................................................................................... 117
Create backup schedule .................................................................................... 118
Change backup schedule .................................................................................. 118
Delete backup schedule..................................................................................... 119

Maintain System ....................................................................................................... 120


system ....................................................................................................................... 120
Update system software ................................................................................... 120
Backup system settings .................................................................................... 120
Reboot or shut down system ............................................................................ 121
View diagnostic report....................................................................................... 121
powersche ................................................................................................................. 121
View power schedule ........................................................................................ 121
Create and modify scheduled power task ......................................................... 122
Delete scheduled power task ............................................................................ 123
ha ............................................................................................................................... 123
View High Availability status.............................................................................. 124
Activate or Deactivate controller ....................................................................... 124
Shut down controller ......................................................................................... 124
Sync controller system ...................................................................................... 125
Initialize controller ............................................................................................. 125
log .............................................................................................................................. 126
Export logs ........................................................................................................ 126
Clear logs .......................................................................................................... 126
Set log retention rule ......................................................................................... 127
init .............................................................................................................................. 127
EonNAS Command Line Interface
User Manual

Before You Start

EonNAS Command Line Interface (CLI) allows IT managers to control their EonNAS with
greater flexibility and efficiency than they would with a graphical user interface (GUI).

The following sections help you access CLI and understand command conventions and return
codes.

Applied Models
Most commands listed in this document apply to all EonNAS Unified Storage Systems.
However, some commands might generate different results depending on the type of EonNAS
you are using:

 R-models (or “redundancy models"): EonNAS unified storage systems with redundant controllers
 S-models (or "single models"): EonNAS unified storage systems equipped with a single
controller, capable of being upgraded to R-models
 G-models (or "generic models"): EonNAS unified storage systems equipped with a single
controller, NOT capable of being upgraded to R-models

Any difference in command usage or compatibility regarding the G-models and R-models will
be indicated in the document.

© 2014 Infortrend Technology Inc. All Rights Reserved. 9


EonNAS Command Line Interface
User Manual
Understand Command Conventions
This section gives you a brief instruction on the conventions (or syntax) of CLI commands.

Throughout the document, you will see instances of command conventions resembling this:

service options nfs [ -v { all | 2 | 3 | 4 } ]

As you can see from the above example, a command line might consist of one or more
command names and parameters, which might contain arguments (e.g. -c) and their values
(e.g. name), or predefined choices of keywords (such as off or on).

Parameters and their values could be mandatory, optional, or mutually exclusive, and those
patterns and conditions are expressed using symbols (e.g. brackets, braces, vertical bars, etc),
as is shown in the following table:

SYMBOL EXAMPLE DESCRIPTION


[ ] square brackets [value] Indicates an optional parameter.
Italic font in a value or [value] Indicates a variable value. You must
parameter replace the italicized text and brackets
with an appropriate value, which might be
a name or number.
{ } curly braces {choice1 | Indicates that you must select a
choice2} parameter from the list of choices.
| vertical bar choice1 | Separates the mutually exclusive choices.
choice2
[ { } ] braces within [{ choice1|choice Indicates a choice within an optional
square brackets 2}] element.
< > angle brackets <value> Indicates the value must be assigned.

Judging from this table, the following two commands meet the conditional requirements of the
convention shown in the above example:

> service options nfs -v all


> service options nfs

Note: Commands and parameters in a command line are order-dependent, meaning switching
their order might render the entire command invalid.

© 2014 Infortrend Technology Inc. All Rights Reserved. 10


EonNAS Command Line Interface
User Manual
Understand Return Codes
A return code contains two lines of information, starting with "CLI:" and "Return: " followed by
a message and a hex value (such as "0x0001") respectively. It occurs every time you execute
a command by pressing the Enter key on your keyboard, and appears at the end of CLI’s
response to your command. In the following example, the last 2 lines constitute a return code:

> service stop cifs


The CIFS service has been disabled.
CLI: Successful
Return: 0x0000

In EonNAS CLI, return codes are used to inform you of a successful or failed attempt to
execute a command, and if the command fails, it also provides you with information on which
part of your command causes the failure.

RETURN CODE DEFINITION


CLI: Successful The command is executed successfully.
Return: 0x0000

CLI: Failed (general) The command is aborted due to any possible reason
Return: 0x0001 (e.g. failed attempt to locate the object referred to by
the parameter).
CLI: Incomplete command One or more required commands or subcommands
Return: 0x0002 are missing.
CLI: No required parameter One or more required parameters are missing.
Return: 0x0003

CLI: Unknown parameter There is no such argument (such as -z) for the
Return: 0x0004 command.
CLI: Invalid parameter The argument is correct, but the value following it is
Return: 0x0005 invalid.
CLI: Unknown command The command does not exist or is mistyped.
Return: 0x0006

CLI: Not exist(no such item) The command is aborted due to the item referred to
Return: 0x000b by the parameter does not exist.
CLI: User aborted The command is aborted by the user.
Return: 0x0011

© 2014 Infortrend Technology Inc. All Rights Reserved. 11


EonNAS Command Line Interface
User Manual

Use CLI Commands

Starting from this section, you will first learn how to enter the EonNAS shell, and then be
presented with a complete collection of EonNAS CLI commands categorized using tables.
Most commands are ordered in accordance with the tree menu items on the left side of
EonNAS GUI. For each table, information about a command --- including its names and
subcommand names (if any), synopsis and conventions (or usage), and instances (examples)
--- are described in details, in the hope of helping you get started with EonNAS management
more quickly.

Enter EonNAS CLI


Connect to NAS via a SSH utility (such as putty.exe). Or you can log into a NAS directly.

Make sure you log into the NAS system as admin or an administrative user.

© 2014 Infortrend Technology Inc. All Rights Reserved. 12


EonNAS Command Line Interface
User Manual
To view available commands, enter "help" and press Enter. From the list of available
commands, use "NASCLI" to enter the EonNAS CLI shell.

Now CLI commands are at your disposal. Use “help” and “man” to view available EonNAS CLI
commands and usages, or refer to the next section for detailed instructions on how to use
them.

© 2014 Infortrend Technology Inc. All Rights Reserved. 13


EonNAS Command Line Interface
User Manual
Get Started with CLI
NAME help
SYNOPSIS help [subcommand [subcommand]]
DESCRIPTION
Display a short syntax summary of the queried command. For example:

If subcommand is not specified, commands needed for basic operation will be displayed.
For example:

Complex commands (such as a command followed by a subcommand) are also be queried.


For example:

© 2014 Infortrend Technology Inc. All Rights Reserved. 14


EonNAS Command Line Interface
User Manual
NAME man
SYNOPSIS man [subcommand]
DESCRIPTION
Use the command to display the man pages (user manual) for a command, including its
usage and description. If subcommand is not specified, commands needed for basic
operation will be displayed. For example:

NAME cliver
SYNOPSIS cliver
DESCRIPTION
Use the command to view the version of the EonNAS CLI shell. For example:

> cliver
1.2.3
CLI: successful
Return: 0x0000

NAME progressbar
SYNOPSIS progressbar [ on | off ]
DESCRIPTION
Use this command to view or configure the progress bar which indicates the progress of an
ongoing command. If the SSH or Telnet utility you are using is having trouble displaying the
progress bar, you might want to disable it first.

For example:

> progressbar
Progress bar is enabled

© 2014 Infortrend Technology Inc. All Rights Reserved. 15


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000
> progressbar on
CLI: Successful
Return: 0x0000
> progressbar off
CLI: Successful
Return: 0x0000

Make sure you’ve entered a valid parameter for the command, or you might see the
following return code:

> progressbar enable


CLI: Unknown parameter
Return: 0x0004

NAME exit
SYNOPSIS exit
DESCRIPTION
Use this command to leave the EonNAS CLI command shell. For example:

© 2014 Infortrend Technology Inc. All Rights Reserved. 16


EonNAS Command Line Interface
User Manual

View System Status


NAME sysinfo
SYNOPSIS sysinfo parameters
DESCRIPTION
Use the following command to see the overall information about the system.

sysinfo [ component [ component … ]]

PARAMETER INFO
component: cpu, memory, network, or peripheral

For example:

> sysinfo cpu


Controller CPU ID Manufacturer Speed Family
A CPU 0 Intel(R)Corporation 3300MHz Intel(R) Core(TM)i3-2120 CPU@3.3GHz
B CPU 0 Intel(R)Corporation 3300MHz Intel(R) Core(TM)i3-2120 CPU@3.3GHz
CLI: Successful
Return: 0x0000
> sysinfo memory
Controller Memory ID Type Location Size
A Mem 1 DDR3 ChannelA-DIMM1 4096MB
A Mem 3 DDR3 ChannelB-DIMM1 4096MB
B Mem 1 DDR3 ChannelA-DIMM1 4096MB
B Mem 3 DDR3 ChannelB-DIMM1 4096MB
CLI: Successful
Return: 0x0000
> sysinfo network
Interface IP Address Subnet Mask MAC Address
Mgmt1 (A-Primary)10.0.0.6 255.255.255.0 0:D0:23:16:63:F7
Mgmt1 (B-Secondary)172.24.110.47 255.255.254.0 0:D0:23:1E:63:F7
CH0 (A)20.0.0.44 255.255.255.0 0:D0:23:56:63:F7
CH0 (B)20.0.0.33 255.255.255.0 0:D0:23:5E:63:F7
CH1 (A)0.0.0.0 255.0.0.0 0:D0:23:76:63:F7
CH1 (B)0.0.0.0 255.0.0.0 0:D0:23:7E:63:F7
CH2 (A)0.0.0.0 255.0.0.0 0:D0:23:86:63:F7
CH2 (B)0.0.0.0 255.0.0.0 0:D0:23:8E:63:F7
CH3 (A)0.0.0.0 255.0.0.0 0:D0:23:96:63:F7
CH3 (B)0.0.0.0 255.0.0.0 0:D0:23:9E:63:F7
CLI: Successful
Return: 0x0000

If component is not specified, the following system information will be displayed: “Model
Name”, “Software Version”, “Service ID” and “Host Board”. For example:

> sysinfo
Model Name: EonNAS 3012

© 2014 Infortrend Technology Inc. All Rights Reserved. 17


EonNAS Command Line Interface
User Manual
Software Version: 3.2.1
Service ID: 8283127
Host Board: 1GbE (NER01G0)
CLI: Successful
Return: 0x0000

Make sure the value name is spelled correctly, or you might see the following return code:

> sysinfo peri


CLI: Invalid parameter
Return: 0x0005

To view information on multiple components, separate them with space. For example:

> sysinfo cpu memory

© 2014 Infortrend Technology Inc. All Rights Reserved. 18


EonNAS Command Line Interface
User Manual

Enable Services
NAME service
SYNOPSIS service subcommand parameters
DESCRIPTION
Use the commands in this section to enable network or file sharing services, such as CIFS,
FTP, NFS, AFP, iSCSI, etc.

S TART / STOP / RESTART SERVICE

Use the following commands to start, stop, or restart a network service.

service start service


service stop service
service restart service

PARAMETER INFO
service: cifs, ftp, sftp, nfs, afp, iscsi, ldap, nis, antivirus, ndmp, rsyncd, snmp, fibre,
or bonjour

For example:

> service start cifs


The CIFS service has been enabled.
CLI: Successful
Return: 0x0000
> service stop cifs
The CIFS service has been disabled.
CLI: Successful
Return: 0x0000
> service start bonjour
The bonjour service has been enabled.
CLI: Successful
Return: 0x0000
> service restart bonjour
The bonjour service has been restarted.
CLI: Successful
Return: 0x0000
> service stop bonjour
The bonjour service has been disabled.
CLI: Successful
Return: 0x0000

Make sure the value name is spelled correctly, or you might see the following return code:

> service start cifsa


CLI: Invalid parameter

© 2014 Infortrend Technology Inc. All Rights Reserved. 19


EonNAS Command Line Interface
User Manual
Return: 0x0005

The parameter value is required, thereby should not be omitted:

> service restart


CLI: No required parameter
Return: 0x0003

V IEW SERVICE STATUS

Use the following command to view the status of a network service.

service status [service]

PARAMETER INFO
service: cifs, ftp, sftp, nfs, afp, iscsi, ldap, nis, antivirus, ndmp, rsyncd, snmp, fibre,
or bonjour

For R-models, you can see the service status of Controller A & B:

> service status bonjour


The Bonjour service of Controller A is disabled.
The Bonjour service of Controller B is disabled.
CLI: Successful
Return: 0x0000
> service status
The CIFS service of Controller A is online.
The CIFS service of Controller B is online.
The FTP service of Controller A is disabled.
The FTP service of Controller B is disabled.
...
The Bonjour service of Controller A is disabled.
The Bonjour service of Controller B is disabled.
CLI: Successful
Return 0x0000

Note: sftp and rsyncd are not supported by R-models.

For G-models, the status is shown as follows:

> service status


The CIFS service is online.
The FTP service is disabled.
The SFTP service is online.
The NFS service is online.
The AFP service is disabled.
The iSCSI service is disabled.
The LDAP service is disabled.
The NIS service is disabled.
The AntiVirus service is disabled.

© 2014 Infortrend Technology Inc. All Rights Reserved. 20


EonNAS Command Line Interface
User Manual
The NDMP service is disabled.
The Rsync Target service is disabled.
The SNMP service is disabled
The Bonjour service is disabled.
CLI: Successful
Return 0x0000

M ANAGE CIFS SERVICE

Use the following command to manage CIFS service.

service options cifs [ -w workgroup ] [ -p primary_wins ] [ -s secondary_wins ] [ -i interval ]

PARAMETER INFO
-w: Workgroup name
-p: Primary WINS server address
-s: Secondary WINS server address
-i (5400 seconds by default; between 10 and 864000 seconds): Inactive client checking period
Note: "-p none" and "-s none" will wipe out the WINS server settings

For example:

> service options cifs -w workgroup


The CIFS service has been configured.
CLI: Successful
Return: 0x0000

If none of the parameters is specified, you will see the current settings:

> service options cifs


Workgroup: None
Primary WINS server: 172.27.1.1
Secondary WINS server: none
Inoperative client checking period: 5400 seconds
CLI: Successful
Return: 0x0000

M ANAGE FTP SERVICE

Use the following command to manage FTP service.

service options ftp [ -P port ] [ -l max_attempt ]


[-s off | on [ -e off | on [-u on | off ] ] [ -f on | off ] [ -p port ] ]

PARAMETER INFO
-P (21 by default): Listen port
-l (5 by default): Maximum number of failed login attempt
-s (off by default): Allowing FTP over SSL/TLS, or FTPS (disabling FTPS also disables

© 2014 Infortrend Technology Inc. All Rights Reserved. 21


EonNAS Command Line Interface
User Manual
“-e”, “-u”, “-f”, and “-p”.)
-e (off by default): Allowing explicit FTP over TLS
-u (on by default): Allowing plain and unencrypted ftp connection
-f (off by default): -f on means encrypting FTP commands and transmitted data; -f off means
encrypting transmitted data while leaving FTP commands unencrypted
-p (990 by default): Implicit port

If none of the parameters is specified, you will see the current settings:

> service options ftp


listen port: 21
Maximum number of failed login attempts: 5
FTP over SSL/TLS (FTPS): disabled.
CLI: Successful
Return: 0x0000
=>> service options ftp
listen port: 21
Maximum number of failed login attempts: 5
FTP over SSL/TLS (FTPS): enabled
Allow explicit FTP over TLS: disabled
Allow plain unencrypted ftp: enabled
Force PROT P to encrypt file transfer: disabled
Listen port for implicit SSL/TLS connection: 990
CLI: Successful
Return: 0x0000

M ANAGE NFS SERVICE

Use the following command to manage the NFS version supported by your system.

service options nfs [ -v { all | 2 | 3 | 4 } ]

-v (all by default): Version

For example:

> service options nfs -v 4


The NFS service has been configured.
CLI: Successful
Return: 0x0000

If -v is not specified, all NFS versions will be supported:

> service options nfs


The version of NFS protocol that supported by this system is: all
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 22


EonNAS Command Line Interface
User Manual

M ANAGE AFP SERVICE

Use the following command to manage AFP service.

service options afp [ -n name ] [ -m message ] [-p on | off ]

-n (server’s hostname by default): Server name


-m: Login message
-p (off by default): Allowing password transmitted in clear text

For example:

> service options afp -n NASServer -p on


The APF service has been configured.
CLI: Successful
Return: 0x0000

M ANAGE I SCSI INITIATORS

Use the commands in this section to manage iSCSI initiators.

Display permitted initiators:

service options iscsilist

For example:

> service options iscsilist


Name IQN
Host_1 iqn.1991-05.com.microsoft:richardc
Host_2 iqn.1991-05.com.abcd:host1234
CLI: Successful
Return: 0x0000

If there isn’t any permitted initiator, the output will be empty:

> service options iscsilist


CLI: Successful
Return: 0x0000

Add an initiator to the permitted list:

service options iscsilist add <alias1> < iqn1> [-c {off | on -n name [ -s secret ] }]

PARAMETER INFO
-c: CHAP authentication
-n: CHAP name
-s (between 12 and 16 characters): CHAP secret (password)

© 2014 Infortrend Technology Inc. All Rights Reserved. 23


EonNAS Command Line Interface
User Manual

For example:

> service options iscsilist add swtest iqn.1991-05.com.microsoft:swtest -c on


-n chapname -s chapsecret001
The iSCSI initiator has been added.
CLI: Successful
Return: 0x0000

Remove an initiator from the permitted list:

service options iscsilist remove alias

For example:

> service options iscsilist remove swtest


The iSCSI initiator has been deleted.
CLI: Successful
Return: 0x0000

Modify initiator alias:

service options iscsilist modify alias [-c off | on ] [-n name ] [ -s secret ]

PARAMETER INFO
-c: CHAP authentication
-n: CHAP name
-s (between 12 and 16 characters): CHAP secret (password)

For example:

> service options iscsilist modify swtest -c off


The iSCSI initiator has been configured.
CLI: Successful
Return: 0x0000

J OIN LDAP DIRECTORY SERVICE

Use the commands in this section to join LDAP directory service hosted by an LDAP server
or Microsoft AD server.

Display LDAP configuration:

service options ldap

The output of the command may vary depending on the server type (LDAP or AD server).

For AD server, the output might look like this:

> service options ldap


Type: Microsoft Active Directory server
Server address: 172.27.120.130

© 2014 Infortrend Technology Inc. All Rights Reserved. 24


EonNAS Command Line Interface
User Manual
Server port: 389
Authentication level: 2
Domain controller: WIN-54VUN07HEJP.2008R2SP1.com
User home directory: Enabled
Pool: Pool-1
Quota: None.
CLI: Successful
Return: 0x0000

For LDAP server, the output might look like this:

> service options ldap


Type: LDAP server
Server address: 172.27.120.130
Server port: 636
Security: TLS
Base DN: ou=test, dc=ift, dc=com
User home directory: Disabled
CLI: Successful
Return: 0x0000

If LDAP has not been enabled, the output might look like this:

> service options ldap


The service hasn’t been configured.
CLI: Successful
Return: 0x0000

Configure LDAP server and join LDAP domain:

service options ldap < -t ldap > < -a address > [ -P port ] [ -s none | tls ]
< -b base_dn > < -r root_dn > < -p password >
[ -h off | on -S pool [-q {none | size} ] ]
[ -e {on|off}]

PARAMETER INFO
-t (ad or ldap): Server type
-a: Server address
-P (389 by default; 636 if "-s tls" is assigned): Port number
-s (none by default): Security level
-b: Base DN
-r: Root DN
-p: Password
-h (off by default): Home directory for imported users
-S: Storage pool for the home directories
-q (none by default): User quota
-e (on by default): Event notification

© 2014 Infortrend Technology Inc. All Rights Reserved. 25


EonNAS Command Line Interface
User Manual

For example:

> service options ldap -t ldap -a 172.27.120.130 -b dc=swtest,dc=ift.com -r


cn=admin,dc=swtest,dc=ift.com -p password
The LDAP service has been configured. Joining the domain has been completed.
CLI: Successful
Return: 0x0000

Fetch the domain controller list:

service options ldap < -t ad > { -a address | -d domain } [ -P port ] [ -s none | tls ]
< -u username > < -p password > [ -A {2 | 3 | 4 | 5} ]

PARAMETER INFO
-t (ad or ldap): Server type
-a: Server address
-d: Server’s domain name
-P (389 by default; 636 if "-s tls" is assigned): Port number
-s (none by default): Security level
-u: Username
-p: Password
-A (2 by default): Authentication level

For example:

> service options ldap -t ad -a 172.27.120.130 -u administrator -p password


Domain Controller:
WIN-54VUN07HEJP.2008R2SP1.com
192.168.1.2

CLI: Successful
Return: 0x0000

Configure Microsoft AD (Active Directory) server and join AD domain:

service options ldap < -t ad > { -a address | -d domain } [ -P port ] [ -s none | tls ]
< -u username > < -p password > [ -A {2 | 3 | 4 | 5} ]
< -c controller > <-i controller_addr>
[ -h off | on -S pool [-q {none | size} ] ]
[ -e {on|off }]

PARAMETER INFO
-t (ad or ldap): Server type
-a: Server address
-d: Server’s domain name
-P (389 by default; 636 if "-s tls" is assigned): Port number
-s (none by default): Security

© 2014 Infortrend Technology Inc. All Rights Reserved. 26


EonNAS Command Line Interface
User Manual
-u: Username
-p: Password
-A (2 by default): Authentication level
-c: Domain controller (If it is not specified, the controller list will be fetched)
-i: Address of the domain controller
-h (off by default): Home directory for imported users
-S: Storage pool for the home directories
-q (none by default): User quota
-e (on by default): Event notification

For example:

> service options ldap -t ad -a 172.27.120.130 -u administrator -p password


-c WIN-54VUN07HEJP.2008R2SP1.com -i 192.168.1.2
The LDAP service has been configured. Joining the domain has been completed.
CLI: Successful
Return: 0x0000

M ANAGE NIS SERVICE

Use the following command to manage NIS service.

service options nis [< -d domain > <-a ip_address >]

-d: Domain name


-a: IP address of NIS server

For example:

> service options nis


Server Domain: 2008R2SP1
Server Address: 172.27.120.130
CLI: Successful
Return: 0x0000
> service options nis -d 2008R2SP1 -a 172.27.120.130
Configuration has been completed.
CLI: Successful
Return: 0x0000

M ANAGE VSCAN SERVICE

Use the following command to manage the VSCAN antivirus service.

service options antivirus [< -a address > [ -P port ] [-s size ] [ -A {allow | deny} ]]
[-t {all | exe | type}]

PARAMETER INFO

© 2014 Infortrend Technology Inc. All Rights Reserved. 27


EonNAS Command Line Interface
User Manual
-a: Address of scan engine
-P (1344 by default): Port number
-s (1024 MB by default): Maximum file size allowable for scan (larger files will not be
scanned)
-A (allow by default): Allowing user access to files larger than the allowable scanning size
(defined by -s)
-t (all by default): File type

For example:

> service options antivirus


Scan server: 192.168.123.234
Port: 1344
Maximum file size: 1024MB
When exceeding maximum file size: Allow access
File type: All files
CLI: Successful
Return: 0x0000
> service options antivirus -a 192.168.123.234 -s 500m -A deny
Configuration has been completed.
CLI: Successful
Return: 0x0000

M ANAGE NDMP SERVICE

Use the following command to manage NDMP (Network Data Management Protocol) service.

service options ndmp [ -d on | off ] [ -i on | off ] [ -v 3 | 4 ]


[ -P port ] [-a cleartext|cram-md5] [ -u username [ -p password ] ]

PARAMETER INFO
-d (off by default): Enabling DAR
-i (off by default): Ignoring meta file changes for incremental backup
-v (4 by default): Version
-P (1000 by default): Port number
-a (cleartext by default): Authentication type
-u: Username
-p: Password

For example:

> service options ndmp -d on -i on -v 4 -P 10000 -a cleartext -u admin -p password


The NDMP service has been configured.
CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 28


EonNAS Command Line Interface
User Manual
Return: 0x0000

If none of the parameters is specified, you will see the current settings:

> service options ndmp


DAR: Disabled
Ignore meta file changes for incremental backup: Disabled.
Version: 4
Authentication type: cleartext
Username: admin
CLI: Successful
Return: 0x0000

M ANAGE RSYNCD SERVICE

Use the following command to accept Remote Replication request to back up data from a
remote server to a destination folder on your system.

service options rsyncd [ -P port ] [ -u username [ -p password ] ]


[ -a <share_name> <path> [ -a <share_name> <path> ] … ]
[ -d share_name [ -d share_name ] … ]

PARAMETER INFO
-P (873 by default): Port number
-u: Username
-p: Password
-a: Adding a destination folder
-d: Deleting a destination folder
share_name: Shared name of destination folder
path: Full path of destination folder

For example:

> service options rsyncd -P 873 -u admin -p password -a test_1 /Pool-1/bbb/aaa


-a test_2 /Pool-1/ccc/222
The settings have been configured.
CLI: Successful
Return: 0x0000
> service options rsyncd -d test_c -d test_b -a share001 /Pool-2/folder_2
The settings have been configured.
CLI: Successful
Return: 0x0000

If none of the parameters is specified, the settings and path of destination folders and its
share_name will be displayed. For example:

> service options rsyncd


Port: 873

© 2014 Infortrend Technology Inc. All Rights Reserved. 29


EonNAS Command Line Interface
User Manual
Username: admin
Share Name Path
test_a /Pool-1/aaa/folder001
test_b /Pool-1/aaa/folder002
test_c /Pool-1/bbb/test123
CLI: Successful
Return: 0x0000

Make sure you’ve entered a valid argument for the command, or you might see the following
return code:

> service options rsyncd -x


CLI: Unknown parameter
Return: 0x0004

M ANAGE F IBRE C HANNEL INITIATORS

Use the commands in this section to manage Fibre Channel initiators.

Display permitted initiators:

service options fibrelist

For example:

> service options fibrelist


Alias WWN
2000a-p1 21:01:00:e0:8b:a1:e7:65
2000a-p2 21:00:00:e0:8b:a1:e7:65
aie-4250a-p1 10:00:00:00:c9:50:35:59
aie-4250a-p2 10:00:00:00:c9:63:49:1a

If there isn’t any permitted initiator, the output will be empty:

> service options fibrelist


CLI: Successful
Return: 0x0000

Add an initiator to the permitted list:

service options fibrelist add alias wwn

For example:

> service options fibrelist add aie-4250a-p1 10:00:00:00:c9:50:35:59


The fibre channel initiator has been added.
CLI: Successful
Return: 0x0000

Remove an initiator from the permitted list:

© 2014 Infortrend Technology Inc. All Rights Reserved. 30


EonNAS Command Line Interface
User Manual
service options fibrelist remove alias

For example:

> service options fibrelist remove aie-4250a-p1


The fibre channel initiator has been deleted.
CLI: Successful
Return: 0x0000

Modify initiator alias:

service options fibrelist modify old_alias new_alias

For example:

> service options fibrelist modify aie-4250a-p1 aie-4250b-p1


The fibre channel initiator has been modified.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 31


EonNAS Command Line Interface
User Manual
Configure System
NAME hostname
SYNOPSIS hostname parameter
DESCRIPTION
Use the commands in this section to view or modify the hostname of the system.

Note: The hostname must begin with an alphabet and be composed of alphabets, digits and
symbols '_' and '-'. The length must be between 3 to 15 characters.

M ODIFY HOSTNAME FOR G- MODELS

For G-models, use the following command to modify the hostname of the system.

hostname [ name ]

For example:

> hostname NAS-1


The hostname has been configured.
CLI: Successful
Return: 0x0000

M ODIFY HOSTNAME FOR R- MODELS

For R-models, use the following command to modify the hostname of Controller A or B.

hostname {ctrla|ctrlb} [ name ]

For example:

> hostname ctrla NAS-1


The hostname of Controller A has been configured.
CLI: Successful
Return: 0x0000

If ctrla or ctrlb is not specified, you might see the following return code:

> hostname NAS-1


CLI: Incomplete command
Return: 0x0002

If name is not specified, the current hostname will be displayed:

> hostname ctrla


The hostname of Controller A is AAAA.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 32


EonNAS Command Line Interface
User Manual
Make sure the hostname is composed of acceptable characters:

> hostname ctrla AAA!


CLI: Invalid parameter
Return: 0x0005

NAME sysconfig
SYNOPSIS sysconfig subcommand parameter
DESCRIPTION
Use the commands in this section to view or modify system configuration.

ALLOW MULTIPLE LOGINS

Use the following command to enable multiple logins, which allows users to log into CLI
multiple times simultaneously. Once disabled, if you keep your account logged in and try to
use that account to log in again at another location or using different utilities, you will be
prompted to confirm the cancellation of your first login session.

sysconfig multilogin [ on | off ]

For example:

> sysconfig multilogin


Allow user multiple login: Enabled.
CLI: Successful
Return: 0x0000
> sysconfig multilogin off
The host parameter has been configured.
CLI: Successful
Return: 0x0000

E NABLE POWER SAVING FEATURES

Use the following command to turn energy saving features on or off for the installed hard
drives. Once turned on, the system will lower power consumption after a period of hard
drive inactivity using the following modes:

 Idle: Hard drives' read/write heads become idle by moving away from disk surfaces
 Standby: Hard drives enter the standby mode by lowering their spinning speed (RPM)

Note: This command is not supported by R-models.

sysconfig powersaving [ -i off | on [30|60|120] ] [ -s off | on [10|30|60] ]

-i (off by default): Entering idle mode after specified seconds of inactivity (If turned on, the

© 2014 Infortrend Technology Inc. All Rights Reserved. 33


EonNAS Command Line Interface
User Manual
default value is 60 seconds.)
-s (off by default): Entering standby mode after specified minutes of inactivity (If turned
on, the default value is 30 minutes.)

For example:

> sysconfig powersaving


Hard drive idle: disabled.
Hard drive standby mode: 30 minutes
CLI: Successful
Return: 0x0000
> sysconfig powersaving -i on 30 -s off
The host parameter has been configured.
CLI: Successful
Return: 0x0000

E NABLE CACHE FLUSH POLICY

Use the following command to turn the cache flush policy on or off.

Note: This command is not supported by R-models.

sysconfig cacheflushpolicy [ on | off ]

For example:

> sysconfig cacheflushpolicy


The cache flush policy option is disabled.
CLI: Successful
Return: 0x0000
> sysconfig cacheflushpolicy on
The host parameter has been configured.
CLI: Successful
Return: 0x0000
> sysconfig cacheflushpolicy off
The host parameter has been configured.
CLI: Successful
Return: 0x0000

S PECIFY TCP CONNECTION ’ S TIMEOUT PERIOD

Use the following command to specify the connection timeout period for TCP clients after a
certain period of inactivity.

sysconfig tcpkeepalive [ -i nn{ s | m | h | d } ]

-i (2h by default; ranging between 10s and 10d): Period of inactivity


nn: Number

© 2014 Infortrend Technology Inc. All Rights Reserved. 34


EonNAS Command Line Interface
User Manual
s: Second
m: Minute
h: Hour
d: Day

For example:

> sysconfig tcpkeepalive -i 2h


The host parameter has been configured.
CLI: Successful
Return: 0x0000

If -i is not specified, you will see the current setting:

> sysconfig tcpkeepalive


TCP keep—alive interval: 2 Hour(s)
CLI: Successful
Return: 0x0000

The period of inactivity should not be lower than the minimum value (10s):

> sysconfig tcpkeepalive -i 5s


CLI: Invalid parameter
Return: 0x0005

Make sure you’ve entered a valid argument for the command, or you might see the following
return code:

> sysconfig tcpkeepalive -x


CLI: Unknown parameter
Return: 0x0004

C ONFIGURE UPS

Use the following command to enable or disable a UPS connected to your system via USB
or Ethernet.

Note: UPS connected via USB is not supported by R-models.

sysconfig ups [ off | on ] [ -u | -P port ]

off: Disabling UPS


on: Enabling UPS
-u: Receiving UPS "battery low" event via USB
-P (162 by default): Number of listen port used for receiving UPS "battery low" trap

Here is an example of configuring a UPS connected via Ethernet:

> sysconfig ups on -P 162


The host parameter has been configured.

© 2014 Infortrend Technology Inc. All Rights Reserved. 35


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

Here is an example of configuring a UPS connected via USB:

> sysconfig ups -u


The host parameter has been configured.
CLI: Successful
Return: 0x0000

In the following 2 examples, if none of the parameters is specified, you will see the current
settings:

> sysconfig ups


UPS support is enabled.
Trap is received via ethernet port 162.
CLI: Successful
Return: 0x0000
> sysconfig ups
UPS support has been enabled.
UPS has been monitored via USB port.
CLI: Successful
Return: 0x0000

In the following 2 examples, even if you’ve disabled an UPS connected via Ethernet, you
could still change the system’s listen port:

> sysconfig ups off


The host parameter has been configured.
CLI: Successful
Return: 0x0000
> sysconfig ups -P 162
The host parameter has been configured.
CLI: Successful
Return: 0x0000

C ONTROL SYSTEM BUZZER

Use the following command to control system buzzer. The buzzer status could be on
(enabled and quiet), alarming (enabled and alarming), or off (disabled).

sysconfig buzzer [ on | off | mute ] [ -i { nonstop | 1 | 3 | 5 } ]

PARAMETER INFO
on: Enabling buzzer which will beep whenever alarming events take place
off: Disabling buzzer
mute: Muting alarming buzzer
-i (nonstop by default): Buzzing time (minutes)

© 2014 Infortrend Technology Inc. All Rights Reserved. 36


EonNAS Command Line Interface
User Manual

For example:

> sysconfig buzzer on


The host parameter has been configured.
CLI: Successful
Return: 0x0000
> sysconfig buzzer off
The host parameter has been configured.
CLI: Successful
Return: 0x0000
> sysconfig buzzer -i 5
The host parameter has been configured.
CLI: Successful
Return: 0x0000

If none of the parameters is specified, current buzzer status will be displayed:

> sysconfig buzzer


The buzzer has been enabled.
CLI: Successful
Return: 0x0000
> sysconfig buzzer
The buzzer is alarming.
CLI: Successful
Return: 0x0000
> sysconfig buzzer mute
The buzzer has been muted.
CLI: Successful
Return: 0x0000

C ONTROL LED SIGNALS

Use the commands in this section to turn the service LED on or off, or turn off system fault
LED.

The service LED is used to identify your system among multiple NAS systems placed in the
same room, whereas the system fault LED lights up to indicate system error.

Turn Service LED on or off:

sysconfig led service [ on | off ]

For example:

> sysconfig led service on


The service led has been turned on.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 37


EonNAS Command Line Interface
User Manual
If the parameter is not specified, current status will be displayed:

> sysconfig led service


The service LED is off.
CLI: Successful
Return: 0x0000

Turn system fault LED off:

sysconfig led system [off ]

For example:

> sysconfig led system off


The system fault led has been turned off.
CLI: Successful
Return: 0x0000

If the parameter is not specified, current status will be displayed:

> sysconfig led system


The system fault LED is off.
CLI: Successful
Return: 0x0000

You are not allowed to turn on the system fault LED to "fake" an error event. If you try to do
so, the following return code will be displayed:

> sysconfig led system on


CLI: Invalid parameter
Return: 0x0005

M ONITOR STORAGE CAPACITY

Use the commands in this section to view or edit the capacity monitoring thresholds, which
are set to send a warning event when capacity usage reaches the specified percentage.

Specify monitoring mode:


Use the following command to specify the monitoring mode. In the default mode, the system
will send a warning event when capacity usage reaches 70%.

sysconfig poolmonitoring [ {default | customize} ]

For example:

> sysconfig poolmonitoring customize


The capacity monitoring mode has been configured.
CLI: Successful
Return: 0x0000
> sysconfig poolmonitoring default
The capacity monitoring mode has been configured.

© 2014 Infortrend Technology Inc. All Rights Reserved. 38


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

If the parameter is not specified, current setting will be displayed. For example:

> sysconfig poolmonitoring


The capacity monitoring mode has been set to default mode.
CLI: Successful
Return: 0x0000

List current threshold monitoring settings:


You can use the following command to list the current threshold monitoring settings.

pmthold list [-i index]

PARAMETER INFO
-i: Index of the threshold monitoring setting

For example:

> pmthold list –i 3


Index Threshold Event Severity Status
3 90 Critical Enabled
CLI: Successful
Return: 0x0000

If the parameter is not specified, all settings will be displayed. For example:

> pmthold list


Index Threshold Event Severity Status
1 70 Warning Enabled
2 80 Warning Enabled
3 90 Critical Enabled
4 100 Critical Enabled
CLI: Successful
Return: 0x0000

If the monitoring mode is set to "default", you will see the following return code:

> pmthold list


The capacity monitoring mode has been set to default mode.
CLI: Successful
Return: 0x0000

Add a threshold monitoring setting:


Use the following command to add a new threshold monitoring setting and configure their
level of event severity. When a new setting is added, it will be enabled automatically.

pmthold add <-t threshold> <-l {information | warning | error | critical}> [-a {on|off}]

PARAMETER INFO

© 2014 Infortrend Technology Inc. All Rights Reserved. 39


EonNAS Command Line Interface
User Manual
-t: Threshold percentage value
-l: Level of event severity
-a (on by default): Activation status

This setting is only available for the customized mode. If you are using the default mode,
change to the customized mode before using this command. For example:

> sysconfig poolmonitoring


The monitoring mode has been set to default mode.
CLI: Successful
Return: 0x0000
> pmthold add -t 80 –l warning
The monitoring rule can’t be configured in default mode.
CLI: Failed (general)
Return: 0x0001
> sysconfig poolmonitoring customize
The monitoring mode has been configured.
CLI: Successful
Return: 0x0000
> pmthold add -t 80 –l warning
The monitoring rule has been configured.
CLI: Successful
Return: 0x0000

Edit a threshold monitoring setting:


Use the following command to edit a threshold monitoring setting.

pmthold options <-i index> [-t threshold] [-l {information | warning | error | critical}]
[-a {on|off}]

-i: Index of the threshold monitoring setting


-t: Threshold percentage value
-l: Level of event severity
-a (on by default): Activation status
Note: If -t,-l, and -a are not specified, the threshold setting will be displayed, just like using
" pmthold list –i index".

For example:

> pmthold options –i 3


Index Threshold Event Severity Status
3 90 Critical Enabled
CLI: Successful
Return: 0x0000
> pmthold options –i 3 –l information –a off
The monitoring rule has been configured.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 40


EonNAS Command Line Interface
User Manual
> pmthold list
Index Threshold Event Severity Status
1 70 Warning Enabled
2 80 Warning Enabled
3 90 Information Disabled
4 100 Critical Enabled
CLI: Successful
Return: 0x0000

Delete a threshold monitoring setting:


Use the following commend to delete a current threshold monitoring setting.

pmthold delete <-i index> [-f]

PARAMETER INFO
-i: Index of the threshold monitoring setting
-f: Forceful implementation without confirmation

For example:

> pmthold list


Index Threshold Event Severity Status
1 70 Warning Enabled
2 80 Warning Enabled
3 90 Information Disabled
4 100 Critical Enabled
CLI: Successful
Return: 0x0000
> pmthold delete –i 3
Are you sure you want to delete the setting? (y/n) n
CLI: User aborted
Return: 0x0011
> pmthold delete –i 3 -f
CLI: Successful
Return: 0x0000
> pmthold list
Index Threshold Event Severity Status
1 70 Warning Enabled
2 80 Warning Enabled
3 100 Critical Enabled
CLI: Successful
Return: 0x0000

E NABLE PREFETCH

Use the command in this section to enable/disable the file level "prefetching" mechanism,
which help boost the reading performance while accessing sequential data (such as a
media file).

© 2014 Infortrend Technology Inc. All Rights Reserved. 41


EonNAS Command Line Interface
User Manual
sysconfig prefetch [ {on|off} ]

PARAMETER INFO
The default option is off. on is available when the memory size of your NAS is equal to or
larger than 8GB.

For example:

> sysconfig prefetch


The file level prefetch mechanism has been disabled.
CLI: Successful
Return: 0x0000
> sysconfig prefetch on
The file level prefetch mechanism can not be enabled because the memory size
should be equal to or more than 8GB.
CLI: Failed (general)
Return: 0x0001
> sysconfig prefetch on
The file level prefetch mechanism has been configured.
CLI: Successful
Return: 0x0000
> sysconfig prefetch off
The file level prefetch mechanism has been configured.
CLI: Successful
Return: 0x0000

C ONFIGURE SEQUENTIAL ACCESS

Use the command in this section to configure Sequential Access, which help boost the I/O
performance while accessing sequential data (such as a media file).

sysconfig sequentialrw [–r {on|off}] [-w {on|off}]

PARAMETER INFO
-r: Enhancing the read performance of sequential data using the "prefetch" function
-w: Enhancing the write performance of sequential data using the "alignment" function

For example:

> sysconfig sequentialrw


The read enhancement has been enabled; the write enhancement has been
disabled.
CLI: Successful
Return: 0x0000
> sysconfig sequentialrw –r on –w on
The options have been configured.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 42


EonNAS Command Line Interface
User Manual

I MPLEMENT PASSWORD P OLICY

Use the following command to implement the password policy, which policy requests users
to enhance the complexity of their passwords for better protection against malicious
hackers.

sysconfig pwdpolicy [on|off] [-L n] [-p n] [-w n] [-n n] [-c n] [-u n] [-l n] [-d n] [-s n]

PARAMETER INFO
-L (8 by default): Minimum length
-p (90 by default; 0, 30, 60, 90, or 120 days available): Maximum validity period (0 means
the password won't expire)
-w (7 by default; 0, 7, or 14 days available): Warning days before expiration
-n (3 by default; 0-5 available): Maximum number of password(s) to keep
-c (0 by default): Minimum number of required letter(s)
-u: Minimum number of required upper case letter(s)
-l (0 by default): Minimum number of required lower case letter(s)
-d (0 by default): Minimum number of required digit(s)
-s (0 by default): Minimum number of required special character(s)
Note: Setting 0 for any of the above parameters means "disabling" those features.

For example:

> sysconfig pwdpolicy


The password policy has been disabled.
CLI: Successful
Return: 0x0000
> sysconfig pwdpolicy on
The password policy has been configured.
CLI: Successful
Return: 0x0000
> sysconfig pwdpolicy
The password policy has been enabled.
The minimum length is 8 characters.
The maximum validity period is 90 days.
The warning days before expiration are 7 days.
The maximum number of password(s) to keep is 3.
The minimum number of required letter(s) is 0.
The minimum number of required upper case letter(s) is 0.
The minimum number of required lower case letter(s) is 0.
The minimum number of required digit(s) is 0.
The minimum number of required special character 0.
CLI: Successful
Return: 0x0000
> sysconfig pwdpolicy –L 10
The password policy has been configured.

© 2014 Infortrend Technology Inc. All Rights Reserved. 43


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000
> sysconfig pwdpolicy
The password policy has been enabled.
The minimum length is 10 characters.
The maximum validity period is 90 days.
The warning days before expiration are 7 days.
The maximum number of password(s) to keep is 3.
The minimum number of required letter(s) is 0.
The minimum number of required upper case letter(s) is 0.
The minimum number of required lower case letter(s) is 0.
The minimum number of required digit(s) is 0.
The minimum number of required special character 0.
CLI: Successful
Return: 0x0000

M ONITOR S YSTEM P ERFORMANCE

Use the following command to monitor CPU and disk I/O performance and export the
monitoring records as text files.

sysconfig perfmon [on|off] [-f folder_path] [-t start_time] [-i interval]

PARAMETER INFO
-f: Folder to save the monitoring records
-t: Monitoring start time
-i: Monitoring interval
Note: The performance monitoring feature won’t be enabled until all parameters are
properly set.

For example:

> sysconfig perfmon


The performance monitoring task is disabled.
Output Folder:
Start Time: 00:00
Interval: 1 hour
CLI: Successful
Return: 0x0000
> sysconfig perfmon on
The performance monitoring task hasn’t been configured completely.
CLI: Failed (general)
Return: 0x0001
> sysconfig perfmon –f /Pool/folder
The performance monitoring task has been configured.
CLI: Successful
Return: 0x0000
> sysconfig perfmon on

© 2014 Infortrend Technology Inc. All Rights Reserved. 44


EonNAS Command Line Interface
User Manual
The performance monitoring task has been enabled.
CLI: Successful
Return: 0x0000
> sysconfig perfmon
The performance monitoring task has been enabled.
Output Folder: /Pool/folder
Start Time: 00:00
Interval: 1 hour
CLI Successful
Return: 0x0000

NAME date
SYNOPSIS date parameter
DESCRIPTION
Use the following command to set system time.

date [ [[[[<cc>]<yy>]<MM>]<dd>]<hhmm>[.<ss>] ]

PARAMETER INFO
cc: First 2 digits of the year, such as "19" in "1999"
yy: Next 2 digits of the year, such as "99" in "1999"
MM: Numeric month, ranging from 01 to 12
dd: Day, ranging from 01 to 31
hh: Hour, ranging from 00 to 23
mm: Minutes, ranging from 00 to 59
ss: Seconds, ranging from 00 to 59

Depending on the number of digits you entered, the system will interpret the time
information differently, which will be discussed in the following sections.

C HANGE THE HOUR , MINUTE , OR SECOND OF SYSTEM TIME

If the parameter contains 4 digits, then the series of numbers will be interpreted as hh:mm
(hour and minute). For example:

> date 1344


2013-12-17 13:44:01
CLI: Successful
Return: 0x0000

If the 4 digits are followed by 2 digits to the right of a decimal point, then the series of
numbers will be regarded as hh:mm:ss (hour, minute, and second). For example:

> date 1633.57


2013-12-17 16:33:57

© 2014 Infortrend Technology Inc. All Rights Reserved. 45


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000
> date 2561.00
CLI: Invalid parameter
Return: 0x0005

C HANGE THE MONTH AND DATE OF SYSTEM TIME

If 2 digits are added (6 digits in total) to the front of the 4-digit parameter mentioned in the
previous section, you are changing the date of the current month. If another 2 digits are
added in front of the 6 digit, you are setting the month and the date of system time.

For example:

> date 141225


2014-12-14 12:25:31
CLI: Successful
Return: 0x0000
> date 12251330
2013-12-25 13:30:04
CLI: Successful
Return: 0x0000

Make sure the specified time is within reasonable range (e.g."MM" which means "month"
should not be more than 12) :

> date 20151122.33


CLI: Invalid parameter
Return: 0x0005

C HANGE THE YEAR OF SYSTEM TIME

Add 2 (yy) or 4 (ccyy) more digits (10 or 12 digits in total) to the front of an 8-digit parameter
to set the year of system time.

if you choose to add 2 digits (yy) only, then any number more than "68" (such as 70) will be
regarded as "19XX" (e.g. "1970"); otherwise, it will be interpreted as "20XX" (e.g. "2014").

Note: ccyy must be less than 2038.

For example:

> date 201301191200


2013-01-19 12:00:01
CLI: Successful
Return: 0x0000

Make sure the ccyy value is less than 2038:

> date 3801191200

© 2014 Infortrend Technology Inc. All Rights Reserved. 46


EonNAS Command Line Interface
User Manual
CLI: Invalid parameter
Return: 0x0005

V IEW SYSTEM TIME

If the parameter is not specified, current system time will be displayed:

> date
2013-12-17 15:08:57
CLI: Successful
Return: 0x0000

NAME timezone
SYNOPSIS timezone parameters
DESCRIPTION
Use the following command to set the time zone for your system.

Note: The setting will take effect after system reboot.

timezone {-g | {-l | -p } | -s timezone }

PARAMETER INFO
-g: Current time zone
-l: List of all available time zones
-p: Paginated display all available time zones
-s: Setting time zone

For example:

> timezone -g
Asia/Taipei
CLI: Successful
Return: 0x0000
> timezone -l
Pacific/Midway
Pacific/Niue
Pacific/Pago_Pago
...
Asia/Taipei
...
Pacific/Tongatapu
Pacific/Kiritimati
CLI: Successful
Return: 0x0000
> timezone -s Asia/Taipei
The timezone will be updated after system reboot.

© 2014 Infortrend Technology Inc. All Rights Reserved. 47


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

If the required parameter is not specified, you will see the following return code:

> timezone
CLI: Incomplete command
Return: 0x0002

Make sure you are using a valid parameter. In the following example, Kaohsiung is not on
the list of available time zones:

> timezone -s Asia/KaoHsiung


CLI: Invalid parameter (Parameter format error, out-of-range or mistype)
Return: 0x0005

NAME dst
SYNOPSIS dst subcommand parameters
DESCRIPTION
Use the commands in this section to view or modify daylight saving time configuration.

V IEW DAYLIGHT SAVING TIME CONFIGURATION

Use the following command to view the current daylight saving time configuration.

dst status

For example:

=>> dst status


The settings of daylight saving time haven’t been configured.
CLI: Successful
Return: 0x0000
=>> dst status
Start Time: 04-01 00:00
End Time: 09-30 23:59
Offset: 60 minutes
CLI: Successful
Return: 0x0000

M ODIFY DAYLIGHT SAVING TIME CONFIGURATION

Use the following command to modify daylight saving time configuration.

dst options <-s start_date_time> <-e end_date_time> <-o offset>

PARAMETER INFO

© 2014 Infortrend Technology Inc. All Rights Reserved. 48


EonNAS Command Line Interface
User Manual
-s: Start time
-e: End time
(The time format is “MMddhhmm”. MM: Month; dd: Date; hh: hour; mm: minute)
-o: Offset (by minutes)

For example:

=>> dst options -s 04010000 -e 09302359 -o 60


The daylight saving time setting will be updated after system reboot.
CLI: Successful
Return: 0x0000

R EMOVE DAYLIGHT SAVING TIME CONFIGURATION

Use the following command to remove the daylight saving time configuration.

dst clear

For example:

=>> dst clear


The daylight saving time setting will be updated after system reboot.
CLI: Successful
Return: 0x0000

NAME ntp
SYNOPSIS ntp subcommand parameters
DESCRIPTION
Use the commands in this section to view or manage NTP (network time protocol) settings.

V IEW NTP SETTINGS

Use the following command to view the list of NTP servers and sync status.

ntp status

For example:

=>> ntp status


Server
192.168.1.1
172.27.120.130

Periodically synchronize: Enabled


CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 49


EonNAS Command Line Interface
User Manual
Return: 0x0000

S YNC TIME NTP SERVER

Use the following command to configure NTP settings.

ntp options {<-a server>|<-r server> | <-p {on|off} > }

PARAMETER INFO
-a: Adding a NTP server
-r: Removing a NTP server
-p (off by default): Periodic time sync with the server

S YNC TIME WITH NTP SERVER MANUALLY

Use the following command to sync system time with a NTP server manually.

ntp sync [server]

If server is not specified, the system will sync time with the first server in the server list.

For example:

=>> ntp sync


The System Time has synced with the Network Time Protocol server.
CLI: Successful
Return: 0x0000

NAME secureadm
SYNOPSIS secureadm subcommand
DESCRIPTION
Use the commands in this section to view or modify SSL/SSH configuration.

D ISPLAY THE STATUS OF SSL/SSH KEY FILES

Use the following command to display the status of SSL/SSH key files.

secureadm status

For example:

=>> secureadm status


SSL Certificate: SSLCrt.crt
Private Key: SSLCrt.key
SSH Key: none
CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 50


EonNAS Command Line Interface
User Manual
Return: 0x0000

C REATE SSL CERTIFICATES AND KEY FILES

Use the following command to create a SSL certificate and key file.

secureadm create <-t ssl> <-n filename> <-s {1024|2048|4096}> <-C country> <-S state>
<-L city> <-O organization> <-U organization_unit>
<-N common_name> <-E email>

PARAMETER INFO
-n: Name of key file
-s: Size of key file
-C: 2-letter country code, such as "GB" for "United Kingdom"
-S: State or Province
-L: Locality
-O: Organization
-U: Organization Unit
-N: Common Name, such as FQDN (Fully Qualified Domain Name)
-E: Email address

For example:

=>> secureadm create -t ssl -n sslcrt -C us -S NewYork -L NewYorkCity -O mycompany


-U SW -CN SW.mycompany.com -E RD@SW.mycompany.com
The SSL certificate has been created.
CLI: Successful
Return: 0x0000

C REATE SSH KEY FILES

Use the following command to create a SSH key file.

secureadm create <-t ssh> <-n filename> <-s {1024|2048|4096}> <-e {rsa|dsa}>
[-p password]

PARAMETER INFO
-n: Name of key file
-s: Key size
-e: Encryption method
-p: Password

For example:

=>> secureadm create -t ssh -n sshkey -s 2048 -e ras


The SSH key has been created.
CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 51


EonNAS Command Line Interface
User Manual
Return: 0x0000

E XPORT OR IMPORT SSL CERTIFICATE

Use the commands in this section to export or import the SSL certificate in a .crt file.

Export SSL certificate:

secureadm export <-f fullpath_output_folder>

PARAMETER INFO
-f: Full path of the destination folder

For example:

=>> secureadm export -f /Pool-1/folder01


The SSL certificate has been exported.
CLI: Successful
Return: 0x0000

Import SSL certificate and key file:

secureadm import <-c fullpath_crtfile> <-k fullpath_keyfile> [-p password]

PARAMETER INFO
-c: Full path of the certificate file
-k: Full path of the key file
-p: Password

For Example:

=>> secureadm import -c /Pool-1/folder01/test.crt -k


/Pool-1/folder01/test.key
The SSL certificate files have been imported.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 52


EonNAS Command Line Interface
User Manual

Configure Network Connections


NAME ifconfig
SYNOPSIS ifconfig {inet|inet6} subcommand parameters
DESCRIPTION
Use the commands in this section to configure IP network interfaces.

E NABLE / DISABLE IP V 4 INTERFACE

Use the following command to enable (or "plumb") or disable (or "unplumb") an IPv4
interface.

ifconfig inet interface { plumb | unplumb }

For Example:

> ifconfig inet ch0 plumb


The interface settings have been configured.
CLI: Successful
Return: 0x0000
> ifconfig inet ch0 unplumb
The LAN interface has been disabled.
CLI: Successful
Return: 0x0000

If the required parameter is not specified, you will see the following return code:

> ifconfig inet ch1


CLI: Incomplete command
Return: 0x0002

E NABLE DHCP (IP V 4)

Use the following command to set an IPv4 interface to obtain IP address via DHCP.

ifconfig inet interface dhcp -c { ctrla | ctrlb | ctrlab}

PARAMETER INFO
-c: Controller

For example:

> ifconfig inet ch0 dhcp -c ctrlab


The interface settings have been configured.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 53


EonNAS Command Line Interface
User Manual

S ET S TATIC IP (IP V 4)

Use the following command to configure static IP address for an IPv4 interface.

ifconfig inet interface static -c { { ctrla | ctrlb } ip netmask <netmask> [ gateway


<gateway> ] } [ -c { ctrla | ctrlb } ip netmask <netmask> [ gateway <gateway> ] ]

For example:

> ifconfig inet ch0 static -c ctrla 172.27.12.21 netmask 255.255.255.0 gateway
172.27.13.254 -c ctrlb 172.27.10.21 netmask 255.255.255.0 gateway
172.27.13.254
The interface settings have been configured.
CLI: Successful
Return: 0x0000

V IEW ALL IP V 4 INTERFACES

Use the following command to get an overview of all IPv4 interfaces.

ifconfig inet show

For example:

> ifconfig inet show


Interface IP Address Netmask Gateway Config Status
Mgmt1 (A-P)10.0.0.6 255.255.255.0 --- static UP
Mgmt1 (B-S)172.24.110.47 255.255.254.0 172.24.111.254 DCHP UP
CH0 (A)20.0.0.44 255.255.255.0 --- static UP
CH0 (B)20.0.0.33 255.255.255.0 --- static UP
CH1 (A)0.0.0.0 255.0.0.0 --- DHCP DOWN
CH1 (B)0.0.0.0 255.0.0.0 --- DHCP DOWN
CH2 (A)0.0.0.0 255.0.0.0 --- DHCP DOWN
CH2 (B)0.0.0.0 255.0.0.0 --- DHCP DOWN
CH3 (A)
CH3 (B)
CLI: Successful
Return: 0x0000

E NABLE / DISABLE IP V 6 INTERFACE

Use the following command to enable (or "plumb") or disable (or "unplumb") an IPv6
interface.

ifconfig inet6 interface { plumb | unplumb }

For example:

> ifconfig inet6 ch0 plumb

© 2014 Infortrend Technology Inc. All Rights Reserved. 54


EonNAS Command Line Interface
User Manual
The interface settings have been configured.
CLI: Successful
Return: 0x0000
> ifconfig inet6 ch0 unplumb
The LAN interface has been disabled.
CLI: Successful
Return: 0x0000

E NABLE DHCP (IP V 6)

Use the following command to set an IPv6 interface to obtain IP address via DHCP.

ifconfig inet6 interface dhcp -c { ctrla | ctrlb | ctrlab }

For example:

> ifconfig inet6 ch0 dhcp -c ctrlab


IPv6 has been configured. If you want to connect to the GUI via IPv6 address,
you will need to reboot the system.
CLI: Successful
Return: 0x0000

V IEW ALL IP V 6 I NTERFACES

Use the following command to get an overview of all IPv6 interfaces.

ifconfig inet6 show

For example:

> ifconfig inet6 show


Interface IP Address Netmask Gateway Config Status
CH5 fe80:2d0:23ff:fea6:63f7/10 --- --- DHCP DOWN
CH5 fe80:2d0:23ff:feae:63f7/10 --- --- DHCP DOWN
CLI: Successful
Return: 0x0000

NAME dns
SYNOPSIS dns subcommand parameter
DESCRIPTION
Use the following command to maintain the list of DNS servers available to the system.

dns { {add | delete} <address> | show }

PARAMETER INFO
add: Adding a DNS server to the list

© 2014 Infortrend Technology Inc. All Rights Reserved. 55


EonNAS Command Line Interface
User Manual
delete: Deleting a DNS server from the list
address: IP address of the DNS server
show: Displaying server list

For example:

> dns add 172.27.120.130


The DNS server has been added.
CLI: Successful
Return: 0x0000
> dns delete 172.27.120.130
The DNS server has been deleted.
CLI: Successful
Return: 0x0000
> dns show
DNS Server
172.27.120.130
192.168.99.1
192.168.99.2
CLI: Successful
Return: 0x0000

If the DNS list is empty, the output of dns show will also be empty:

> dns show


CLI: Successful
Return: 0x0000

If either of the subcommands is not entered, you will see the following return code:

> dns
CLI: Incomplete command
Return: 0x0002

NAME dnssuffix
SYNOPSIS dnssuffix subcommand parameter
DESCRIPTION
Use the following command to manage DNS suffix settings.

dnssuffix { {add | delete} <suffix> | show }

PARAMETER INFO
add: Adding a suffix
delete: Deleting a suffix
suffix: Domain suffix
show: Displaying the list of DNS suffixes

© 2014 Infortrend Technology Inc. All Rights Reserved. 56


EonNAS Command Line Interface
User Manual

For example:

> dnssuffix add mycompany.com


The DNS suffix has been added.
CLI: Successful
Return: 0x0000
> dnssuffix show
DNS Suffix
Mycompany.com
CLI: Successful
Return: 0x0000
> dnssuffix delete mycompany.com
The DNS suffix has been deleted.
CLI: Successful
Return: 0x0000

If neither of the subcommands is entered, you will see the following return code:

> dnssuffix
CLI: Incomplete command
Return: 0x0002

NAME route
SYNOPSIS route subcommand parameters
DESCRIPTION
Use the commands in this section to maintain routing rules for your system.

ADD / DELETE ROUTING RULE

Use route add to add a routing rule, or route delete to delete it.

route add -p <-n destination> <-m netmask> <-g gateway> <-i interface>

route add -d -c { ctrla | ctrlb | ctrlab } <-n destination> <-m netmask> <-g gatewayI> <-i interface>

route delete -p <-n destination> <-m netmask> <-g gateway> <-i interface>

route delete -d -c { ctrla | ctrlb| ctrlab } <-n destination> <-m netmask> <-g gateway> <-i interface>

PARAMETER INFO
-p: Static routing rule
-d: Dynamic routing rule
-n: Destination
-m: Netmask
-g: Gateway

© 2014 Infortrend Technology Inc. All Rights Reserved. 57


EonNAS Command Line Interface
User Manual
-i: Interface
-c (R-models only): Controller to which the routing rule will be applied

Examples for G-models are shown as follows:

> route add -p -n 172.27.255.0 -m 255.255.255.0 -g 172.27.12.253 -i ch0


The operation has been completed.
CLI: Successful
Return: 0x0000
> route delete -p -n 172.27.255.0 -m 255.255.255.0 -g 172.27.12.253 -i ch0
The operation has been completed.
CLI: Successful
Return: 0x0000

Examples for R-models are shown as follows:

> route add -d -c ctrlab -n 172.27.255.0 -m 255.255.255.0 -g172.27.12.253 -i ch0


The operation has been completed.
CLI: Successful
Return: 0x0000
> route delete -d -c ctrlab -n 172.27.255.0 -m 255.255.255.0 -g172.27.12.253 -i ch0
The operation has been completed.
CLI: Successful
Return: 0x0000

V IEW ROUTING RULES

Use the following command to view all routing rules for all interfaces on your system.

route show

For example:

> route show


Destination Netmask Gateway Interface Type Controller
Default 0.0.0.0 172.24.111.254 Mgmt1 Dynamic Controller B
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 58


EonNAS Command Line Interface
User Manual
NAME aggr
SYNOPSIS aggr subcommand parameters
DESCRIPTION
Use the commands in this section to configure link aggregation for multiple interfaces on
your system.

C REATE / MODIFY / DELETE LINK AGGREGATION

Use aggr create to create a link aggregation for multiple interfaces, aggr modify to adjust
its settings, or aggr delete to cancel the aggregation.

aggr create -l interface_list [-L { off | active | passive } ] aggr_name

aggr modify [-a interface_list] [-r interface_list] [-L { off | active | passive } ] aggr_name

aggr delete aggr_name

PARAMETER INFO
-l: List of interfaces (separated by comma ",") for the new aggregation
-a: Interfaces (separated by comma ",") added to the specified aggregation
-r: Removing interfaces (separated by comma ",") from the aggregation
-L ("active" by default): LACP mode
interface_list: List of interfaces (separated by comma ",") added to the aggregation
aggr_name: Aggregation name

For example:

> aggr create -l ch0,ch1,ch2,ch3 aggr1


The operation has been completed.
CLI: Successful
Return: 0x0000
> aggr modify -a ch4,ch5 -r ch0,ch1 aggr1
The operation has been completed.
CLI: Successful
Return: 0x0000
> aggr delete aggr1
The operation has been completed.
CLI: Successful
Return: 0x0000

V IEW CURRENT LINK AGGREGATION

Use the following command to view the aggregated interface.

aggr show [aggr_name]

© 2014 Infortrend Technology Inc. All Rights Reserved. 59


EonNAS Command Line Interface
User Manual
If aggr_name is not specified, all existing aggregations will be displayed. For example:

> aggr show


Name LCAP Mode Member
aggr1 active ch0 ch1 ch2 ch3
aggr2 passive ch4 ch5 ch6 ch7
CLI: Successful
Return: 0x0000

NAME dladm
SYNOPSIS dladm subcommand parameters
DESCRIPTION
Configure Jumbo frame by setting the maximum transmission unit (MTU, or "frame size") for
your interfaces.

S ET J UMBO F RAME

Use the following command to set the frame size for an interface.

dladm set <interface> -p mtu={ 1500 | 4096 | 8192 }

PARAMETER INFO
-p: Parameter
mtu: Frame size

For example:

> dladm set CH0 -p mtu=4096


The jumbo frame size has been configured.
CLI: Successful
Return: 0x0000

V IEW J UMBO F RAME

Use the following command to display the frame size for specified interface.

dladm show [interface]

If interface is not specified, information on all interfaces will be displayed. For example:

> dladm show


Interface Frame Size Status
CH0 1500 byte Supported
CH1 1500 byte Supported
CH2 1500 byte Supported
CH3 1500 byte Supported

© 2014 Infortrend Technology Inc. All Rights Reserved. 60


EonNAS Command Line Interface
User Manual
Mgmt1 1500 byte Not Supported
CLI: Successful
Return: 0x0000

NAME vlan
SYNOPSIS vlan subcommand parameters
DESCRIPTION
Use the commands in this section to configure VLAN (Virtual LAN) settings.

V IEW VALN STATUS

Use the following command to view VLAN status.

vlan status [interface]

For example:

=>> vlan status ch0


101
CLI: Successful
Return: 0x0000

If the specified interface has not been configured for VLAN, the output of the command will
be empty:

=>> vlan status ch1


CLI: Successful
Return: 0x0000

If interface is not specified, the information of each VLAN link will be displayed in a one-line
synopsis.

=>> vlan status


Interface VLAN ID
CH0 101
CH2 102
CLI: Successful
Return: 0x0000

ADD OR DELETE VLAN ASSIGNMENT

Use the following command to assign a VLAN ID to a network interface (which will become
a virtual interface), or cancel a VLAN ID assignment.

vlan add interface -v vid

© 2014 Infortrend Technology Inc. All Rights Reserved. 61


EonNAS Command Line Interface
User Manual
vlan delete interface [f]

PARAMETER INFO
-v (from 2 to 4094): VLAN ID
-f: -f: Forceful implementation without confirmation

For example:

> valn delete VLAN3


Are you sure you want to delete it (y/n)? n
CLI: User aborted
Return: 0x0011
> valn delete VLAN3 -f
The VLAN has been deleted.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 62


EonNAS Command Line Interface
User Manual

Manage External Devices


NAME printer
SYNOPSIS printer subcommand parameters
DESCRIPTION
Use the commands in this section to manage printers connected to your system.

V IEW PRINTERS AND THEIR STATUS

View available printers yet to be configured:

printer list [-c {ctrla|ctrlb}]

PARAMETER INFO
-c: Controller to which the printer is connected.

If -c is not assigned, all available printers for both controllers will be listed. For Example:

=>> printer list


Printer ID Controller Dscription
2420 A HP-Laserjet-2420
CLI: Successful
Return: 0x0000

View status of configured printers:

printer status [<-c {ctrla|ctrlb}> <-p printer_name>]

PARAMETER INFO
-c: Controller to which the printer is connected
-p: Printer name

For example:

=>> printer status -c ctrla -p 2420


Name: 2024
Controller: A
Job: 0
Status: Idle
Connection: usb://HP/Lasetjet%202420
Sharing: Enabled
Description: HP Laserjet 2420
CLI: Successful
Return: 0x0000

If -p is not specified, information about each connected printer will be displayed in a one-line
synopsis. For example:

=>> printer status

© 2014 Infortrend Technology Inc. All Rights Reserved. 63


EonNAS Command Line Interface
User Manual
Name Controller Job Status
2024 A 0 Idle
1510 B 2 Processing
CLI: Successful
Return: 0x0000

M ANAGE PRINTERS

Use printer add or printer delete to add or remove an available printer, and use printer
options to adjust its settings.

printer add <-c {ctrla|ctrlb}> <-p printer_ID> [-n name] [-s {on|off}] [-d description]
{ [-v vendor] [-m model] | [-P PPD_file] }

printer options <-c {ctrla|ctralb}> <-p printer_name> [-s {on|off}][-d description]

printer delete <-c {ctrla|ctrlb}><<-p printer_name>> [-f]

PARAMETER INFO
-c: Controller to which the printer is connected
-p: Printer ID for printer add; printer name for printer options and printer delete
-n: Printer name for printer add
-s (on by default): Sharing the printer
-d: Description
-v: Vendor
-m: Model
-P: Full path of PPD file
-f: Forceful removal without confirmation

For example:

=>> printer options -c ctrla -p 2420 -s off


The printer has been configured.
CLI: Successful
Return: 0x0000
=>> printer delete -c ctrla -p 2420
Are you sure you want to remove this printer? (y/n) n
CLI: User aborted
Return: 0x0011
=>> printer delete -c ctrla -p 2420 -f
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 64


EonNAS Command Line Interface
User Manual

M ANAGE PRINTING JOBS

Use printer pause or printer resume to pause or resume the printing jobs of a printer. To
view the list of queued printing jobs, use printer jobs.

printer pause <-c {ctrla|ctrlb}> <-p printer_name>

printer resume <-c {ctrla|ctrlb}> <-p printer_name>

printer jobs <-c {ctrla|ctrlb}> <-p printer_name>

PARAMETER INFO
-c: Controller to which the printer is connected
-p: Printer name

For example:

=>> printer pause -c ctrla -p 2420


The printer job has paused.
CLI: Successful
Return: 0x0000
=>> printer resume -c ctrla -p 2420
The printer job has resumed.
CLI: Successful
Return: 0x0000
=>> printer jobs -c ctrla -p 2420
Job User Document Printer Size State
2 root Test Page HP-Laserjet-2420 1K Processing
CLI: Successful
Return: 0x0000

Note: "Job" represents the queue ID of a printing job.

NAME extdrv
SYNOPSIS extdrv subcommand parameters
DESCRIPTION
Use the commands in this section to manage external drives connected to the system.

Note: USB drive name can contain space, but its length should not exceed 32 characters.

V IEW EXTERNAL DRIVE INFORMATION

Use the following command to display the information of connected external drives.

extdrv status [-c {ctrla|ctrlb} -d drive_ID]

© 2014 Infortrend Technology Inc. All Rights Reserved. 65


EonNAS Command Line Interface
User Manual
PARAMETER INFO
-c: Controller to which the external drive is connected
-d: Drive ID

For example:

=>> extdrv status -c ctrla -d c0t0d0p0


ID: c0t0d0p0
Name: Kingston DataTraveler 2.0
Controller: A
Size: 1.9G
Used: 60K
Available: 1.9G
File System: FAT32
Label:
CLI: Successful
Return: 0x0000

If -d is not specified, the information of each drive will be displayed in a one-line synopsis.
For example:

=>> extdrv status


ID Name Controller Mount Point
c0t0d0p0 DataTraveler A /mnt/Kingston_DataTraveler/
CLI: Successful
Return: 0x0000

R EMOVE EXTERNAL DRIVE

Use the following command to remove an external drive.

extdrv remove <-c {ctrla|ctrlb}> <-d drive_ID> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation
-d: Drive ID

For example:

=>> extdrv remove -c ctrla -d c0t0d0p0


Are you sure you want to remove the external storage? (y/n) n
CLI: User aborted
Return: 0x0011
=>> extdrv remove -c ctrla -d c0t0d0p0 -f
The external storage has been removed.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 66


EonNAS Command Line Interface
User Manual

Notify System Events


NAME smtp
SYNOPSIS smtp subcommand parameters
DESCRIPTION
Use the commands in this section to have the system notify users of system events via SMTP.

E NABLE / DISABLE SMTP SERVICE

Use the following command to view SMTP status, or to turn it on or off.

smtp status [ on | off ]

For example:

> smtp status on


SMTP hasn’t been configured.
CLI: Failed (general)
Return: 0x0001
> smtp status
The SMTP notification is disabled.
CLI: Successful
Return: 0x0000
> smtp status off
Successfully configured
CLI: Successful
Return: 0x0000

M ODIFY SMTP SETTINGS

Use the following command to modify SMTP settings.

smtp options [-a address] [-P port] [-u username] [-p password] [-s { none | ssl }]
[-S sender] [-r receiver] [-l { none | information | warning | error | critical }]

PARAMETER INFO
-a: Address of the SMTP server
-P: Port of the SMTP server
-u: User name
-p: Password
-s (none by default): Security level, including none and ssl
-S: Sender’s email address
-r: Receiver’s email address
-l (none by default): Minimum severity level (from the lowest "information” to the highest

© 2014 Infortrend Technology Inc. All Rights Reserved. 67


EonNAS Command Line Interface
User Manual
"critical") to send notification email

For example:

> smtp options -a mail.abc.com -u admin -p xxxx -S NASmgmt@abc.com -r mis@abc.com


-l error
Successfully configured
CLI: Successful
Return: 0x0000

If none of the parameters is specified, you will see the current settings:

> smtp options


SMTP hasn’t been configured.
CLI: Successful
Return: 0x0000
> smtp options
SMTP Server: mail.abc.com
SMTP Port: 25
SMTP User: admin
SMTP Security: none
Sender Email Address: NASmgmt@abc.com
Receiver Email Address: mis@abc.com
Event Level: Error

S END TEST EMAIL

Use the following command to send a test message to check if SMTP notification is working well.

smtp test

For example:

> smtp test


Failed to send the mail.
CLI: Failed (general)
Return: 0x0001

NAME snmp
SYNOPSIS snmp subcommand parameters
DESCRIPTION
Use the commands in this section to configure clients who will receive notification via SNMP
(Simple Network Management Protocol).

E NABLE / DISABLE SNMP SERVICE

© 2014 Infortrend Technology Inc. All Rights Reserved. 68


EonNAS Command Line Interface
User Manual

Use the following command to enable or disable SNMP notification service.

snmp status [ on | off ]

For example:

>snmp status on
Configuration has been completed.
CLI: Successful
Return: 0x0000

If on or off is not specified, current status will be displayed. For Example:

>snmp status
SNMP notification is disabled.
CLI: Successful
Return: 0x0000

M ODIFY SNMP NOTIFICATION SETTINGS

Use the following command to modify the settings of SNMP notification.

snmp options [-a address] [-P port] [-l { none | information | warning | error | critical } ]

PARAMETER INFO
-a: Address of SNMP trap receiver
-P (162 by default): Port
-l: Minimum severity level to send SNMP trap message

For example:

> snmp options -a 192.168.11.22 -l error


Configuration has been completed.
CLI: Successful
Return: 0x0000

If none of the parameters is specified, you will see the current settings:

> snmp options


The SNMP hasn’t been configured.
CLI: Successful
Return: 0x0000
> snmp options
SNMP Trap Host: 192.168.11.22
SNMP Trap Port: 162
Event Level: Error
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 69


EonNAS Command Line Interface
User Manual

Manage Storage Space


NAME pool
SYNOPSIS pool subcommand parameter
DESCRIPTION
Use the commands in this section to manage pools and view pool status.

C REATE POOL

Use the following command to create a new pool by adding a RAID group, or optionally
adding one or more spare drives or SSDs as cache drives ("ZIL" for "write cache" or "Log",
"L2ARC" for "read cache").

pool create pool_name [-f] <-t {raid0|raid1|raid5|raid6}> < -d disk1 [disk2 …] >
[-s diskn [diskn+1 …] ] [-l SSD1 [SSD2 [-m on|off ]] ] [-c SSDn [SSDn+1] ]
<-o { ctrla | ctrlb } >

-f: Forceful implementation without confirmation


-t: Pool RAID type (The default type depends on the number of member drives.)
-d: Member drive(s) (separated by space)
-s: Spare drive(s)
-l: Log (ZIL) device(s)
-m (on by default): Mirror log drives if there are more than one of them in the pool
-c: Cache (L2ARC) device(s)
-o (R-models only): Controller which manages the pool

D ESTROY POOL

Use the following command to remove a pool.

pool destroy pool_name [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

E XPAND POOL

Use the following command to expand your pool by adding a RAID group, or adding one or
more ZIL ("write cache" or "Log"), L2ARC ("read cache"), or spare drives to it.

Note: To enhance data protection, it is strongly recommended that the added RAID group or
ZIL/L2ARC drives contain more than 1 disk.

© 2014 Infortrend Technology Inc. All Rights Reserved. 70


EonNAS Command Line Interface
User Manual
pool add pool_name { -t {raid0|raid1|raid5|raid6} -d disk1 [disk2 … ] |
-s diskn [diskn+1 … ] |
-l SSD1 [SSD2] [-m on|off] |
-c SSDn [SSDn+1] } [ -f ]

PARAMETER INFO
-t: Pool RAID type (The default type depends on the number of added drives.)
-d: Member drive(s) (separated by space)
-s: Spare drive(s)
-l: Log (ZIL) drive(s)
-c: Cache (L2ARC) drive(s)
-m (on by default): Mirror log drives if there are more than one of them in the pool
-f: Forceful implementation without confirmation (not recommended)

P ERFORM MEDIA SCAN

Use the following commands to start or stop a media scan of your pool.

pool mediascan start pool_name [-p {low|high}]


pool mediascan stop pool_name

PARAMETER INFO
-p (low by default): Priority

V IEW POOL STATUS

Use the following command to view the status of a pool.

pool status [pool_name]

For example:

> pool status Pool-1


Media scan repaired 0 in 0h0m with 0 errors on Sun Dec 22 00:00:50 2013
Configuration
Name Status Read Write Checksum
Pool-1 ONLINE 0 0 0
RAID#0 ONLINE 0 0 0
j13d1 ONLINE 0 0 0
j13d2 ONLINE 0 0 0
d5 ONLINE 0 0 0
d6 ONLINE 0 0 0
d3 ONLINE 0 0 0
CLI: Successful
Return: 0x0000

If pool_name is not assigned, the status of each pool will be displayed in a one-line

© 2014 Infortrend Technology Inc. All Rights Reserved. 71


EonNAS Command Line Interface
User Manual
synopsis, which contains pool name, used space, free space, utilization, status, media
scan, deduplication ratio, and assigned owner. For example:

> pool status


Name Used Free Utilization Status MediaScan Dedupe Owner (Current)
Pool-1 15.9GB 1.55TB 0.99% Online None 0% A (B)
Pool-2 15.9GB 1.55TB 0.99% Online None 1% B (B)
CLI: Successful
Return: 0x0000

If no pool has been created in the system, the output will be empty:

> pool status


CLI: Successful
Return: 0x0000

ASSIGN POOL OWNER

Use the following command to view or reassign pool owner to Controller A or Controller B.

Note: This command is not supported by G-models.

pool options owner pool_name { ctrla | ctrlb }[-f]

For example:

> pool options owner pool-1 ctrla


The pool has been assigned to Controller A
CLI: Successful
Return: 0x0000

R EMOVE POOL DRIVES

Use the following command to remove one or more drives from a pool.

pool remove pool_name { -l | -c | -s } {-d disk1 [disk2 …] }

PARAMETER INFO
-l: Log (ZIL) drive(s)
-c: Cache (L2ARC) drive(s)
-s: Spare drive(s)
-d: Disk drive(s)

R EPLACE POOL DRIVES

Use the following command to replace a member drive of a pool.

pool replace pool_name old_disk [new_disk] [-f]

© 2014 Infortrend Technology Inc. All Rights Reserved. 72


EonNAS Command Line Interface
User Manual
PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> pool replace Pool-1 d5 d6


The drive has been replaced.
CLI: Successful
Return: 0x0000

If new_device is not assigned, the system would assume that the old drive has been
removed, and a new one has been installed in the same slot. For Example:

> pool replace Pool-1 d3


The drive has been replaced.
CLI: Successful
Return: 0x0000

E XPORT POOL

If you want to migrate member disks of a pool to another EonNAS, use the following
command to export the pool first.

pool export pool_name [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> pool export Pool-1 -f


The pool has been exported.
CLI: Successful
Return: 0x0000

I MPORT POOL

If you have migrated some or all member disks of a pool from another EonNAS and install
them on the system, use the following command to import the pool.

pool import [pool_name] [-o { ctrla | ctrlb } ] [-d] [-f]

PARAMETER INFO
-o: Owner of the pool (Controller A or B)
-d: Deleting the pool (required if you didn’t migrate all disks of the pool)
-f: Forceful implementation without confirmation (not recommended)

For example:

> pool import Pool-1 -o ctrla

© 2014 Infortrend Technology Inc. All Rights Reserved. 73


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

If pool_name is not assigned, all pools available for import will be listed.

> pool import


Pool: Pool-1
ID: 198264826623343242
Status: ONLINE
Member Drives:
Disk Size Status
d7 419.1GB ONLINE
d8 419.1GB ONLINE

Pool: Pool-2
ID: 298264826623343242
Status: ONLINE
Member Drives:
Disk Size Status
d9 419.1GB ONLINE
d10 419.1GB ONLINE
d11 419.1GB ONLINE
CLI: Successful
Return: 0x0000

If there’s no pool available for import, the output will be empty:

> pool import


CLI: Successful
Return: 0x0000

NAME vol
SYNOPSIS vol subcommand parameter
DESCRIPTION
After creating a pool in the system (refer to the previous section), use the commands in this
section to create and manage volumes on the pool.

V IEW VOLUME STATUS

Use the following command to view the status of a volume.

vol status [<pool_name> <volume_name>]

For example:

> vol status Pool-3 Vol003


Name: Vol003

© 2014 Infortrend Technology Inc. All Rights Reserved. 74


EonNAS Command Line Interface
User Manual
Pool: Pool-3
Protocol: Unmapped
Size: 100GB
Thin Provision: Disabled
Reserved: 0GB
Used: 0GB
Available: 100GB
Threshold: None
Deduplication: Disabled
Compression: Disabled
Transaction Log: Enabled
Continuous Available: Enabled
Block Size: 128K
CLI: Successful
Return: 0x0000

Make sure both pool_name and volume_name are specified, or you might see the following
return code:

> vol status Vol_not_existed


CLI: No required parameter
Return: 0x0003

Make sure the volume and pool you specified actually exist, or you might see the following
return code:

> vol status Pool-1 Vol_not_existed


CLI: Not exist (no such item)
Return: 0x000b

If volume_name is not specified, the status of each volume will be displayed in a one-line
synopsis, which includes Name, Protocol, Size, Used, Available, and Threshold. For
example:

> vol status


Name Pool Protocol Size Used Available Threshold
Vol001 Pool-1 Unmapped 100GB 0GB 100GB 70%
Vol002 Pool-2 iSCSI 100GB 50GB 50GB none
CLI: Successful
Return: 0x0000

C REATE VOLUME

Use the following command to create a volume.

vol create <pool_name> <volume_name> -s size [-t {on [reserved_size] | off} [-d {on | off}]
[-c {on | off} ] [-a {on | off} ] [-l {on | off} ]
[-x optname=optvalue …]

PARAMETER INFO

© 2014 Infortrend Technology Inc. All Rights Reserved. 75


EonNAS Command Line Interface
User Manual
-s: Volume size
-t (off by default): Thin provision
-d (off by default): Deduplication
-c (off by default): Compression
-a (on by default): “Continuously Available”
-l (on by default): “Transaction Log”
-e (off by default): Encryption
-ut (auto by default): Unlock type (whether to unlock the encrypted volume automatically
or manually after the system reboots)
-p: Password
-x: Extended options in the option=value format; current extended options include the
following:
[-x monitoring={on|off}] (off by default): Turning capacity monitoring on/off
[-x threshold=nn] (70 by default; 0-100 are available): The monitoring threshold used to
send a warning event when reached
[-x thlevel={information | warning | error | critical}] (warning by default): Level of event
severity when the monitoring threshold is reached
[-x volblocksize=nnn] (8Kbyte by default; any value to the power of 2 and within the
range of 512bytes and 128Kbytes is valid): Volume block size
Note: volblocksize cannot be changed once there's data activity in it.

For example:

> vol create pool1 vol01 –s 100m –x volblocksize=128k


> vol create pool-1 vol001 ......... –x monitoring=on

M ODIFY V OLUME O PTIONS

Use the following command to modify the options of a volume.

vol options <pool_name> <volume_name> [-s size] [-t {on [reserved_size] | off}] [-d {on | off}]
[-c {on | off} ] [-a {on | off} ] [-l {on | off} ]
[-ut {auto|manual}]
[-lk {on|off {-p password|-k path_keyfile_name}}]
[-e keyfile_path][-u new_password]
[-x optname=optvalue …]

PARAMETER INFO
-s: Volume size
-t: Thin provision
-d: Deduplication
-c: Compression
-a: “Continuously Available”

© 2014 Infortrend Technology Inc. All Rights Reserved. 76


EonNAS Command Line Interface
User Manual
-l: “Transaction Log”
-ut: Unlock type
-p: Password
-k: Encryption key file with full path
-lk: Locking the volume with encryption
-e: Exporting the encryption key file
-u: Updating the password
-x: Extended options in the option=value format; current extended options include the
following:
[-x monitoring={on|off}] (off by default): Turning capacity monitoring on/off
[-x threshold=nn] (70 by default; 0-100 are available): The monitoring threshold used to
send a warning event when reached
[-x thlevel={information | warning | error | critical}] (warning by default): Level of event
severity when the monitoring threshold is reached
-f: Forceful implementation without showing confirmation messages for the following
parameters: a -on (enabling "write-through" for data integrity), a -off (enabling
"write-back" for performance gains), l -off (disabling transaction logs for performance
gains)

For example:

> vol options pool-1 folder ......... –x monitoring=on threshold=80


thlevel=error

D ELETE VOLUME

Use the following command to delete a volume.

vol delete <pool_name> <volume_name> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> vol delete Pool-1 Vol01


Are you sure you want to delete the volume (y/n)? y
CLI: Successful
Return: 0x0000
> vol delete Pool-1 Vol01 -f
CLI: Successful
Return: 0x0000

M AP / UNMAP VOLUMES

© 2014 Infortrend Technology Inc. All Rights Reserved. 77


EonNAS Command Line Interface
User Manual

Use the following commands to map/unmap a volume of a target. For more information
about targets, refer to the next section.

vol map <pool_name> <volume_name> [-l target1 [target2 …] ]


vol unmap <pool_name> <volume_name> {-a | -l target1 [target2 … ] }

PARAMETER INFO
-l: List of target(s)
-a: Unmapping the volume from all mapped target(s)

NAME target
SYNOPSIS target subcommand parameter
DESCRIPTION
Use the commands in this section to manage an iSCSI/Fibre target, allowing an authorized
initiator (on the client or host server side) to access volumes mounted onto the target.

V IEW TARGET STATUS

Use the following command to view the status of a target.

target status [target_name]

For example:

=>> target status Target-1


Name: Target-1
IQN/WWN:
iqn.2002-10.com.infortrend:eonnas:3016:target-1.ch0
CHAP Authentication: Disabled
CHAP Type: -
CHAP Name: -
CHAP Secret: -
Access List of Initiator: All

CLI: Successful
Return: 0x0000

If target_name is not specified, the status of each target will be displayed in a one-line
synopsis, which includes "Name", "IQN/WWN", "Volume" (number of mounted volumes),
and "Session" (connected session). For example:

> target status


Name IQN/WWN Volume Session
Target-1 iqn.2002-10.com.ift:eonnas:3016.target-1.ch0 0 0
Target-2 iqn.2002-10.com.ift:eonnas:3016.target-2.ch1 2 0

© 2014 Infortrend Technology Inc. All Rights Reserved. 78


EonNAS Command Line Interface
User Manual
FCPort-1 10:00:00:60:69:00:23:74 0 0
FCPort-2 10:00:00:60:60:00:23:74 0 0

CLI: Successful
Return: 0x0000

C REATE I SCSI TARGET

Use the following command to create an iSCSI target.

Note: There’s no need to manually create Fibre targets because they are automatically
created and assigned to the Fibre Channel ports available on your system.

target create target_name [ -C {on |off} ] [ -T {normal | mutual} ][ -N name ][ -S secret ]


[-p initiator1 [initiator2…] ]

PARAMETER INFO
-C (off by default): CHAP authentication
-T (normal by default): CHAP type
-N: CHAP name
-S (between 12 and 16 characters): CHAP secret (password)
-p: Initiator(s) allowed to connect to the target

For example:

> target create target-1 -c off -p alias1


CLI: Unknown parameter
Return: 0x0004
(“-C” is upper case.)

In the following example, CHAP is disabled, so all initiators are allowed to connect to
target-1:

> target create target-1


CLI: Successful
Return: 0x0000

D ELETE TARGET

Use the following command to delete a target.

target delete target_name [ -f ]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> target delete target-1

© 2014 Infortrend Technology Inc. All Rights Reserved. 79


EonNAS Command Line Interface
User Manual
Are you sure you want to delete the target (y/n)? y
CLI: Successful
Return: 0x0000
> target delete target-1 -f
CLI: Successful
Return: 0x0000

M ODIFY TARGET ATTRIBUTES

Use the following command to modify the attributes of a target.

target options target_name [-C {on|off}] [-T {normal|mutual}][-N name][-S secret]


[-l] [-p initiator […]][-r initiator […]]

PARAMETER INFO
-C (off by default): CHAP authentication
-T (normal by default): CHAP type
-N: CHAP name
-S (between 12 and 16 characters): CHAP secret (password)
-l: List of initiator(s) permitted to access the target
-p: Adding initiator(s) to the permitted list
-r: Removing initiator from the permitted list
Note: -C, -T, -N, and -S could be used with iSCSI targets only and therefore are regarded
as invalid values by Fibre targets.

For example:

> target options fibre_target -p alias1 alias2 alias3


CLI: Successful
Return: 0x0000

In the following example, since -C is invalid for Fibre targets, you will see the following
return code:

> target options fibre_target -C on


CLI: Invalid parameter
Return: 0x0005

And you are not allowed to add Fibre Channel initiators to an iSCSI target:

> target option iscsi_target -p FC_alias1 iSCSI_alias_1


CLI: Invalid parameter
Return: 0x0005

M OUNT VOLUMES ONTO TARGET

Use the following command to mount one or more volumes onto a target, or view its

© 2014 Infortrend Technology Inc. All Rights Reserved. 80


EonNAS Command Line Interface
User Manual
mounted volumes.

target mount target_name [-l volume_path1 [volume_path2 …]]

PARAMETER INFO
-l: Mounting listed volume(s) onto the target

For example:

> target mount i_target_3 -l /pool-2/vol-1 /pool-2/vol-2


CLI: Successful
Return: 0x0000

Make sure the full path of the volume is correct, or you might see the following return code:

> target mount i_target_3 -l /pool-2/vol-not_existed


CLI: Invalid parameter
Return: 0x0005

If -l is not specified, you can see a list of volume(s) already mounted to the target:

> target mount i_target_1


Name: i_target_1
Mounted Volumes: /Pool-1/Volume_1
/Pool-1/Volume_2
CLI: Successful
Return: 0x0000

If there isn’t any volume mounted onto the target, the output will be empty:

> target mount i_target_2


CLI: Successful
Return: 0x0000

U NMOUNT VOLUMES

Use the following command to unmount one or more volumes from a target.

target unmount target_name {-a |-l volume_path1 [volume_path2 … ] }

PARAMETER INFO
-a: Unmounting all mounted volumes
-l: Unmounting listed volume(s) from the target

For example:

> target unmount i_target_6 -l /Pool-1/mounted_vol


CLI: Successful
Return: 0x0000

If the volume is not already mounted to the target, you will see the following return code:

© 2014 Infortrend Technology Inc. All Rights Reserved. 81


EonNAS Command Line Interface
User Manual
> target unmount i_target_4 -l /Pool-1/non_mounted_vol
CLI: Invalid parameter
Return: 0x0005

Make sure the volume to unmount is specified:

> target unmount i_target_3


CLI: No required parameter
Return: 0x0003

Either -l or -a should be included:

> target unmount i_target_5 /Pool-1/mounted_vol


CLI: Unknown parameter
Return: 0x0004

NAME disk
SYNOPSIS disk subcommand parameter
DESCRIPTION
Use the command in this section to manage disks in the system.

V IEW DISK INFORMATION

Use the following command to view the information of a disk.

disk show [disk_ID [-s] ]

PARAMETER INFO
disk_ID: Disk ID
-s: Viewing SMART information

For example:

> disk show d1 -s


Disk: d1
Disk Model: Hitachi HUA722010CLA330
Serial Number: JPW9P0N013882D
Disk Capacity: 932G
Firmware Version: JP4OA3EA
Temperature: 37°C/99°F
Sector Size: 512 bytes
Overall SMART Health: OK
Media Error: 0
Device Not Ready: 0
No Device: 0
Recoverable: 0
Illegal Request: 250792

© 2014 Infortrend Technology Inc. All Rights Reserved. 82


EonNAS Command Line Interface
User Manual
Predictive Failure Analysis: 0

Display SMART Information


Index Description Value I/O Type
0x00(000) Errors Corrected without Substantial Delay 0 Read
0x01(001) Errors Corrected with Possible Delays 258546 Read
0x02(002) Error Correcred by Rereads/Rewrites 0 Read
0x03(003) Total Errors Corrcted 258546 Read
0x04(004) Total Times Connection Algorithm Processed 1386364 Read
0x06(006) Total Uncorrected Errors 0 Read
0x00(000) Errors Corrected without Substantial Delay 0 Write
0x01(001) Errors Corrected with Possible Delays 1280768 Write
0x02(002) Error Correcred by Rereads/Rewrites 0 Write
0x03(003) Total Errors Corrcted 1280768 Write
0x04(004) Total Times Connection Algorithm Processed 1041499 Write
0x06(006) Total Uncorrected Errors 0 Write
0x00(000) Errors Corrected without Substantial Delay 0 Verify
0x01(001) Errors Corrected with Possible Delays 92 Verify
0x02(002) Error Correcred by Rereads/Rewrites 0 Verify
0x03(003) Total Errors Corrcted 92 Verify
0x04(004) Total Times Connection Algorithm Processed 22562 Verify
0x06(006) Total Uncorrected Errors 0 Verify
CLI: Successful
Return: 0x0000
> disk show d1
Disk: d1
Disk Model: Hitachi HUA722010CLA330
Serial Number: JPW9P0N013882D
Disk Capacity: 932G
Firmware Version: JP4OA3EA
Temperature: 37 degrees Celsius / 99 degrees Fahrenheit.
Sector Size: 512 bytes
Overall SMART Health: OK
Media Error: 0
Device Not Ready: 0
No Device: 0
Recoverable: 0
Illegal Request: 250792
Predictive Failure Analysis: 0
CLI: Successful
Return: 0x0000

If disk_ID is not specified, information about each disk will be displayed in a one-line
synopsis. For Example:

> disk show


Disk ID Model Name Size Used In
d1 Hitachi HUA72201 931.51GB Pool-1
d2 Hitachi HUA72201 931.51GB Pool-1

© 2014 Infortrend Technology Inc. All Rights Reserved. 83


EonNAS Command Line Interface
User Manual
d3 Hitachi HUA72201 931.51GB N/A
CLI: Successful
Return: 0x0000

NAME ssd
SYNOPSIS ssd subcommand parameter
DESCRIPTION
Use the following command to view the information about a SSD drive.

ssd show [disk_ID]

If disk_ID is not specified, information about each SSD will be displayed in a one-line
synopsis.

© 2014 Infortrend Technology Inc. All Rights Reserved. 84


EonNAS Command Line Interface
User Manual

Manage Folders
NAME folder
SYNOPSIS folder subcommand parameter
DESCRIPTION
Use the commands in this section to manage folders.

V IEW FOLDER STATUS

Use the following command to view the status of a folder.

folder status [ <pool_name> <folder_name> ] [ { -e | -w }]

PARAMETER INFO
-e: Viewing encrypted folder(s)
-w: Viewing WORM (write once read many) folder(s)

For example:

> folder status Pool-1 Folder-1


Directory: /Pool-1/Folder-1
Quota: None
Reserved: None
Used: 10GB
Available: 905GB
Threshold: 70%
Deduplication: Disabled
Compression: Disabled
Anti-Virus: Disabled
Transaction Log: Enabled
Case Sensitivity: Sensitive
Record Size: 128K
CLI: Successful
Return: 0x0000
> folder status Pool-1 bbb -w
Folder Created on Expiration Date Status
/Pool-1/bbb 2013-07-29 16:08:59 2014-01-25 16:08:59
CLI: Successful
Return: 0x0000

If pool_name and folder_name are not specified, the brief status of each folder will be
displayed in a one-line synopsis, which includes Directory, Quota, Used, Available, and
Threshold. For example:

> folder status


Directory Quota Used Available Threshold
/Pool-1/Folder-1 none 10GB 905GB none

© 2014 Infortrend Technology Inc. All Rights Reserved. 85


EonNAS Command Line Interface
User Manual
/Pool-2/Folder-2 100GB 20GB 80GB 70%
CLI: Successful
Return: 0x0000
> folder status -e
Folder Pool Status Mounting Type
Enc_Folder_01 Pool-1 Locked Manual
Enc_Folder_02 Pool-2 Unlocked Automatic
CLI: Successful
Return: 0x0000
> folder status -w
Folder Created on Expiration Date Status
/Pool-1/aaa 2013-07-29 16:08:59 2014-01-25 16:08:59
/Pool-1/bbb 2013-07-29 16:08:59 2014-01-25 16:08:59
CLI: Successful
Return: 0x0000

C REATE FOLDER

Use the following command to create a folder.

folder create <pool_name> <folder_name> [ -q { max_size | none } ] [ -r {min_size | none } ]


[ -d { on | off } ] [ -c { on | off } ] [ -a { on | off } ] [ -l { on | off } ]
[ -e { off | on }] [ -t { auto | manual }] -p password ]
[ -w { off | on period={yyyymmdd | forever } } ]
[ -x option=value ]
[-f]

folder options <pool_name> <folder_name> [ -q { max_size | none } ] [ -r {min_size | none } ]


[ -d { on | off } ] [ -c { on | off } ] [ -a { on | off } ] [ -l { on | off } ]
[ -t { auto | manual } ] [ {-p password | -k path_keyfile } ]
[ -m on | off ] [ -e keyfile_path ] [-u new_password]
[ -w { off | on period={yyyymmdd | forever } } ]
[ -x option=value ]
[-f]

PARAMETER INFO
Basic settings:
-q (none by default): Setting quota size
-r (none by default): Setting minimum size
-d (off by default): Enabling deduplication
-c (off by default): Enabling compression
-a (off by default): Enabling antivirus
-l(on by default): Enabling transaction log

Encryption-related settings:

© 2014 Infortrend Technology Inc. All Rights Reserved. 86


EonNAS Command Line Interface
User Manual
-e (off by default) for folder create: Enabling folder encryption
-t (auto if -e is set to on): Mounting type
-p: Password
-k: Path of key file
-e (for folder options): Exporting key file
-m (for folder options): Mounting/Unmounting encrypted folder
-f: Forceful password implementation without confirmation

WORM folder related settings:


-w: Configuring WORM folder options

Extended option:
-x: Extended options in the option=value format; current extended options include the
following:
[-x casesensitivity={sensitive | insensitive | mixed}] : Determining case sensitivity
(mixed by default)
[-x monitoring={on|off}] (off by default): Turning capacity monitoring on/off
[-x threshold=nn] (70 by default; 0-100 are available): The monitoring threshold used to
send a warning event when reached
[-x thlevel={information | warning | error | critical}] (warning by default): Level of event
severity when the monitoring threshold is reached
[-x recordsize=nnn] (64k by default when -w on is applied, and 128k by default when -w
off is applied; any value to the power of 2 and within the range of 512bytes and 128kbytes
is valid) : Changing the block size for new files (existing files won’t be affected)
Note: Increasing the block size could achieve performance gains for databases, while
doing so on ordinary files might adversely decrease performance. It is strongly
recommended that you leave the default value without changing it.

For example:

> folder create poolname folder ......... –x monitoing=off


> folder options poolname folder ......... –x monitoring=on threshold=80
thlevel=error
> folder create poolname folder ......... –x recordsize=64k
> folder options poolname folder ......... –x recordsize=64k

D ELETE FOLDER

Use the following command to delete a folder.

folder delete <pool_name> <folder_name> [-f]

PARAMETER INFO:

© 2014 Infortrend Technology Inc. All Rights Reserved. 87


EonNAS Command Line Interface
User Manual
-f: Forceful implementation without confirmation

For example:

> folder delete Pool-1 Folder001


Are you sure you want to delete it? (y/n): y
The folder has been deleted.
CLI: Successful
Return: 0x0000
> folder delete Pool-1 Folder001 -f
The folder has been deleted.
CLI: Successful
Return: 0x0000

NAME fquota
SYNOPSIS fquota command arguments
DESCRIPTION
Use the commands in this section to manage a user’s folder quota.

V IEW USER ’ S FOLDER QUOTA

Use the following command to view a user’s folder quota.

fquota status <pool_name> <folder_name> [username]

If username is not specified, each user’s quota and used capacity will be displayed in a
one-line synopsis. For example:

=>> fquota status Pool-1 folder001


User Quota Used
User1 300MB 0B
User2 300GB 10GB
CLI: Successful
Return: 0x0000

L IMIT USER ’ S FOLDER QUOTA

Use the following command to limit a user’s folder quota to a certain amount of capacity.

fquota create <pool_name> <folder_name> <username> <size>

For Example:

=>> fquota create Pool-1 Folder001 user123 100M


CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 88


EonNAS Command Line Interface
User Manual
Return: 0x0000

R EMOVE QUOTA LIMITS

Use the following command to remove a user’s quota limit on a folder.

fquota delete <pool_name> <folder_name> [username] [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> fquota delete Pool-1 folder001 userABC


Are you sure you want to delete the user quota setting? (y/n) n
CLI: User aborted
Return: 0x0011
=>> fquota delete Pool-1 folder001 userABC -f
CLI: Successful
Return: 0x0000

If username is not specified, all users’ quota limits on this folder will be removed.

NAME portal
SYNOPSIS portal subcommand parameters
DESCRIPTION
Use the commands in this section to manage portal folders, links, and target folders. A
"portal folder" is a virtual folder linked by one or more virtual links, and each link connects to
one or more actual folders (a.k.a. "target folders") located on remote servers. Clients
accessing a virtual folder are in fact using the capacity of one or more remote severs, thus
saving the space on your EonNAS.

M ANAGE PORTAL FOLDERS

Use portal showfolder to view a list of portal folders on your system, portal createfolder
to create a portal folder, portal editfolder to rename a portal folder, and portal
deletefolder to delete a portal folder.

portal showfolder
portal createfolder <portal_folder>
portal editfolder < portal_folder> <new_name>
portal deletefolder < portal_folder> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

© 2014 Infortrend Technology Inc. All Rights Reserved. 89


EonNAS Command Line Interface
User Manual

For example:

=>> portal showfolder


Name
PortalFolder001
PortalFolder002
PortalFolder003
CLI: Successful
Return: 0x0000
=>> portal createfolder PortFolder004
CLI: Successful
Return: 0x0000
=>> portal editfolder PortFolder004 PF0004
CLI: Successful
Return: 0x0000
=>> portal deletefolder PortFolder004
Are you sure you want to delete this item? (y/n)n
CLI: User aborted
Return: 0x0011
=>> portal deletefolder PortFolder004 -f
CLI: Successful
Return: 0x0000

M ANAGE LINKS TO PORTAL FOLDER

Use portal showlink to view one or more links to a portal folder, portal createlink to create
a new link, portal editlink to rename a link, and portal deletelink to delete a link.

portal showlink <portal_folder>


portal createlink <portal_folder> <link>
portal editlink <portal_folder> <link> <new_name>
portal deletelink <portal_folder> <link> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> portal showlink PortalFolder003


Name
Link0001
Link0002
Link0003
CLI: Successful
Return: 0x0000
=>> portal createlink PF0005 link001
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 90


EonNAS Command Line Interface
User Manual
=>> portal editlink PF0005 link001 link-0001
CLI: Successful
Return: 0x0000
=>> portal deletelink PF0005 link-0001
Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011

M ANAGE TARGET FOLDERS OF A LINK

Use portal showtarget to view target folders connected to a portal folder’s link, portal
addtarget to connect a new target folder to the link, portal edittarget to change a target
folder, and portal deletetarget to delete a target folder.

portal showtarget <portal_folder> <link>


portal addtarget <portal_folder> <link> <target_addr> <target_folder>
portal edittarget <portal_folder> <link> <target_addr> <target_folder> [-a new_addr] [-f new_folder]
portal deletetarget <portal_folder> <link> <target_addr> <target_folder> [-f]

PARAMETER INFO
-a: Address of remote server where the new target folder is located
-f: New target folder

For example:

=>> portal showtarget PF0005 link-0001


Name
\\192.168.12.34\sharefolder1
\\192.168.12.34\sharefolder2
\\192.168.12.34\sharefolder3
CLI: Successful
Return: 0x0000
=>> portal addtarget PF0005 link-0001 172.27.12.34 SharedFolder001
CLI: Successful
Return: 0x0000
=>> portal edittarget PF0005 link-0001 172.27.12.34 SF001 -a 172.27.12.22 -f
targetfolder003
CLI: Successful
Return: 0x0000
=>> portal deletetarget PF0005 link-0001 172.27.12.22 targetfolder003
Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011

© 2014 Infortrend Technology Inc. All Rights Reserved. 91


EonNAS Command Line Interface
User Manual
NAME share
SYNOPSIS share subcommand parameter
DESCRIPTION
Use the commands in this section to share a folder and configure its sharing protocols.

S HARE A FOLDER

Use the following command to share a folder.

share folder_path [ cifs {off | on [-a {on|off}] [-n share_name] } |


nfs {off | on } |
afp { off | on [-n share_name] } ]

PARAMETER INFO
-a: Access-based enumeration (ABE, users with read access to the folder can see folder
contents)
-n: Folder’s sharing name

C ONFIGURE FOLDER ’ S CIFS/AFP SHARING PROTOCOL

Use the following commands to configure CIFS or AFP sharing protocols for a folder.

share options folder_path cifs [-n share_name] (not supported by R-model)


share options folder_path afp [-n share_name ]

PARAMETER INFO
-n: Folder’s sharing name

For example:

> share options /Pool-1/Folder-A cifs


Attrib Value
Abe on
CLI: Successful
Return: 0x0000
> share options /Pool-1/folder nfs
Read-Write
Subnet Mask IP
172.27.112.1 255.255.254.0 172.27.112.0 to 172.27.113.255

Read-Only
Subnet Mask IP
172.27.114.1 255.255.254.0 172.27.114.0 to 172.27.114.255

Root Privilege
Subnet Mask IP

© 2014 Infortrend Technology Inc. All Rights Reserved. 92


EonNAS Command Line Interface
User Manual
172.27.1.1 255.255.255.254 172.27.1.0 to 172.27.1.1

CLI: Successful
Return: 0x0000

C ONFIGURE FOLDER ’ S NFS ACCESS RIGHTS

Use the following command to configure a folder’s NFS access rights.

share options folder_path nfs


share options folder_path nfs rw [ -a <subnet> <netmask> ] [ -d <subnet> <netmask> ]
share options folder_path nfs ro [ -a <subnet> <netmask> ] [ -d <subnet> <netmask> ]
share options folder_path nfs root [ -a <subnet> <netmask> ] [ -d <subnet> <netmask> ]

PARAMETER INFO
-a: Adding subnet and netmask
-d: Deleting subnet and netmask

For example:

> share options /Pool-1/folder nfs rw -d 172.27.112.1 255.255.254.0


The sharing settings have been configured.
CLI: Successful
Return: 0x0000

If -a or -d is not specified, you will see the current settings:

> share options /Pool-1/folder nfs rw


Subnet Mask IP
172.27.112.1 255.255.254.0 172.27.112.0 to 172.27.113.255
CLI: Successful
Return: 0x0000

NAME acl
SYNOPSIS acl command argument
DESCRIPTION
Use the commands in this section to configure ACL (Access Control List) privileges for a folder.

V IEW FOLDER ’ S ACL PRIVILEGES

Use the following command to view ACL privileges of a folder.

acl get folder_path [ {-u | -g} name ] | [-s {owner | group | everyone }]

PARAMETER INFO
-u: Username

© 2014 Infortrend Technology Inc. All Rights Reserved. 93


EonNAS Command Line Interface
User Manual
-g: Group name
-s: System user (Current Owner, Current Group, Everyone)

2 entries --- "Allow" and "Deny" --- will be displayed for each user, group, or system user.
For example:

> acl get /pool-1/folder


Current Owner(admin): Allow: Full, Modify, Execute, List, Read, Write
Current Owner(admin): Deny: None
Usera:Allow: Write
Usera:Deny: List
Current Group(admin): Allow: Execute, List, Read
Current Group(admin): Deny: None
everyone: Allow: Execute, List, Read
everyone: Deny: None
CLI: Successful
Return: 0x0000

S ET FOLDER ’ S ACL PRIVILEGES

Use the following command to add or edit an ACL entry for a folder.

acl set folder_path {-u|-g} name {-a|-d|-c} permission [-p]


acl set folder_path { {-u|-g} name | -s { owner | group | everyone } } {-a|-d|-c} permission [-p]

PARAMETER INFO
-u: Username
-g: Group name
-a: Allow
-d: Deny
-c: Clearing the “Allow" or "Deny" setting for the permission
permission: f: Full control; m: Modify; e: Execute; l: List; r: Read; w: Write
-p: Propagating the ACL setting to subfolders (if any)
-s: System user (Current Owner, Current Group, everyone)

For example:

> acl set /Pool-1/FolderA -u usera -a f


The ACL has been configured.
CLI: Successful
Return: 0x0000
> acl set /Pool-1/Folder -g group_1 -c w
The ACL has been configured.
CLI: Successful
Return: 0x0000
> acl set /Pool-1 -u user_b -a m
CLI: Invalid parameter (Parameter format error, out-of-range or mistype)

© 2014 Infortrend Technology Inc. All Rights Reserved. 94


EonNAS Command Line Interface
User Manual
Return: 0x0005

For the above instance, the folder name is not correct.

> acl set /Pool-1/folder -u user_c -c wm


The ACL has been configured
CLI: Successful
Return: 0x0000

R EMOVE USER / GROUP FROM FOLDER ’ S ACL ENTRIES

Use the following command to remove a user or group from a folder’s ACL entries.

Note: "everyone" cannot be removed from ACL entries.

acl delete folder_path { {-u|-g} name | -s {owner | group } } [-p]

PARAMETER INFO
-p: Propagating the ACL settings to subfolders (if any)

For example:

> acl delete /Pool-1/Folder -u userA


The ACL has been configured.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 95


EonNAS Command Line Interface
User Manual

Manage Users & Groups


NAME useradmin user, passwd
SYNOPSIS useradmin user subcommand parameter
passwd [username [password] ]
DESCRIPTION
Use the commands in this section to manage users.

V IEW USER INFO

Use the following command to view user info.

useradmin user list [ username ]

For example:

=>> useradmin user list User_ABC


Name: User_ABC
UID: 101
Type: Local
Home Directory: /Pool-1/UserHome/User_ABC
Superuser: Yes
PWD Expiry Date: 2014-12-31
Description: description...
Group: GroupA, GroupB, GroupC, GroupD
Quota: none
CLI: Successful
Return: 0x0000

If username is not specified, information about each user (admin excluded) will be
displayed in a one-line synopsis. For example:

> useradmin user list


Name Type Group Quota PWD Expiry Date Description
User_ABC Local Group1 none 2014-12-31
User_1 Local Users none 2015-01-31
CLI: Successful
Return: 0x0000

M ODIFY USERS

Use the following commands to create, modify, or delete a local user.

Note: You are not allowed to delete admin.

useradmin user add username [ -i uid] [ -c comment ] -p password


[ -g group1 [group2 … ] ]

© 2014 Infortrend Technology Inc. All Rights Reserved. 96


EonNAS Command Line Interface
User Manual
[ -s on | off ] [ -d { off | on [ home_path ] }]

useradmin user modify username [ -c comment ] [ -s on|off ]


[-g group1 [group2 … ] ] [ -d on [home_path ] ]

useradmin user delete username

PARAMETER INFO
-i: User ID (UID) generated by the system
-c: User description
-p: Account password
-g (Users by default): Group to which the user belongs
-s (off by default): Designating the user as a superuser (user with administrative privilege)
-d (on by default): Enabling user’s home directory by specifying its full path
(“/first_poo/UserHome/username” by default)
-e (90 days by default): Password expiration (0 means the password won't expire)

C HANGE USER PASSWORD

Use the following command to change user password.

passwd [username [password] ]

For example:

> passwd user123 password


CLI: Successful
Return: 0x0000

If username is not specified, you will be changing your own password. For example:

> passwd
Changing password for admin
New password:
Re-enter password:
CLI: Successful
Return: 0x0000

If password is not specified, you will be prompted twice to set a new password. For example:

> passwd user123


New password:
Re-enter password:
CLI: Successful
Return: 0x0000

If the password entered the second time doesn’t match the first one, the password won’t be
changed:

© 2014 Infortrend Technology Inc. All Rights Reserved. 97


EonNAS Command Line Interface
User Manual
> passwd user123
New password: (123)
Re-enter password: (456)
CLI: Failed
Return: 0x0001

M ANAGE USER QUOTA

Use the following command to manage users' quota limits on folders.

useradmin user quota [ -b batch_file ] [ -q username [ folder_path [ size ] ] ]

PARAMETER INFO
-b: Using a batch file to import multiple quota settings (The .csv batch file should contain
one or more lines of tab-delimited values of username, folder_path, and size.)
-q: Modifying a user's quota limit on a folder

If folder_path is not specified, the user’s quota limits on all folders will be displayed. If size is
not specified, user’s quota limits on the folder will be displayed.

NAME useradmin group


SYNOPSIS useradmin group subcommand parameter
DESCRIPTION
Use the commands in this section to manage groups.

V IEW GROUP INFO

Use the following command to view group info.

useradmin group list [group_name [ -u ] ]

PARAMETER INFO
-u: Listing all users belonging to the group

For example:

=>> useradmin group list Group_ABC


Name: Group_ABC
GID: 1003
Type: Network
CLI: Successful
Return: 0x0000

If group_name is not specified, information about each group will be displayed in a one-line
synopsis.

© 2014 Infortrend Technology Inc. All Rights Reserved. 98


EonNAS Command Line Interface
User Manual

M ODIFY GROUPS

Use the following command to create, delete local groups, or add/remove group members.

useradmin group add group_name [ -i group_id ] [ -u username1 [username2 …] ]

useradmin group delete group_name [ -f ]

useradmin group adduser <group_name> <username1> [username2 …]

useradmin group deluser <group_name> <username1> [username2 …]

PARAMETER INFO
-i: Group ID (If it is not assigned, it will be generated automatically.)
-u: One or more users added to the group
-f: Forceful implementation without confirmation

E XPORT U SER /G ROUP L IST


Use either of the following commands to export the list of users or groups to a .csv
file.
useradmin user export <folder_path>

useradmin group export <folder_path>

PARAMETER INFO
folder_path: Full path of the folder to save the exported file

For example:

> useradmin user export /Pool-1/folder01


The user list has been exported.
CLI: Successful
Return: 0x0000
> useradmin group export /Pool-1/folder01
The group list has been exported.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 99


EonNAS Command Line Interface
User Manual

Perform Backups
NAME snapshot
SYNOPSIS snapshot subcommand parameters
DESCRIPTION
Use the commands in this section to manage a snapshot task which creates snapshot
images of a folder manually or on a timely basis.

V IEW SNAPSHOT TASKS

Use the following command to view the status of a snapshot task.

snapshot status [<pool_name> <directory>]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of

For example:

=>> snapshot status Pool-1 folder1


Directory Last Number
Pool-1/folder1 2014-03-10 14:30:00 6
CLI: Successful
Return: 0x0000

If pool_name and directory_path are not specified, all snapshot tasks will be displayed. For
example:

=>> snapshot status


Directory Last Number
Pool-1/folder1 2014-03-10 14:30:00 6
Pool-1/folder2 2014-03-10 14:30:00 6
CLI: Successful
Return: 0x0000

R UN SNAPSHOT TASKS BY SCHEDULE

Use the following command to create a scheduled snapshot task for a folder.

snapshot create <pool_name> <directory >


[-d {daily| mon| tue| wed| thu| fri| sat| sun}][-t hhmm]
[ {-n nnn| -r mmm} ]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located

© 2014 Infortrend Technology Inc. All Rights Reserved. 100


EonNAS Command Line Interface
User Manual
directory: Name of the volume or folder that will be taken snapshots of
-d (daily by default): Scheduled day of the week
-t (0000 by default): Scheduled time in the hhmm format (00≦hh≦23, 00≦mm≦59)
-n (128 by default): Maximum number of snapshot images
-r (180 days by default): Retention period

For example:

=>> snapshot create Pool-1 Folder001 -t 1200


The snapshot schedule has been created.
CLI: Successful
Return: 0x0000

TAKE SNAPSHOTS MANUALLY

Use the following command to manually create a snapshot task.

snapshot add <pool_name> <directory>

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of

For example:

=>> snapshot add Pool-1 folder001


The snapshot has been create.
CLI: Successful
Return: 0x0000

D ELETE SNAPSHOT TASK

Use the following command to delete a snapshot task and all its images.

snapshot delete <pool_name> <directory> [-f]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of
-f: Forceful implementation without confirmation

For example:

=>> snapshot delete Pool-1 folder001


Are you sure you want to delete the snapshot? (y/n) n
CLI: User aborted
Return: 0x0011
=>> snapshot delete Pool-1 folder001 -f

© 2014 Infortrend Technology Inc. All Rights Reserved. 101


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

NAME snapimage

SYNOPSIS sanpimage subcommand parameters

DESCRIPTION
Use the commands in this section to manage snapshot images of a folder.

V IEW SNAPSHOT IMAGES

Use the following command to view snapshot images of a folder.

snapimage status <pool_name> <directory>

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of

For example:

=>> snapimage status Pool-1 Folder_001


Snapshot ID Time Created
ScheduleA_20140401_000000 2014-04-01 00:00:00
ScheduleB_20140401_001000 2014-04-01 00:10:00
ScheduleC_20140401_002000 2014-04-01 00:20:00
Once_20140401_003100 2014-04-01 00:31:00
CLI: Successful
Return: 0x0000

D ELETE SNAPSHOT IMAGE

Use the following command to delete the snapshot image of a folder.

snapimage delete <pool_name> <directory> <snapshot_ID> [-f]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of
snapshot_ID: ID of snapshot image
-f: Forceful implementation without confirmation

For example:

=>> snapimage delete Pool-1 Folder_001 ScheduleB_20140401_001000


Are you sure you want to delete the snapshot? (y/n) n

© 2014 Infortrend Technology Inc. All Rights Reserved. 102


EonNAS Command Line Interface
User Manual
CLI: User aborted
Return: 0x0011
=>> snapimage delete Pool-1 Folder_001 ScheduleB_20140401_001000 -f
CLI: Successful
Return: 0x0000

R OLL BACK SNAPSHOT

Use the following command to roll back a folder by recovering contents from a previous
snapshot image. Doing so will delete all other snapshot images of the folder.

snapimage rollback <pool_name> <directory> <snapshot_ID> [-f]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of
snapshot_ID: ID of snapshot image
-f: Forceful implementation without confirmation

For Example:

=>> snapimage rollback Pool-1 Folder_001 ScheduleB_20140401_001000


Other snapshots will be deleted and I/Os will be temporarily halted. Are you
sure you want to rollback? (y/n) n
CLI: User aborted
Return: 0x0011
=>> snapimage rollback Pool-1 Folder_001 ScheduleB_20140401_001000 -f
CLI: Successful
Return: 0x0000

B ROWSE SNAPSHOT IMAGE CONTENTS

Use the following command to browse contents of a snapshot image.

snapimage view <pool_name> <directory> <snapshot_ID> [-p /path] [-l]

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of
snapshot_ID: ID of snapshot image
-p: Full path of the content within the snapshot image
-l: Listing detailed information

For example:

=>> snapimage view Pool-1 folder001 ScheduleC_20140401_002000


file001 file002 folder_001 folder002
CLI: Successful

© 2014 Infortrend Technology Inc. All Rights Reserved. 103


EonNAS Command Line Interface
User Manual
Return: 0x0000
=>> snapimage view Pool-1 folder001 -l
Name Size Type Last Update
file001.exe 2.2MB exe 2013-11-22 15:09:07
file002 18.9KB 2013-11-22 15:09:07
folder_001 subfolder 2013-11-22 15:09:07
folder002 subfolder 2013-11-22 15:09:07
CLI: Successful
Return: 0x0000

If there isn’t any content within the image, the output will be empty:

> snapimage view Pool-1 folder001 image001 -p /folder_001


CLI: Successful
Return: 0x0000
> snapimage view Pool-1 folder001 image001 -p /folder_001 -l
total 0
CLI: Successful
Return: 0x0000

R ETRIEVE FILE FROM SNAPSHOT IMAGE

Use the following command to retrieve a file from a snapshot image.

snapimage copy <pool_name> <directory> <snapshot_ID>


<-p /file_path> <-d /destination_path>

PARAMETER INFO
pool_name: Name of the pool where the snapshot volume or folder is located
directory: Name of the volume or folder that will be taken snapshots of
snapshot_ID: ID of snapshot image
-p: Full path of the retrieved file
-d: Destination folder

For example:

=>> snapimage copy Pool-1 folder001 ScheduleC_20140401_002000 -p


/folder/file001 -d /Pool-2/folderB
CLI: Successful
Return: 0x0000

C LONE A VOLUME FROM A SNAPSHOT IMAGE

Use the following command to create a cloned volume from a snapshot image. The created
volume could be mounted and accessed by a client.

snapimage mount <pool_name> <volume_name> <snapshot_ID> [cloned_volume_name]


[-t {on [reserved_size] | off} [-d {on | off}]

© 2014 Infortrend Technology Inc. All Rights Reserved. 104


EonNAS Command Line Interface
User Manual
[-c {on | off} ] [-a {on | off} ] [-l {on | off} ]

PARAMETER INFO
-t: Thin provision
-d: Deduplication
-c: Compression
-a: “Continuously Available”
-l: “Transaction Log”
Note: If any of the above parameters are not specified, their values will be the same as
those of the original volume where the snapshot image is created.
-x: Extended options in the option=value format; current extended options include the
following:
[-x monitoring={on|off}] (off by default): Turning capacity monitoring on/off
[-x threshold=nn] (70 by default; 0-100 are available): The monitoring threshold used to
send a warning event when reached
[-x thlevel={information | warning | error | critical}] (warning by default): Level of event
severity when the monitoring threshold is reached

For example:

> snapimage status Pool-1 Vol001


Snapshot ID Time Created
Once_20140805_185509 2014-08-05 18:55:09
CLI: Successful
Return: 0x0000
> snapimage mount Pool-1 Vol001 Once_20140805_185509 Vol001-1
The volume has been created.
CLI: Successful
Return: 0x0000

NAME mirror
SYNOPSIS mirror subcommand parameters
DESCRIPTION
Use the commands in this section to manage a pool mirror task which will perform real-time
data backup from all disks of a source pool to a matching number of available disks on a
target system.

Note: The target system will not be notified about its role as the mirror target.

V IEW POOL MIRROR TASKS

Use the following command to view detailed information about a mirror task.

© 2014 Infortrend Technology Inc. All Rights Reserved. 105


EonNAS Command Line Interface
User Manual
mirror status [task_name]

For example:

=>> mirror status MirrorWizard_Schedule_Pool-10-1_20140319_110502


Name: MirrorWizard_Schedule_Pool-10-1_20140319_110502
Source Host: EonNAS_3016
Source Pool: Pool-1
Target Host: 172.27.112.80
Auto Split: Enabled
Sync Duration: 4 Hours
State: logging
Disk Mapping:
Source Target Diff
------------ ------------ ------------
d1 j1d1 98%
d2 j1d2 98%
d3 j1d3 98%
d4 j1d4 98%
CLI: Successful
Return: 0x0000

If task_name is not specified, all mirror tasks will be displayed. For example:

=>> mirror status


Name State
MirrorWizard_Schedule_Pool-10-1_20140319_110502 logging
CLI: Successful
Return: 0x0000

C REATE AND MODIFY MIRROR

Use the following commands to create a mirror task and modify its options. When a task is
created, disk-to-disk pairing between your EonNAS and the target system will be mapped
automatically. The task name will also be generated automatically.

mirror create <pool_name> <-a address> [-p on|off] [-s off | on [-c {all | hours}] ]
[-d {daily| mon| tue| wed| thu| fri| sat| sun}][-t hhmm]

mirror options <task_name> [-p on|off] [-s on|off] [-c {all | hours}]
[-m source_disk1 target_disk1 [, source_disk2 target_disk2 [, … ]]]

PARAMETER INFO
-a: Address of target system
-p (off by default): Pausing task if I/O activities are detected
-s (off by default): Splitting paired disks and stopping the task if the following -c criterion is
met, or starting the task if any the following -d and -t criteria is met (off indicates "real-time
backup" done by starting the mirror task whenever a change is made to the source pool.)

© 2014 Infortrend Technology Inc. All Rights Reserved. 106


EonNAS Command Line Interface
User Manual
-c (all by default; only effective if -s is set to on): Criteria for splitting paired disks and
stopping the task (all means stopping the task after its completion, hours means the
duration before the task is stopped)
-d (daily by default; only effective if -s is set to on): Day of the week to start the task
-t (0000 by default; only effective if -s is set to on): Time of the day (in the hhmm format;
00≦hh≦23, 00≦mm≦59) to start the task
-m: Manually pairing up disks between source pool and target system (by adding a
comma after each pair)

For example:

=>> mirror create Pool-1 -a 172.27.12.24


The pool mirror task MirrorWizard_Schedule_Pool-10-1_20140319_110502 has
been created.
CLI: Successful
Return: 0x0000
=>> mirror options MirrorWizard_Schedule_Pool-10-1_20140319_110502 -s on -c
The pool mirror task has been configured.
CLI: Successful
Return: 0x0000

D ELETE MIRROR TASK

Use the following command to delete a pool mirror task.

mirror delete <task_name> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> mirror delete MirrorWizard_Schedule_Pool-10-1_20140319_110502


Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011
=>> mirror delete MirrorWizard_Schedule_Pool-10-1_20140319_110502 -f
CLI: Successful
Return: 0x0000

S TART OR STOP MIRROR TASK

Use the following command to launch or stop a pool mirror task.

mirror start <task_name>

mirror stop <task_name> [-f]

© 2014 Infortrend Technology Inc. All Rights Reserved. 107


EonNAS Command Line Interface
User Manual
PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> mirror start MirrorWizard_Schedule_Pool-10-1_20140319_110502


CLI: Successful
Return: 0x0000
=>> mirror stop MirrorWizard_Schedule_Pool-10-1_20140319_110502
Are you sure you want to stop this task? (y/n) n
CLI: User aborted
Return: 0x0011
=>> mirror stop MirrorWizard_Schedule_Pool-10-1_20140319_110502 -f
CLI: Successful
Return: 0x0000

Q UERY AVAILABLE DISK SPACE ON TARGET SYSTEM

Use the following command to query available disk space on the target system.

mirror query <address>

For example:

=>> mirror query 172.27.12.123


Disk Size
d5 419.19GB
d6 34.25GB
d7 68.37GB
d9 34.18GB
CLI: Successful
Return: 0x0000

C ONFIGURE THE TIMEOUT MECHANISM FOR MIRROR TASKS

Use the following command to configure the timeout mechanism for all mirror tasks.

mirror timeout [-t time]

PARAMETER INFO
-t (16 seconds by default; any value between 16 and 300 seconds is valid): Timeout

For example:

> mirror timeout –t 301


The setting is invalid.
CLI: Invalid parameter (Parameter format error, out-of-range or mistype)
Return: 0x0005
> mirror timeout –t 100
The setting has been configured.

© 2014 Infortrend Technology Inc. All Rights Reserved. 108


EonNAS Command Line Interface
User Manual
CLI: successful
Return: 0x0000

If the parameter is not specified, the current timeout setting will be displayed. For example:

> mirror timeout


The setting of timeout is 16 seconds.
CLI: Successful
Return: 0x0000

NAME replicate
SYNOPSIS replicate subcommand parameters
DESCRIPTION
Use the commands in this section to manage a remote replication task which backs up data
from a folder on your EonNAS to another folder on a remote server. The remote server
could be another EonNAS unified storage system, a Linux-based RSYNC server, or a
Windows server with RSYNC add-on installed.

V IEW REMOTE REPLICATION TASKS

Use the following command to view detailed information about a remote replication task.

replicate status [task_name]

For example:

=>> replicate status RemoRep_20140311_143232


Name: RemoRep_20140311_143232
Source Folder: /Pool-1/folder01/
Target Server: NAS
IP Address: 192.168.12.23
Destination: /Pool-1/EonBackup/RemoRep_20140311_143232
Security: None
Status: Ready
Encryption: Disabled
Compression: Disabled
Stop network file service while replicating: Disabled
Delete other files on remote destination: Disabled
Handle sparse files efficiently: Disabled
CLI: Successful
Return: 0x0000

If task_name is not specified, each remote replication task will be displayed in a one-line
synopsis. For example:

=>> replicate status

© 2014 Infortrend Technology Inc. All Rights Reserved. 109


EonNAS Command Line Interface
User Manual
Name Source Status
RemoRep_20140311_143232 /Pool-1/folder01/ Ready
Remorep_20140312_163100 /Pool-1/folder02/ Ready
CLI: Successful
Return: 0x000

Note: Information about backup destination is not displayed in the one-line synopsis mode.
To view detailed destination info, specify task_name in the command.

C REATE AND MODIFY REMOTE REPLICATION TASK

Use the following commands to create a remote replication task and modify its options. The
name of the task will be generated automatically.

replicate create source_folder <-T {nas|rsync}> [-e on|off] <-a target_IP> [-P port]
<-u username> <-p password> <-D destination>
[-c on|off] [-n on|off] [-r on|off] [-s on|off]
[-d {daily| mon| tue| wed| thu| fri| sat| sun}][-t hhmm]

replicate options task_name [-f source_folder][-e on|off] [-a target_IP][-P port]


[-u username][-p password][-D destination]
[-c on|off] [-n on|off] [-r on|off] [-s on|off]

PARAMETER INFO
source_folder: Full path of the source folder
-T: Server type (nas: EonNAS server; rsync: 3rd party rsync server)
-e (off by default): Encrypted transmission (128-bit SSH)
-a: Address of target server
-P (873 by default; only effective if -T is set to rsync and -e to off): Listen port of target server
-u: Name of user with rsync privilege on remote server
-p: User password
-D: Destination (shared folder on another EonNAS; shared folder on a RSYNC server
without encrypted transmission; Full directory path on a RSYNC server with encrypted
transmission)
-c (off by default): Compression
-n (off by default): Stopping network file services during replication
-r (off by default): Removing existing contents from remote destination
-s (off by default): Efficiently handling sparse files

For example:

=>> replicate create /Pool-1/aaa/1 -T nas -a 192.168.100.1 -u admin -p passwd


-D EonBackup
Remote replication task RemoRep_20140321_163032 has been configured.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 110


EonNAS Command Line Interface
User Manual
=>> replicate options RemoRep_20140321_163032 -e on -s on
Remote replication task RemoRep_20140321_163032 has been configured.
CLI: Successful
Return: 0x0000

D ELETE REMOTE REPLICATION TASK

Use the following command to delete a pool mirror task.

replicate delete task_name [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> replicate delete RemoRep_20140321_163032


Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011
=>> replicate delete RemoRep_20140321_163032 -f
CLI: successful
Return: 0x0000

L AUNCH OR STOP REMOTE REPLICATION TASK

Use the following command to launch or stop a remote replication task. To launch a task, its
status should be "Ready"; to stop a task, its status should be "Replicating"

replicate start task_name


replicate stop task_name

For example:

=>> replicate start RemoRep_20140321_163032


CLI: successful
Return: 0x0000
=>> replicate stop RemoRep_20140321_163032
CLI: successful
Return: 0x0000

R ESTORE DATA FROM DESTINATION

Use the following command to restore data from the replication destination.

replicate restore task_name

For example:

=>> replicate restore RemoRep_20140321_163032

© 2014 Infortrend Technology Inc. All Rights Reserved. 111


EonNAS Command Line Interface
User Manual
CLI: successful
Return: 0x0000

C ONFIGURE THE TIMEOUT MECHANISM FOR REPLICATION TASKS

Use the following command to configure the timeout mechanism for all remote replication
tasks.

replicate timeout [-s {on|off}] [-t time][-r retry][-i interval] [-f]

PARAMETER INFO
-s (on by default): Mechanism status
-t (60 seconds by default; any value from 30 to 1800 is valid): Timeout interval
-r (3 by default; any value between 1 and 10 is valid): Number of retries
-I (30 seconds by default; any value between 10 and 300 is valid): Retry interval
-f: forceful implementation without confirmation (when -s off is specified)

For example:

> replicate timeout


The timeout mechanism of remote replication has been disabled.
CLI: Successful
Return: 0x0000
> replicate timeout –s on
The timeout mechanism has been configured.
CLI: Successful
Return: 0x0000
> replicate timeout –t 60 –r 3 –i 30
The timeout mechanism has been configured.
CLI: Successful
Return: 0x0000

NAME extbackup
SYNOPSIS extbackup subcommand parameters
DESCRIPTION
Use the commands in this section to manage external backup tasks and back up data to an
external drive.

V IEW EXTERNAL BACKUP TASK STATUS

Use the following command to view the status of an external backup task.

extbackup status [task_name]

© 2014 Infortrend Technology Inc. All Rights Reserved. 112


EonNAS Command Line Interface
User Manual
For example:

=>> extbackup status exttask001


Name: ExtBackup_20140421_130010
Source Folder: /Pool-1/folder001
Destination:
/mnt/SONY_IC_RECORDER_400_1/EonBackup/Pool-1_folder001/20140421_131144
Start Time: 2014-04-21 13:13:57
End Time: 2014-04-21 13:13:58
Status: Complete
CLI: Successful
Return: 0x0000

If task_name is not specified, each external backup task will be displayed in a one-line
synopsis. For example:

=>> extbackup status


Name Source Status
ExtBackup_20140421_130010 /Pool-1/folder001 Complete
ExtBackup_20140422_101114 /Pool-1/folder002 Ready
ExtBackup_20140423_120000 /Pool-1/folder003 Invalid
CLI: Successful
Return: 0x0000

C REATE EXTERNAL BACKUP TASK

Use the following command to create an external backup task. The task name will be
generated automatically.

extbackup create <-S folder_path> <-c {ctrla|ctrlb} -T target_device_ID>


[-d {daily| mon| tue| wed| thu| fri| sat| sun}][-t hhmm]

PARAMETER INFO
-S: Full path of the source folder
-T: ID of the target device
-d (daily by default): Scheduled day of the week
-t (0000 by default): Scheduled time in the hhmm format (00≦hh≦23, 00≦mm≦59)

For example:

=>> extbackup create -S /Pool-1/Folder001 -c ctrla -T c0t0d0p0


The external backup task ExtBackup_20140421_130010 has been created.
CLI: Successful
Return: 0x0000

D ELETE EXTERNAL BACKUP TASK

Use the following command to delete an external backup task.

© 2014 Infortrend Technology Inc. All Rights Reserved. 113


EonNAS Command Line Interface
User Manual
extbackup delete <task_name> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> extbackup delete ExtBackup_20140421_130010


Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011
=>> extbackup delete ExtBackup_20140421_130010 -f
The backup task has been deleted.
CLI: Successful
Return: 0x0000

L AUNCH EXTERNAL BACKUP TASK

Use the following command to launch an external backup task.

extbackup start <task_name>

For example:

=>> extbackup start ExtBackup_20140421_130010


The backup process has started.
CLI: Successful
Return: 0x0000

S TOP ONGOING EXTERNAL BACKUP TASK

Use the following command to abort an ongoing external backup task.

extbackup stop <task_name> [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> extbackup stop ExtBackup_20140421_130010


Are you sure you want to stop the task? (y/n) n
CLI: User aborted
Return: 0x0011
=>> extbackup stop ExtBackup_20140421_130010 -f
The backup process has stopped.
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 114


EonNAS Command Line Interface
User Manual
NAME evault
SYNOPSIS evault subcommand parameters
DESCRIPTION
Use the commands in this section to manage Enterprise Vault Snapshot tasks.

V IEW E NTERPRISE VAULT S NAPSHOT TASKS

Use the following command to view detailed information about an Enterprise Vault
Snapshot task.

evault status [task_name]

For example:
=>> evault status EVS_20140311_143232
Name: EVS_20140311_143232
Source: /Pool-1/Vol_001
Target IP: 172.27.12.24
Destination: /Pool-A/vol_destination
Security: None
Status: Ready
CLI: Successful
Return: 0x0000

If task_name is not specified, all snapshot tasks will be displayed. For example:

=>> evault status


Name Source Status
EVS_20140311_143232 /Pool-1/Vol_001 Ready
EVS_20140324_120000 /Pool-2/Vol_abc Ready
CLI: Successful
Return: 0x0000

C REATE AND MANAGE SCHEDULED E NTERPRISE VAULT S NAPSHOT TASK

Use the following commands to create a scheduled Enterprise Vault Snapshot task and
modify its options. The name of the task will be generated automatically.

evault create <source_volume_path> <-a address> <-u username> <-p password>


<-D destination_volume_path > [-e {on|off}] [-c {on|off}] [-s {on|off}]
[-d {daily| mon| tue| wed| thu| fri| sat| sun}][-t hhmm] [-f]

evault options taskname [-v source_volume_path] [-a address]


[-u username] [-p password] [-D destination_volume_path]
[-e {on|off}] [-c {on|off} ] [-s {on|off} ]

PARAMETER INFO

© 2014 Infortrend Technology Inc. All Rights Reserved. 115


EonNAS Command Line Interface
User Manual
source_volume_path: Full path of the source volume
-a: Address of target server
-u: Username
-p: User password
-D: Destination volume
-e (off by default): Enabling encryption
-c (off by default): Enabling compression
-s (off by default): Stopping network file services during replication
-d (daily by default): Scheduled day of the week
-t (0000 by default): Scheduled time in the hhmm format (00≦hh≦23, 00≦mm≦59)
-f: Forceful implementation without confirmation

For example:

=>> evault create /Pool-1/vol_001 -a 172.27.12.24 -u admin -p passwd -D


/Pool-1/Vol_backup
Enterprise vault snapshot task EVS_20140311_143232 has been configured.
CLI: Successful
Return: 0x0000
=>> evault options EVS_20140311_143232 -e on -c on -s on
Enterprise vault snapshot task EVS_20140311_143232 has been configured.
CLI: Successful
Return: 0x0000

L AUNCH E NTERPRISE VAULT S NAPSHOT TASK

Use the following command to launch an Enterprise Vault Snapshot task.

evault replicate task_name

For example:

=>> evault replicate EVS_20140311_143232


Enterprise vault snapshot task EVS_20140311_143232 has been launched.
CLI: Successful
Return: 0x0000

R ESTORE DATA FROM DESTINATION

Use the following command to restore data from the destination.

evault restore task_name

For example:

=>> evault restore EVS_20140311_143232


The restoration of enterprise vault snapshot EVS_20140311_143232 has been

© 2014 Infortrend Technology Inc. All Rights Reserved. 116


EonNAS Command Line Interface
User Manual
launched.
CLI: Successful
Return: 0x0000

D ELETE ENTERPRISE VAULT SNAPSHOT TASK

Use the following command to delete an Enterprise Vault Snapshot task.

evault delete task_name [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> evault delete EVS_20140311_143232


Are you sure you want to delete this item? (y/n) n
CLI: User aborted
Return: 0x0011
=>> evault delete EVS_20140311_143232 -f
CLI: Successful
Return: 0x0000

NAME schedule
SYNOPSIS schdule subcommand parameters
DESCRIPTION
Use the commands in this section to manage backup schedules.

V IEW BACKUP SCHEDULES

Use the following command to view detailed information about a backup schedule.

schedule status [schedule_name]

For example:

=>> schedule status SS_Schedule_20140311_143253


Name: SS_Schedule_20140311_143253
Directory: Pool-1/Folder_01
Type: Snapshot
Status: Enabled
Created on: 2014-03-11 14:34:22
Description:
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 117


EonNAS Command Line Interface
User Manual
If schedule_name is not specified, all backup schedules will be displayed. For example:

=>> schedule status


Name Directory Type Status
RR_Schedule_20140311_143210 RemoRep_20140311_143232 Remote Replication Enabled
SS_Schedule_20140311_143253 Pool-1/Folder_01 Snapshot Enabled
CLI: Successful
Return: 0x0000

C REATE BACKUP SCHEDULE

Use the following command to create a backup schedule.

schedule create schedule_name <-c {ss|rr|pm|ev}> <-s source_task>


[-t {daily|weekly|monthly}]
[-d day [day…]] [-m month [month…] ] [-T start_time] [-mo modifier]
[-sd start_date] [-ed end_date]
[-r {on -p period {-et end_time |-du duration} | off}]

PARAMETER INFO
-c: Backup type (ss: snapshot; rr: remote replication; pm: pool mirror; ev: Enterprise Vault
Snapshot)
-s: Source task ("task name" for rr, pm, and ev; full path of source folder for ss)
-t: Schedule type (daily, weekly, or monthly)
-d (ineffective for -t daily): Scheduled day (mon, tue, wed, thu, fri, sat, sun, or any
combination of those values separated with space for -t weekly, and must be followed by
a -mo modifier) or date (a number between 1-31 for -t monthly, and must be followed by
a -m modifier)
-m: Scheduled Month (jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec, or any
combination of those values separated with space for -t monthly)
-T (0000 by default; could be ignored for -t daily and -t weekly): Scheduled time in the
hhmm format (00≦hh≦23, 00≦mm≦59)
-mo: Modifier (first, second, third, fourth and fifth) required for the combination of "-t
monthly" and "-d day of the week"
-sd (optional; the current date by default): Starting date of the task in the yyyymmdd format
-ed (optional; no ending date by default): Ending date in the yyyymmdd format
-r: Repeat
-p: Repeating interval such as 10m, 20m, 30m, 1h, 2h, and 3h
-et: Ending time (in the hhmm format)
-du: Duration (in the hhmm format) counting from the starting time

C HANGE BACKUP SCHEDULE

© 2014 Infortrend Technology Inc. All Rights Reserved. 118


EonNAS Command Line Interface
User Manual

Use the following command to change backup schedule.

schedule options schedule_name [-s on|off] [-n new_schedule_name]

[-t {daily|weekly|monthly}]

[-d day [day…]] [-m month [month…] ] [-T start_time] [-mo modifier]

[-sd start_date] [-ed end_date]

[-r {on -p period {-et end_time |-du duration} | off}]

PARAMETER INFO
-s: Switching the state to on or off
-n: Renaming schedule
Note: Remaining parameters are the same as schedule create described in the previous
section.

D ELETE BACKUP SCHEDULE

Use the following command to delete a backup schedule.

schedule delete schedule_name [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> schedule delete RR_Schedule_20140311_143210


Are you sure you want to delete this schedule (y/n)? n
CLI: User aborted
Return: 0x0011
=>> schedule delete RR_Schedule_20140311_143210 -f
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 119


EonNAS Command Line Interface
User Manual

Maintain System
NAME system
SYNOPSIS system subcommand parameters
DESCRIPTION
Use the commands in this section to maintain the system.

U PDATE SYSTEM SOFTWARE

Use the following command to update the system software by installing a patch file.

system update file_path [-f] [-a {on|off}]

PARAMETER INFO
-f: Forceful implementation without confirmation
-a (on by default): Activating controllers after the system software is updated

For example:

> system update /Pool-1/Folder-a/package.bin


The update process will result in primary controller role switches and cause
service interruptions. It is recommended to suspend all data services! Are
you sure you want to update the system? (y/n) n
CLI: User aborted
Return: 0x0011

B ACKUP SYSTEM SETTINGS

Use the following commands to export (backup) or import (restore) system settings saved in
a .bin file.

system backup folder_path


system restore /fullpath/filename [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> system backup /Pool-1/folder-1


CLI: Successful
Return: 0x0000
> system restore /Pool-1/FolderAAA/SysBackup2014-02-12-164144.bin
The system setting will be restored. Are you sure you want to continue? (y/n)n
CLI: User aborted
Return: 0x0011
> system restore /Pool-1/FolderAAA/SysBackup2014-02-12-164144.bin -f

© 2014 Infortrend Technology Inc. All Rights Reserved. 120


EonNAS Command Line Interface
User Manual
CLI: Successful
Return: 0x0000

R EBOOT OR SHUT DOWN SYSTEM

Use the following commands to reboot or shut down the system.

system reboot [ -f ]
system shutdown [ -f ]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> system reboot


The NAS system will reboot. Are you sure you want to continue? (y/n) n
CLI: User aborted
Return: 0x0011
> system shutdown
Your NAS system will shutdown. Are you sure you want to continue? (y/n) n
CLI: User aborted
Return: 0x0011

V IEW DIAGNOSTIC REPORT

Use the following command to view a diagnostic report on the system.

system report folder_path

> system report /Pool-1/folder001


CLI: Successful
Return: 0x0000

NAME powersche
SYNOPSIS powersche subcommand parameters
DESCRIPTION
Use the commands in this section to configure the power schedule for the system.

V IEW POWER SCHEDULE

Use the following command to list all existing tasks of the power schedule.

powersche list

© 2014 Infortrend Technology Inc. All Rights Reserved. 121


EonNAS Command Line Interface
User Manual
For example:

> powersche list


ID Action Date Time Postpone Last Exec Next Exec
1 Power on Everyday 00:00 2014-02-16 2014-02-17
2 Power off Tuesday 01:15 V -- 2014-02-18
CLI: Successful
Return: 0x0000

C REATE AND MODIFY SCHEDULED POWER TASK

Use the following commands to create a new scheduled power task and modify its options.

powersche create <-a {on | off | reboot}> [-p {on|off}]


<-d { everyday| mon| tue| wed| thu| fri| sat| sun| weekday| weekend} >
<-t hhmm>

powersche options -i id [-a {on | off | reboot}] [-p {on|off}]


[-d { everyday| mon| tue| wed| thu| fri| sat| sun| weekday| weekend} ]
[-t hhmm]

PARAMETER INFO
-a: Action (on: Power on; off: Power off; reboot: Reboot)
-p (off by default): Postponing scheduled powering down or rebooting task if a backup or
rebuilding task is in progress
-d: Scheduled day of the week
-t (0000 by default): Scheduled time in the hhmm format (00≦hh≦23, 00≦mm≦59)
-i: Schedule ID

In the following examples, since there are only 2 scheduled power tasks (ID 1 and ID 2) in
the system, it is impossible to modify the options of a third task (ID 3) that doesn’t exist:

> powersche create -a on -d weekday -t 0830


CLI: Successful
Return: 0x0000
> powersche list
ID Action Date Time Postpone Last Exec Next Exec
1 Power on Everyday 00:00 -- 2014-02-17
2 Power off Tuesday 01:15 V -- 2014-02-18
CLI: Successful
Return: 0x0000
> powersche options -i 3
CLI: Invalid parameter (Parameter for error, out-of-rang or mistype)
Return: 0x0005
> powersche option -i 1 -a off
CLI: Successful
Return: 0x0000

© 2014 Infortrend Technology Inc. All Rights Reserved. 122


EonNAS Command Line Interface
User Manual
> powersche list
ID Action Date Time Postpone Last Exec Next Exec
1 Power off Everyday 00:00 -- 2014-02-17
2 Power off Tuesday 01:15 V -- 2014-02-18
CLI: Successful
Return: 0x0000

D ELETE SCHEDULED POWER TASK

Use the following command to delete a scheduled power task.

powersche delete -i id

-i: Schedule ID

In the following examples, since there are only 2 scheduled power tasks (ID 1 and ID 2) in
the system, it is impossible to delete a third task (ID 3) that doesn’t exist:

> powersche list


ID Action Date Time Postpone Last Exec Next Exec
1 Power on Everyday 00:00 -- 2014-02-17
2 Power off Tuesday 01:15 V -- 2014-02-18
CLI: Successful
Return: 0x0000
> powersche delete -i 3
CLI: Invalid parameter (Parameter for error, out-of-rang or mistype)
Return: 0x0005
> powersche delete -i 1
CLI: Successful
Return: 0x0000
> powersche list
ID Action Date Time Postpone Last Exec Next Exec
2 Power off Tuesday 01:15 V -- 2014-02-18
CLI: Successful
Return: 0x0000

NAME ha
SYNOPSIS ha subcommand parameters
DESCRIPTION
Use the commands in this section to manage the High Availability feature provided by
EonNAS, which utilizes dual controllers to minimize maintenance down time, thus ensuring
uninterrupted operation.

Note: The High Availability feature is not supported by G-models.

© 2014 Infortrend Technology Inc. All Rights Reserved. 123


EonNAS Command Line Interface
User Manual

V IEW H IGH AVAILABILITY STATUS

Use the following command to view controllers’ version and status.

ha status

The status could be any of the following:

 Uninitialized (SW Incompatible): Software version is different between the two


controllers. This often occurs when a repaired or replaced controller is installed.
 Uninitialized: Software is of the same version or synchronized between the two
controllers, but discrepancies in settings still occur between a controller and its system
drive (where the system software is installed).
 Active (Primary): The primary controller is working well.
 Active: The secondary controller is working well.
 Standby: The controller is not activated yet, nor is it in service now. Refer to the next
section for more information about activating a controller.

For example:

> ha status
Controller A (3.3.1) Uninitialized (SW Incompatible)
Controller B (3.3.2) Active (Primary)
CLI: successful
Return: 0x0000

ACTIVATE OR D EACTIVATE CONTROLLER

Use the following command to activate or deactivate a controller by switching it between the
Active and Standby mode.

ha activate { ctrla | ctrlb }


ha deactivate { ctrla | ctrlb }

For example:

> ha activate ctrla


CLI: Successful
Return: 0x0000
> ha deactivate ctrla
CLI: Successful
Return: 0x0000

S HUT DOWN CONTROLLER

Use the following command to shut down a controller.

Note: After a controller is shut down, you will have to pull it out and insert it back to activate

© 2014 Infortrend Technology Inc. All Rights Reserved. 124


EonNAS Command Line Interface
User Manual
it again.

ha shutdown { ctrla | ctrlb } [ -f ]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

> ha shutdown ctrla


Controller A will shutdown. Are you sure you want to continue? (y/n)n
CLI: User aborted
Return: 0x0011
> ha shutdown ctrla -f
CLI: Successful
Return: 0x0000

S YNC CONTROLLER SYSTEM

Use the following command to sync the system software between the two controllers

Note: This command can only be used on a controller with the Uninitialized (SW
Incompatible) status. Refer to the "View High Availability status" section for more
information about controller status.

ha sync { ctrla | ctrlb }

In the following examples, you are not allowed to use the command on Controller B which
has the "Active (Primary)" status:

> ha status
Controller A (3.3.1) Uninitialized (SW Incompatible)
Controller B (3.3.2) Active (Primary)
CLI: successful
Return: 0x0000
> ha sync ctrla
CLI: Successful
Return: 0x0000
> ha sync ctrlb
CLI: Invalid configuration (Configuration incorrect or operation not allow)
Return: 0x0014

I NITIALIZE CONTROLLER

Use the following command to initialize a controller which hasn’t been initialized yet.

ha initialize { ctrla | ctrlb } [-f]

© 2014 Infortrend Technology Inc. All Rights Reserved. 125


EonNAS Command Line Interface
User Manual
PARAMETER INFO
-f: Forceful implementation without confirmation

Note: This command can only be used on a controller with the Uninitialized status. Refer to
the "View High Availability status" section for more information about controller status.

In the following examples, you are not allowed to use the command on Controller B which
has the "Active (Primary)" status:

> ha status
Controller A (3.3.2) Uninitialized
Controller B (3.3.2) Active (Primary)
CLI: successful
Return: 0x0000
> ha initialize ctrla
System will be initialized on this controller. Are you sure you want to
continue? (y/n) y
CLI: Successful
Return: 0x0000
> ha initialize ctrlb
CLI: Invalid configuration (Configuration incorrect or operation not allow)
Return: 0x0014

NAME log
SYNOPSIS log subcommand parameters
DESCRIPTION
Use the commands in this section to manage log records.

E XPORT LOGS

Use the following command to export system logs.

log export <-f log_file>

PARAMETER INFO
-f: Full path of exported log file

For example:

=>> log export -f /Pool-1/Folder001/Log.txt


CLI: Successful
Return: 0x0000

C LEAR LOGS

© 2014 Infortrend Technology Inc. All Rights Reserved. 126


EonNAS Command Line Interface
User Manual

Use the following command to clear system logs.

log clear [-f]

PARAMETER INFO
-f: Forceful implementation without confirmation

For example:

=>> log clear


Are you sure you want to clear the log records? (y/n) n
CLI: User aborted
Return: 0x0011
=>> log clear -f
CLI: Successful
Return: 0x0000

S ET LOG RETENTION RULE

Use the following command to set the maximum number and time period of keeping log
records on your system.

log retention {-n number|-d days}

PARAMETER INFO
-n (100000 by default; between 1000 and 100000): Maximum number of log records
-d (90 by default): Maximum retention period

For example:

=>> log retention -n 10000


The operation has been completed.
CLI: Successful
Return: 0x0000

NAME init
SYNOPSIS init
DESCRIPTION
If your EonNAS doesn’t start up properly and its network access (via SSH/Telnet or
web-based GUI) becomes unavailable, you might need to connect a monitor and keyboard
to it, and then use init to perform system initialization before the system can restart
successfully.

Below is an example of steps used for system initialization. For each step, you can change
its settings by entering the step ID and following onscreen instructions.

© 2014 Infortrend Technology Inc. All Rights Reserved. 127


EonNAS Command Line Interface
User Manual
Step 0: Check system environment.

Step 1: Configure hostname and the account password of admin.

Step 2: Configure the network interface to get the system online.

Step 3: Run the initialization process.

© 2014 Infortrend Technology Inc. All Rights Reserved. 128


EonNAS Command Line Interface
User Manual

© 2014 Infortrend Technology Inc. All Rights Reserved. 129