American Megatrends MAN-STOR-ITX27

StorTrends®
iTX Software
CLI (Command Line Interface)
(Version 2.7)
User’s Guide
MAN-STOR-ITX27-CLI
06/07/2010
© Copyright 1985-2010 American Megatrends, Inc.
All rights reserved.
American Megatrends, Inc.
5555 Oakbrook Parkway
Norcross, GA 30093
This publication contains proprietary information which is protected by copyright. No part of this publication can be
reproduced, transcribed, stored in a retrieval system, translated into any language or computer language, or
transmitted in any form whatsoever without the prior written consent of the publisher, American Megatrends, Inc.
American Megatrends, Inc. acknowledges the following trademarks:
Intel and Pentium are registered trademarks of the Intel Corporation.
AMD, Athlon, and Athlon XP are trademarks of the Advanced Micro Devices Corporation.
Sun and NFS are trademarks of the Sun Microsystems Corporation.
Microsoft, Windows, Internet Explorer and MS-DOS are registered trademarks of the Microsoft Corporation and
Active Directory is a trademark of the Microsoft Corporation.
Macromedia Flash is a trademark of the Macromedia Corporation.
IBM, AT, VGA, PS/2, and OS/2 are registered trademarks and XT and CGA are trademarks of the International
Business Machines Corporation.
Digital, DEC, and OpenVMS are trademarks of Digital Equipment Corporation.
Compaq is a registered trademark of the Compaq Corporation.
Hewlett-Packard, HP, and HP-UX are registered trademarks of Hewlett-Packard Company.
Novell, NetWare, IPX, NCP, and NetWare Core Protocol are registered trademarks of the Novell Corporation.
UNIX is a registered trademark in the United States and other countries, licensed exclusively through X/Open
Company Ltd.
Linux is a registered trademark of Linus Torvalds.
Red Hat is a registered trademark of the Red Hat Corporation.
Apple and AppleTalk are registered trademarks of Apple Computer Corporation.
Yellow Pages is a registered trademark in the United Kingdom of British Telecom.
Ethernet is a registered trademark of the Xerox Corporation.
802 is a registered trademark of the Institute of Electrical and Electronic Engineers, Inc. (IEEE).
Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks
and names or their products. American Megatrends, Inc. disclaims any proprietary interest in trademarks and trade
names other than its own.
Revision History
02/16/06
02/16/06
02/16/06
02/23/06
06/20/06
06/21/06
06/23/06
07/14/06
07/27/06
08/17/06
04/26/07
04/26/07
06/28/07
01/16/09
12/11/09
01/25/10
01/25/10
ii
Created iTX 2.1 CLI document.
iSCSI Tape command added.
UPS driver config command added.
Synchronous replication commands added.
Volume and Snapshot commands updated.
Synchronous replication, iSCSI configuration updated.
Document is revised and examples are added.
General Server configuration section updated.
Updated for version 2.5.1011 and above.
Added Error Codes section.
Changed the volume chunk size.
Added the SRM commands.
Removed Tape commands.
Updated document and added journal and cdp commands.
Update the network command usage and CLI error text
Updated the OS Agnostic HA related commands and CLI error text
Updated Network Alias commands
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
01/25/10
03/30/10
04/11/10
06/07/10
06/07/10
06/07/10
06/07/10
06/07/10
06/07/10
06/07/10
Updated the iSCSI commands and corrected wrong format updation
Corrected the Create Volume usage and Get Eventlog Usage.
Update the create replication commands
Corrected the output of ‘cli main’.
Removed the term apple
Corrected set -t nfs command.
Corrected set raid commands.
Added available cache options for create raid.
Since alarm and cache is supported for set raid; the ‘not supported’ was removed.
Osinfo commands removed.
Preface
iii
Table of Contents
Revision History ......................................................................................................................................... ii
Table of Contents ..................................................................................................................................... iv
Table of Contents ..................................................................................................................................... iv
Limited Warranty ....................................................................................................................................... v
Limitations of Liability ................................................................................................................................ v
Technical Support ...................................................................................................................................... v
Web Site ................................................................................................................................................ v
Disclaimer ................................................................................................................................................. vi
Chapter 1
Overview of CLI ..................................................................................................................... 1
Preface ...................................................................................................................................................... 1
Overview of CLI ......................................................................................................................................... 1
Accessing CLI ............................................................................................................................................ 1
Initial Setup ................................................................................................................................................ 2
Network Configuration ........................................................................................................................... 2
Volume Configuration ................................................................................................................................ 3
1. RAID Disk Creation ............................................................................................................................ 3
2. Container and Volume Configuration................................................................................................. 4
3. Enabling Share or Target ................................................................................................................... 5
Chapter 2
Command Set ........................................................................................................................ 7
Command Set ............................................................................................................................................ 7
Alert Configuration ..................................................................................................................................... 9
Date/Time Configuration.......................................................................................................................... 10
Domain Configuration .............................................................................................................................. 10
Event log Commands .............................................................................................................................. 11
Firewall Configuration .............................................................................................................................. 12
General Server Configuration .................................................................................................................. 13
Health Configuration ................................................................................................................................ 13
iSCSI Configuration ................................................................................................................................. 14
License configuration............................................................................................................................... 16
Network Controller Configuration ............................................................................................................ 17
NAS Quota Configuration ........................................................................................................................ 18
NAS User / Group Configuration ............................................................................................................. 19
Protocol Configuration ............................................................................................................................. 20
RAID & Disk Management Commands ................................................................................................... 21
Share, Directory & ACL Configuration ..................................................................................................... 24
System Control Configuration ................................................................................................................. 26
Volume and Snapshot Commands .......................................................................................................... 26
UPS Configuration ................................................................................................................................... 29
Synchronous replication .......................................................................................................................... 30
Asynchronous Replication ....................................................................................................................... 33
Journal Volume Management ................................................................................................................. 39
Continuous Data Protection..................................................................................................................... 41
Recovery Wizard ..................................................................................................................................... 41
Storage Resource Management ............................................................................................................. 42
Local and Replicated Snapshot validation .............................................................................................. 43
Appendix A
iv
Error Codes ...................................................................................................................... 45
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Limited Warranty
The buyer agrees that if this product proves to be defective, American Megatrends is only obligated to repair
or replace this product at American Megatrends’ discretion according to the terms and conditions of the
warranty registration software that accompanies this product. American Megatrends shall not be liable in
tort or contract for any loss or damage, direct, incidental or consequential resulting from the use of this
product. Please see the Warranty Registration Software shipped with this product for full warranty details.
Limitations of Liability
American Megatrends, Inc. shall in no event be held liable for any loss, expenses, or damages of any kind
whatsoever, whether direct, indirect, incidental, or consequential (whether arising from the design or use of
this product or the support materials provided with the product). No action or proceeding against American
Megatrends may be commenced more than two years after the delivery of product to Licensee of Licensed
Software.
Licensee agrees to defend and indemnify American Megatrends from any and all claims, suits, and liabilities
(including attorney’s fees) arising out of or resulting from any actual or alleged act or omission on the part of
Licensee, its authorized third parties, employees, or agents, in connection with the distribution of Licensed
Software to end-users, including, without limitation, claims, suits, and liability for bodily or other injuries to
end-users resulting from use of Licensee’s product not caused solely by faults in Licensed Software as
provided by American Megatrends to Licensee.
Technical Support
American Megatrends provides technical support for American Megatrends products purchased directly
from American Megatrends or from an American Megatrends-authorized reseller only.
If…
You purchased this product from American Megatrends
or from a certified American Megatrends reseller,
This American Megatrends product was installed as part
of a system manufactured by a company other than
American Megatrends or you purchased an American
Megatrends product from an unauthorized reseller,
Then…
call American Megatrends’ technical support at 770246-8645. Please be prepared to specify the serial
number or CD Key of the product (if applicable).
call the technical support department of the computer
manufacturer or the unauthorized reseller. American
Megatrends does not provide direct technical support in
this case.
If the American Megatrends StorTrends® iTX Software fails to operate as described or you are in doubt
about a configuration option, please call technical support at 770-246-8645.
Web Site
We invite you to access the American Megatrends’ World Wide Web site at:
http://www.ami.com/
Preface
v
Disclaimer
This manual describes the operation of the American Megatrends StorTrends® iTX Software. Although
efforts have been made to assure the accuracy of the information contained here, American Megatrends
expressly disclaims liability for any error in this information, and for damages, whether direct, indirect,
special, exemplary, consequential or otherwise, that may result from such error, including but not limited to
the loss of profits resulting from the use or misuse of the manual or information contained therein (even if
American Megatrends has been advised of the possibility of such damages). Any questions or comments
regarding this document or its contents should be addressed to American Megatrends at the address shown
on the inside of the front cover.
American Megatrends provides this publication “as is” without warranty of any kind, either expressed or
implied, including, but not limited to, the implied warranties of merchantability or fitness for a specific
purpose.
Some states do not allow disclaimer of express or implied warranties or the limitation or exclusion of liability
for indirect, special, exemplary, incidental or consequential damages in certain transactions; therefore, this
statement may not apply to you. Also, you may have other rights which vary from jurisdiction to jurisdiction.
This publication could include technical inaccuracies or typographical errors. Changes are periodically made
to the information herein; these changes will be incorporated in new editions of the publication. American
Megatrends may make improvements and/or revisions in the product(s) and/or the program(s) described in
this publication at any time.
Requests for technical information about American Megatrends products should be made to your American
Megatrends authorized reseller or marketing representative.
vi
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Chapter 1
Overview of CLI
Preface
Our feature rich StorTrends® iTX comes with a built-in command line interface (CLI) that provides
extensive options to monitor and control “managed objects”. Wherever applicable, CLI follows industry
standards and uses extensible ‘tags’ for new features and objects. The command line utility can be accessed
through an in-band special console connected to the StorTrends® iTX system or out-of-band via a SSH or
telnet client. It can also be used with scripting languages to automate a set of operations.
Overview of CLI
Our CLI supports commands in excess of 140 verbs and supports XML output format. The design is very
similar to DMTF SMASH specifications and is being extended to fully comply with SMASH. Every managed
element or object has a SMASH compliant <Target> addressing conforming to the server management
instance addressing specification. The commands implemented are essentially “stateless” in nature. SMASH
compliant <Verbs> is used to select the management actions, which are complemented by extensive <Option>
attributes to control the behavior of the command. <Property> attributes can control the behavior of the
output produced by the <Verb> along with various other mapping actions to the CIM schema.
The output produced can be controlled depending on the need, For example, in automation scripting. Output
can also be made to be in the W3C standard compliant, self-descriptive XML format. The output format
includes new tags pertinent to the object management. Inherent support for multi-lingual documents and
Unicode data, along with content separation from presentation, aids in development of management
applications that have their own data representation format. CLIs used for monitoring of performance
parameters are dished out in XML tags that assist in graphing and charting, and can be right away imported
by spreadsheet applications.
Accessing CLI
The CLI can be accessed either through an in-band console connected directly to the ITX box or through the
out-of-band / remote CLP agents. It can also be accessed through a remote terminal emulation program using
SSH or Telnet. Once connected, the administrator has to login to the system to perform the operations. In a
typical console session, the user will be presented with a login screen such as:
login: cli <Enter>
password: ******* <Enter>
“cli” is the special user that has been provided with CLI access. The password is factory defaulted to
“password”. Once logged in, the system will present the user with a CLI shell as follows:
CLI>
The user can then enter the supported commands in any order. The supported commands are listed in the
next section. To close the session, the user can type the command ‘quit’. This will end the session.
Chapter One: Overview of CLI
1
Initial Setup
Network Configuration
Once the StorTrends® iTX is installed in a new system, please ensure that the initial network configuration is
proper. The system factory defaults to DHCP setup. The configured network settings can be verified by the
following CLI commands:
CLI> get
–-type or –t port
-–name or –n NIC-1
--info or -i
network <Enter>
Example: get –t port –n nic-1 –i network
This will display the NIC-1 network settings.
To configure static IP to this port:
CLI> set
–-type or –t port
–-name or –n NIC-1
–-ip or –i 10.0.0.100
–-mask or –m 255.255.255.0
–-gate or –g 10.0.0.7 (optional)
--pridns or –p 10.0.0.2 (optional)
--secdns or –s 0.0.0.0 (optional)
--dnssuff or –f ami.com (optional)
network <Enter>
Example: set –t port –n nic-1 –i 10.0.0.100 –g 10.0.0.7
-p 10.0.0.2 –s 0.0.0.0 –f ami.com network
Here 10.0.0.100 is the static IP address, 255.255.255.0 is netmask and 10.0.0.7 is the network gateway.
2
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Volume Configuration
Initial volume configuration can be done in three stages.
1. RAID Disk Creation
At the base level is the RAID CONTROLLER.
CLI> list
–-type or –t controller
raid <Enter>
Example: list –t controller raid
This will list the available RAID controllers in the system. By default, Software MD will be shown as a RAID
controller with controller number “0”. If Hardware RAID controllers present, then they will take precedence
over Software MD.
CLI> list
–-type or -t PD
--controllerno or -n 0
raid <Enter>
Example: list –t pd –n 0 raid
This will list the PD’s that are available for configuration in controller number zero. PD’s can be grouped
through a RAID level to form a Logical disk – LD.
CLI>create
–-type or -t LD
–-stripesize or -p 64
–-diskname or -d /dev/sda (use –d 1 or –d 2…15 on a 3U)
–-diskname or –d /dev/sdb
–-diskname or –d /dev/sdc
–-diskname or –d /dev/sdd
--raidlevel or –r 0
--controllerno or –n 0
--cachemode or –m 3
raid <Enter>
Example: create –t ld –p 64 –d 1 –d 2 –r 1 –n 0 –m 2 raid
This will create a RAID 1 Logical Disk – LD with 64K-chunk size and two disks on a 3U.
Example: create –t ld –p 64 –d /dev/sda –d /dev/sdb –d
/dev/sdc –r 5 –n 0 –m 1 raid
This command will crate a RAID 5 Logical disk – LD with 64 k chunk size and three disks on a 1U box.
CLI> list
–-type or –t LD
raid <Enter>
Example: list –t ld raid
This will list the available RAID LD’s present in the system.
Chapter One: Overview of CLI
3
2. Container and Volume Configuration
Next step is the AMI DVM container creation. This can be done by the following commands:
CLI>create
–-type or -t container
–-containername or -c container1
–-chunksize or –k 64
–-ldname or –l /dev/md0
volume <Enter>
Example: create –t container –c accounting –k 64 –l
/dev/sdb volume (for a 3U)
This command creates a container named “accounting” from the LD /dev/sdb.
On a 1U, LDs are created with names of /dev/mdX, with X as 0, 1, and so on. Therefore the above operation
would be accomplished by entering, for example:
Example: create –t container –c marketing –k 64 –l
/dev/md1 volume
The next step is the creation of volumes.
A NAS volume can be created by the following command:
CLI>create
–-type or –t volume
–-containername or -c container1
–-volumename or -v nasvol0
–-volumesize or -z 1000 (in GB)
–-provisiontype or -p 0 (0 is thin-provisioned, 1 is exact)
–-volumetype or -e 0 (type 0 is ROW)
–-voldialect or –f 1 (dialect 1 is NAS, 0 is iSCSI)
--chunksize or –k (8 or 64 for 8KB and 64KB chunk sized volume
respectively.)
volume <Enter>
Example: create –t volume –c container1 –v volume1 –z 1000 –p 0 –
e 0 –f 1 –k 64 volume
This command creates volume “nasvol0” in container “container1” with size of 1000GB, that is thinprovisioned, Redirect-On-Write, and of NAS type with chunk size as 64KB.
Volume size should be in GBs and currently supported volume type is 0 – ROW.
4
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Similarly a SAN volume can be created as follows:
CLI>create
–-type or –t volume
–-containername or -c container1
–-volumename or -v sanvol0
–-volumesize or -z 1000
–-provisiontype or -p 0
–-volumetype or -e 0
–-voldialect or -f 0
--chunksize or –k (8 or 64 for 8KB and 64KB chunk sized volume
respectively.)
volume <Enter>
Example: create –t volume –c container1 –v volume1 –z 1000 –p 0 –
e 0 –f 1 –k 8 volume
This command creates volume “sanvol0” in container “container1” with size of 1000GB, that is thinprovisioned, Redirect-On-Write, and of SAN type with chunk size as 8KB.
3. Enabling Share or Target
To enable NAS share, use the following command syntax. Make sure the corresponding share protocol is
enabled in the system.
First, create the directory in the path before creating a share for the path.
CLI>create --path or -p container1_nasvol0/test
dir<Enter>
Example: create –p cont1_nasvol0/test dir
This command creates the subdirectory of “test” within the volume “nasvol0” in the container “cont1”.
Then create the share using the following syntax.
CLI>add
–-name or -n NASShare
–-path or -p container1_nasvol0/test
–-prototype or -s cifs
–-prototype or -s nfs
share <Enter>
Example: add –n nasshare –p cont1_nasvol0/test –s cifs –s
nfs share
Note:
The path specified should be of format:
“ContainerName_VolumeName/directoryName”.
To create a target, use the following commands.
CLI>add
–-type or -t lun
--volumename or -v sanvol0
–-containername or -c container1
–-targetname or -n sanvol0
iscsi <Enter>
Example: add –t lun –v sanvol0 –c cont1 –n sanvol0 iscsi
Chapter One: Overview of CLI
5
Then, to enable the target, use the syntax below:
CLI>enable
–-type or –t tgt
–-targetname or -n sanvol0
iscsi <Enter>
Example: enable –t tgt –n sanvol0 iscsi
Next step is to activate a port for iSCSI traffic.
CLI>activate
–-type or –t portal
–-ipaddress or -p 10.0.0.100
–-portaltag or -g 1 iscsi
Example: activate –t portal –p 10.0.0.100 –g 2 iscsi
We recommend that you assign different portal tags to the two portals if they are on different subnets.
6
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Chapter 2
Command Set
Command Set
The CLI design being similar to the DMTF SMASH specifications follows the standard to a great extent. The
commands supported can be represented grammatically as follows:
<verb> <option> … <property> <target>
The CLI provides a wide range of command sets. These commands are grouped into modules for better
understanding. Each command is non-interactive and state-less. The <options> are supported using switches.
Our CLI accepts both short and long options for each switch to make it user-friendly. If there is any error in
the parameters entered, the CLI will display the usage of that particular command.
CLI also provides extensive online help. Each command supports a help option using ‘-h’ or
‘--help’ that will display the grammar of the command.
To get the main list of targets or modules present in CLI, the user should type the command “main” at the
CLI prompt.
The following targets will get displayed:
*****************************************************************
TARGET LIST
----------------------------------------------------------------1. ug
2. ups
3. dir
4. srm
5. dump
6. raid
7. ndmp
8. alert
9. iscsi
10. share
11. quota
12. system
13. volume
14. domain
15. health
16. license
17. network
18. journal
19. eventlog
20. protocol
21. firewall
22. datetime
23. timezone
24. serverinfo
25. sysupgrade
26. syncreplica
27. asyncreplica
28. recoverywizard
29. snapvalidation
For more information on the targets please use the following command
show -t/--target <targetname>
Note : Targetnames are case insensitive
Example :
show -t iscsi
*****************************************************************
The show option can also be used to show commands based on <verb>, and to display the list of targets or
verbs available.
Chapter Two: Command Set
7
For example: To find out how the show command works, type:
CLI>show -h <Enter>
This will display the many ways the show command can be used.
(this is redundant)
For example: To display the available targets/verbs, the user has to enter:
CLI>show –d targets <Enter>
CLI>show –d verbs <Enter>
The show option can display the functions available for a target or even the functions available for a verb.
For example: To display the functions available for targets/verbs the user has to enter:
CLI>show –t <targetname> <Enter>
Example: show –t ups
CLI>show –v <verbname> <Enter>
Example: show –v list
Note:
8
In the table below, though the <target> is given in the first column together with <verb>, it should
actually be typed at the end of command, complying with SMASH specification. Again, the target
is not case-sensitive.
StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Alert Configuration
These commands configure the way alerts are generated.
Command
get alert
get alert
delete alert
delete alert
set alert
set alert
Argument
-t/--type snmp
For example:
get –t snmp alert
-t/--type email
For example:
get –t email alert
-t/--type snmp
-v/--value <destination>
-x/--xml alert
For example:
delete -t snmp -v 10.0.3.155 -v 10.0.0.203 -x alert
-t/--type email
-v/--value <emailaddress>
-x/--xml alert
For example:
delete -t email -v sam@yahoo.com -v
yyy@ami.com -x alert
-t/--type snmp
-e/--enable or
-d/--disable
-v/--value <alertmask:communityname:destination>
-x/--xml
For example: set –t snmp –e –v 1:public:10.10.10.5
-x alert
-t/--type email
-e/--enable or
-d/--disable
-v/--value <alertmask:language:emailaddr>
-s/--emailserver (IP address)
-F <Fully Qualified Domain Name>
-x/--xml
For example: set -t email -e -v
1:1:sam@yahoo.com -s 10.0.0.79 -F ami.com -x
alert
Description
Gives the SNMP alert
configuration.
Gives the Email alert
configuration.
Deletes the SNMP specified
destination from the alert
configuration.
Deletes the specified email address
from the alert configuration.
Configures SNMP alerts.
Note:
<alertmask:communityname:destin
ation>
For example:
<1:public:10.0.0.79>
Configures Email alerts.
<alertmask:language:emailaddr>
<1:1:aaaa@ami.com>
Language
0-Unknown
1-English
2-Japanese
3-Korean
4-Chinese
Alert Mask:
1 - Information
2 - Warning
4 - Fatal
Any combination of the three alert
masks up to a maximum of seven
levels.
Chapter Two: Command Set
9
Date/Time Configuration
These commands configure the time zone and date.
Command
set timezone
get timezone
set datetime
get timezone
set datetime
list timezone
get datetime
Argument
-z/--zone <zone name>
-x/--xml
For example: set –z America/New_York timezone
For example: get timezone
-n/--ntp <FQDN of NTP server or ipaddress>
-c/--count
-d/--date <date in MM/DD/YYYY>
-t/--time <time in HH:MM:SS>
-x/--xml
For example: set –d 12/01/2006 –t 12:11:55
datetime
For example: list timezone
For example: get datetime
Description
Sets the time zone of StorTrends®
iTX to given time zone.
Shows the configured time zone.
Configures the NTP server to be
used for time synchronization.
Gets the number of time zones.
Sets the date and time to given
values.
Lists the time zones supported.
Shows the date & time.
Domain Configuration
These commands configure the domain server to be used for authentication.
Command
get domain
set domain
set domain
set domain
Argument
-t/--type {nis/ms}
-x/--xml
For example: get –t nis domain
-t/--type{ nis }
-b/--broadcast {y/n}
-d/--domain <domainname >
-s/--server <server-1>
-s/--server <server-2>
-x/--xml
For example: set -t nis -b n -d NISSERV -s
10.0.0.215 -s 10.0.0.25 -s 10.0.0.5 domain
-t/--type {ms}
-m/--mtype {wg}
-d/--domain< domainname>
-x/--xml
For example: set -t ms -m wg -d MYGROUP
domain
-t/--type {ms}
-m/--mtype {/nt/ads}
-d/--domain< domainname>
-D/--nbname<netbiosname> (optional)
-i/--ip <serverip>
-I/--secip<secondary serverip> (optional)
-o/--orgname <orgName> (optional)
-u/--user <Adminname >
-p/--passwd <Adminpassword>
-x/--xml
For example: set –t ms –m ads –d domain1.com –D
domain1 –I 10.10.220.1 –u Administrator –p
password domain
10 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Displays the domain information of
either NIS or Microsoft (MS)
domains.
Sets the NIS domain to given
domain with broadcast mode OFF
or ON. Servers can be added using
the –s/--server switch.
If broadcast is set to OFF, then no
servers are needed.
Sets the Microsoft domain type to
Workgroup.
Sets the Microsoft domain type to
NT / ADS.
Event log Commands
These commands display or clear the event log.
Command
get eventlog
get eventlog
clear eventlog
Argument
-s/--section {v/s/o/h}
-o/--offset <record-offset>
-n/--recordcount <record-count>
-i/--info
-f/--fatal
-w/--warning or
-a – all eventlog
-x/--xml
For example: get –s vs –o 2 –n 20 –f –w eventlog
-c/--count
-s/--section {v/s/o/h}
-i/--info
-f/--fatal
-w/--warning or
-a/-- all eventlog
-x/--xml
For example: cli get -s vsoh -a -c eventlog
Description
Lists event log content matching
the given criteria.
v-Volume
s-System
o-OS
h-Health
Gets the number of events reported.
Clears the complete event log.
Chapter Two: Command Set
11
Firewall Configuration
These commands configure the network firewall options.
Command
add firewall
add firewall
edit firewall
delete firewall
edit firewall
Argument
-a/--allow or
-b/--block
-i/--ip <ipaddress>
-m/--mask <netmask>
-p/--proto {icmp}
-x/--xml
-a/--allow
-b/--block
-i/--ip <ipaddress>
-m/--mask <netmask>
-s/--sport <start-port>
-e/--eport <end-port>
-p/--proto {tcp/udp}
For example: add –a –i 10.10.1.1 –s 1200 –e 5000 –
p tcp firewall
-a/--allow or
-b/--block
-r/--rule<ruleno>
-i/--ip <IP address>
-m/--mask <net mask>
-p/--proto { icmp}
-x/--xml
For example: edit -a -i 10.0.0.218 -r 1 -m
255.255.255.255 -p icmp -x firewall
-a/--allow or
-b/--block
-r/--num <rule number>(obtained when viewing the
list of firewalls via the list command below)
-x/--xml
For example: delete -b -r 1 -x firewall
-a/--allow or
-b/--block
-r/--rule<ruleno>
-i/--ip <IP address>
-m/--mask <net mask>
-s/--sport <start port>
-e/--eport <end port>
-p/--proto {tcp/udp}
-x/--xml
For example: edit -a -i 10.0.0.218 -r 1 -m
255.255.255.255 -s 2000 -e 3000 -p udp -x firewall
list firewall
get firewall
-c/--count
-x/--xml
For example: get -c -x firewall
12 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Add allowed or blocked firewall
rule with given parameters for the
ICMP protocol.
Add allowed or blocked firewall
rule with given parameters for TCP
and UDP protocols.
Modifies specified allowed or
blocked firewall rule with given
rule number to the given values for
ICMP.
Deletes allowed or blocked firewall
rule with given rule number.
Modifies specified allowed or
blocked firewall rule with given
rule number to the given values for
TCP or UDP.
Lists all the blocked and allowed
firewall rules.
Retrieves the count of allowed or
blocked firewall rules.
General Server Configuration
These commands retrieve the general server information, such as build version, build date and so on. It also
allows configuration of a new server name.
Command
get serverinfo
Argument
For example: get serverinfo
set serverinfo
-n/--name <server name>
-x/--xml
For example: set –n newitx serverinfo
set serverinfo
-p/--password
–u/--user{root/cli}
-x/--xml
create dump
Description
Displays the server information
such as server name, build version,
build date and so on.
Configures the name of the server.
The length of the servername
should be less than 16 characters
and the first character must be
alphabetical.
System will prompt you to enter
and confirm the new administrator
(root/cli) password.
Password length should be 32 or
less characters.
Creates a dump of the running
system that is useful for debugging.
The file is placed in /usr/AmiNas.
Health Configuration
These commands get the health information
Command
get health
get health
get health
get health
Argument
-c/--enccount
-x/--xml
For example: get –c health
-i/--info –n/--enclosure
-x/--xml
For example: get –i –n 0 health
-s/--encstatus
–n/--enclosure (optional)
-x/--xml
For example: get –s health
get –s –n 0 health
-a/--x/--xml
For example: get –x –a health
Description
Gets the number of enclosures
present in the system.
Gets the health information
regarding fan, voltage and
temperatures for the given
enclosure.
Gets the enclosure status for the
given enclosure or for all the
enclosures.
Gets the enclosure status for all the
enclosures.
Chapter Two: Command Set
13
iSCSI Configuration
Note:
Targetname input: Only the suffix portion of the targetname is required.
For example: “iqn.1991-10.com.ami:itx001a2b3c4d5e2006:test1” . The user needs to input only “test1”.
Command
get iscsi
get iscsi
activate iscsi
deactivate iscsi
enable iscsi
disable iscsi
start iscsi
stop iscsi
set iscsi
get iscsi
set iscsi
Argument
-t/--type {tgtstatus}
-n/--targetname <targetsuffix>
For example: get –t tgtstatus –n target1 iscsi
-t/--type {tgtname}
-t/--type {portal}
-p/--ipaddress <Ipaddress of the target machine>
-g/--portaltag <portal tag>
For example: activate –t portal –p 10.15.1.1 –g 3
iscsi
-t/--type {portal}
-p/--ipaddress <ipaddress of the target machine>
-t /--type {tgt}
-n/--targetname <target suffix>
-t/--type {tgt}
-n/--targetname <target suffix>
For example: cli disable –t tgt –n newtgt iscsi
For example: stop iscsi
-t/--type {params}
-o/--choiceno {0-12}
-l/--value <value>
For example: set –t params –o 1 –l 256 iscsi.
-t/--type {lunwritecachemode}
-v/--volumename <volume name>
-c/--containername <containername>
-t/ --type {lunwritecachemode}
-v/--volumename <volume name>
14 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Gives the status of the target as
enabled or disabled.
Gets the iSCSI target name. This
value is not configurable and is
unique to the iTX device.
For example:
iqn.199110.com.ami:itx0030482c8d788a7e
Activates the specified iSCSI
portal. You have to specify a portal
tag at the time of activation of the
portal.
Deactivates the specified iSCSI
portal.
Enables the specified target.
Disables the specified target.
To start the iSCSI service.
To stop the iSCSI service.
Sets specified iSCSI Login
negotiation parameters.
The possible values are:
1. FirstBurstLength (0-256 KB,
default=256)
2. MaxBurstLength (must be less
than #1, default=256)
3. MaxRecvDataSegmentLength
(0-256KB, default=256)
4. MaxConnections (0-4,
default=2)
5. DefaultTime2Retain (0-3600,
default=20 sec)
6. DefaultTime2Wait (03600,default=2 sec)
7. InitialR2T (0-1, default=No,0)
8. MaxOutStandingR2T (1-8,
default=1 sec)
9. ErrorRecoveryLevel (0-2,
default=2)
10. ImmediateData (0-1,
default=1,yes)
11. DataPduInOrder (0-1,
default=1,yes)
12. DataSeqInOrd (01,default=1,yes)
Gets the Write Cache mode for the
specified disk.
Sets the Write Cache mode for the
specified disk.
Command
add iscsi
remove iscsi
get iscsi
get iscsi
get iscsi
add iscsi
remove iscsi
get iscsi
remove iscsi
list iscsi
list iscsi
get iscsi
set iscsi
set iscsi
get iscsi
get iscsi
set iscsi
Argument
-c/--containername <containername>
-m/--mode {0/1/2}
For example: set –t lunwritecachemode –v v1 –c c1
–m 0 iscsi
-t/--type {processor}
-n/--targetname <target suffix>
-t/--type {processor}
-n/--targetname <target suffix>
-t/--type {statistics}
For example: get –t statistics iscsi
-t/--type {portalstatus}
-p/--ipaddress <ipaddress>
-t/--type {servicestatus}
-t/--type {lun}
-v/--volumename <volume name>
-c/--containername <container name>
-n/--targetname <targetsuffix>
-t/--type {lun}
-v/--volumename <volume name>
-c/--containername <container name>
-n/--targetname <target suffix>
-t/--type {sessions}
For example: get –t sessions iscsi
-t/--type {session}
-s/--sessionid <session id>
-t/--type {tgt}
-t/--type {lun}
-n/--targetname <target suffix>
-t/--type {tgtauthsettings}
-n/--targetname <target suffix>
-t/--type {peersecret}
-i/--initiatorname < initiatorname. (Default : none)>
-s/--peersecret
For example: set –t peersecret –I iqn.199110.com.microsoft:newbox –s iscsi
-t/--type {tgtauthsettings}
-n/--targetname <targetsuffix>
-u/--username <user name ‘none’ for default >
-r/--secretname <user password ‘none’ for default >
-i/--initiatorname <initiator name – ‘none’ for
default>
-t/--type {lun}
-n/--targetname <target suffix>
-v/--volumename<volumename>
-c/--containername<containername>
-i/--info
-t/--type {tgtoptimizations}
-n/--targetname <target name>
-t/--type {tgtoptimizations}
-n/--targetname <target suffix>
-p/ --multiplesession {y/n}
-g/--nopinterval < nop ping internal >
Description
0 – Write through
1 – Write back
Adds the processor to the specified
target (used for backup).
Removes the processor from the
specified target.
Gets the iSCSI statistics, for
example, No. of iSCSI PDU sent
and received, payload, and
login/session failures.
Gets the iSCSI Portal Status.
Gets the iSCSI service status.
(Active/Inactive)
Adds the LUN to the specified
target.
Removes the LUN from the
specified target.
Gets the current sessions details
including session id.
Terminates the session with the
given ID. To avoid automatic
reconnection by the initiator, you
will need to change the security
settings for that target prior to
termination.
Gets the List of Targets available.
Gets the available LUNs in the
given target.
Gets the Authorization settings for
the target.
Sets the peer secret for the initiator.
You will be prompted to enter this
twice.
Sets the Authorization settings for
the target. The secret name should
be at least 12 characters in size
This will give exclusive access to
the LUN for the specified user and
initiator for maximum security.
Gives the LUN's Information for
the specified target.
Gives the Target's Optimization
settings (i.e. whether multiple
initiator logins are supported).
Sets the Target's Optimization
settings to allow/disallow multiple
initiators logging in to a target
simultaneously.
Chapter Two: Command Set
15
Command
enable iscsi
disable iscsi
get iscsi
set iscsi
enumerate iscsi
add iscsi
remove iscsi
rescan iscsi
update iscsi
reset iscsi
get iscsi
set iscsi
Argument
For example: set –t tgtoptimizations –n t1 –p y –g
10 iscsi
-t/--type { iSNSservice}
-t/--type { iSNSservice}
-t/--type {iSNS}
-t/--type {iSNS}
-e/--entityname <entity name>
-a /--aliasname <alias name>
-t/--type {initiator}
-n/--targetname <target suffix, ‘none’ for default>
-t/--type {iSNSServer}
-i/--ipaddress <ip address>
-t/--type {iSNSServer}
-p/--ipaddress <ip address>
-t/--type {iSNS}
-t/--type {noderegistrations}
-t/--type {params}
-o/--choice {0-12}
-t/--tgtname
Description
Enables the iSNS Service.
Disables the iSNS Service.
Gives the iSNS server's
information i.e. iSNS server IP,
server status, command
description, last status message.
Sets the specified iSNS
information.
Gets the iSCSI initiators from the
iSNS server.
Adds a new iSNS server.
Removes an existing iSNS server.
Rescan for targets and initiators.
Updates the nodes that are
registered with all iSNS servers
this iTX device is registered with.
Resets the iSCSI statistics.
Gets values of the specified iSCSI
login negotiation parameters.
This resets the base iSCSI target
name of the iTX box
This operation should be done with
utmost precaution and there should
not be any replication pairs in the
box. Logout of all existing iSCSI
sessions before running this
command
License configuration
These commands configure the License.
Command
set license
set license
get license
get license
Argument
-k/--key <key>
-x/--xml
-f/--file <filename with path>
-x/--xml
-s/--serviceKey
-x/--xml
-l/--licenseInfo
-x/--xml
16 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Sets the entered license key to file.
Sets the license according to the
license key given in file path.
Gets the license service key
necessary if you want to upgrade
your iTX license.
Gets the current license
information.
Network Controller Configuration
These commands configure the network ports. They can also be used to create virtual bonding network ports
(teams) for high availability and/or load balancing.
Command
get network
get network
set network
set network
get network
list network
create network
delete network
get network
get network
list network
add network
Argument
-t/--type {port}
-c/--count
-x/--xml
For example: get –t port –c count network
-t/--type {port / alias}
-n/ --name <name of the adapter >
-i/--info
-x/--xml
-t/--type {port}
-n/--name <Name of the NIC>
-d/--dhcp
-x/--xml
For example: set –t port –n nic-1 –d network
-t/--type {port / alias}
-n/--name <Name of the NIC>
-i/--ip <IP Address>
-m/--mask <net mask>
-g/--gate <Gateway> (optional)
-p/--pridns <Primary DNS> (optional)
-s/--secdns <Secondary DNS>(optional)
-f/--dnssuff <DNS suffix>(optional)
-j/--mtu <size> (optional)
-t/--type {adp}
-c/--count
-x/--xml
-t/--type {adp}
-t/--type {team}
-m/--mode {1/2/3}
-p/--pri <primary NIC>
-s/--sec <secondary NIC>
-x/--xml
Creates a team named Team-1, Team-2, and so on,
depending on available NICs in system
For example: create –t team –p nic-1 –s nic-2 –m 1
network
-t/--type {team}
-n/--name <name of the Team>
-x/--xml
For example: delete –t team –n Team-1 network
-t/--type {team}
-i/--info
-n/--name <name of the Team>
-x/--xml
For example: get –t team –i –n Team-1 network
-t/--type {team}
-i/--info
-n/--name <name of the Team>
-x/--xml
-t/--type {adp/port}
-x/--xml
-t/--type alias
-n/--name <alias name>
Description
Gets the number of ports.
Displays the given network port
information.
Configures the given network port
to work with DHCP.
Configures the specified network
port to work with the given
STATIC IP configuration.
Displays the number of network
adapters present.
Displays the available network
adapters and their status.
Creates a network team with the
given mode. The supported modes
are:
1 – Balance Round Robin
2 – 802.3 AD (with pre-configured
switch)
3 – Balance TB
Deletes the network team with the
given name.
Displays the number of NICs
present in the given team.
Displays the given network team
information.
Displays various information for
the available network ports
including their status.
Adding an alias adapter for a
specific NIC port
Chapter Two: Command Set
17
Command
remove network
Argument
-p/--port <adapter name>
-t/--type alias
-n/--name <alias name>
Description
Removing an alias adapter
NAS Quota Configuration
These commands configure quotas for the NAS volumes of your iTX box.
Command
get quota
set quota
list quota
get quota
set quota
Argument
-t/--type {user }
-p/--path <volume path>
-n/--name <user name>
-x/--xml
For example: get –t user –p c0_nas0 –n user1 quota
-t/--type {user }
-p/--path <volume path>
-n/--name <user name>
-q/--quotasize <size>
-f/--filecount <file count>
-x/--xml
For example: set –t user –p c0_nas0 –n user1 –q
4000 –f 400 quota
-p/--path <volume path>
-x/--xml
-p/--path <volume path>
-d/--default
-x/--xml
-p/--path <volume path>
-q/--quotasize (KB) <quota size>
-d/--default [y/n]
-x/--xml
18 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Displays the quota configured for
the given member.
Configures the quota size of given
member.
Size should be entered in KB.
Displays the user quota configured
for a given volume as specified in
path.
Displays the default quota
configured for the volume.
Sets the default quota limit which
should be used for a volume.
NAS User / Group Configuration
These commands allow viewing and configuration of the NAS Users and groups accounts.
Note:
Command
add ug
add ug
delete ug
get ug
list ug
get ug
get ug
set ug
Known Issue: As iTX software supports enabling of ADS and NIS simultaneously, the user/group
list retrieved will be given for both instead of singly.
Argument
-t/--type {user}
-u/--username <user name>
-i/--id <userid (optional)>
-p/--passwd <password(optional)>
-f/--fullname <Full name>
-x/--xml
For example: add –t user –u user1 –p password –f
“User 1” ug
-t/--type {group}
-g/--groupname <group name>
-i/--id <group id (optional)>
-x/--xml
-t/--type {user}
-u/--username <username>
-x/--xml
-t/--type {user/group}
-s/--section {local/ads/nis/all}
-c/--count
-x/--xml
For example: get -t user -i -u test1 ug
-t/--type {user/group}
-s/--section (local/ads/nis/all)
-x/--xml
For example: list -t user -s all ug
-t/--type {group}
-i/--info
-g/--groupname <groupname>
-x/--xml
For example: get –t group –I –g groupA ug
-t/--type {user}
-i/--info
-u/--username <username>
-x/--xml
-t/--type { user}
-u/--username <username>
-p/--passwd <password>
-f/--fullname <fullname>
-x/--xml
Description
Adds a user. If password is not
entered in command line, it will be
prompted for.
Username is case-sensitive, must
be alphanumeric, and 8 -32
characters .
Adds a group. Group name is casesensitive, must be alphanumeric,
and 8 -32 characters.
Deletes the given user.
Displays the count of users / groups
of specified type.
Displays the specified list of users /
groups and their info.
Displays the group info.
Displays the specified user’s info.
Changes the user info to given
values for password and/or full
name.
For exmaple: set -t user -u test1 -p test1 -f
test1 ug
list ug
delete ug
delete ug
-t/--type {group}
-g/--groupname <groupname>
-x/--xml
-t/--type {group}
-g/--groupname <groupname>
-x/--xml
-t/--type {group}
-g/--groupname <groupname>
-u/--username <username>
-x/--xml
For example: cli delete –t group –g groupA –u
user1 ug
Displays the users present in a
particular group.
Deletes the given group.
Deletes the given user from the
specified group.
Chapter Two: Command Set
19
set ug
-t/--type {group}
-g/--groupname <groupname>
-u/--username <username>
-x/--xml
Adds the given user to the specified
group. Multiple users can be added
using –u/--username switch.
(maximum of 8 users at a time)
Protocol Configuration
These commands configure the various network protocols supported.
Command
get protocol
Argument
-t/--type {cifs/nfs/http/snmp/nis/ads/https/ftp/upnp}
set protocol
-t/--type
{cifs/nfs/apple/http/snmp/nis/ads/https/ftp/upnp}
-d/--disable or
-e/--enable
-x/--xml
For example: set –t cifs –e protocol
-t /--type {snmp}
-n/--communityname
For example: get –t snmp –n protocol
-t/--type {cifs}
-w/--winserver
-t/--type {cifs}
-s/--winsserver <winsserver name>
-m/--mtype {wg/nt/ads}
-w/--workgroup <workgroupname>
-x/--xml
-t/--type {snmp}
-n/--communityname <communityname>
get protocol
get protocol
set protocol
set protocol
set protocol
-t/--type {nfs}
-i/--ipaddress <ipaddress or “world” >
-d/--disable or
-e/--enable
-x/--xml
For example:
set -t nfs -i 10.0.0.124 -i 10.0.0.123 -e -x protocol
list protocol
get protocol
-t/--type {nfs}
-c/--count
20 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Gets the status of cifs, nfs, http,
snmp, nis, or ads protocols.
Enables or Disables the specified
protocol.
Gets the community name for
snmp.
Gets the Wins server address.
Sets the Wins server address.
Sets the snmp community name
By default, the public community
name is supported.
Sets the nfs clients.
Lists all the protocols and
whether they are enabled or
disabled.
Gets the number of NFS clients
that have access to NAS shares.
RAID & Disk Management Commands
These commands allow management of disks and RAID creation.
For Hardware RAID please enter the Slotindex (For example: 1, 2,3, and so on) instead of diskname (For
example: /dev/sda, /dev/sdb) in the option for -d / --diskname <DiskInfo_OSName or slotindex>
Command
get raid
Argument
-t/--type {pd/ld/controller}
-c/--count
get raid
-t/--type {controller}
-a/--alarm
-n <controllerno>
-t/--type {pd/ld/controller}
list raid
list raid
-t/--type {pd/enclosure}
-n <controllerno>
list raid
-t/--type {spare}
get raid
-t/--type {pd}
-i/--info
-n/--controllerno <controller number>
-d / --diskname <Diskname or slotindex>
-t/--type {pd}
-d/--diskname <diskname or slotindex>
-n <ControllerNo>
-m/--cachemode
For example: get –t pd –d 1 –n 0 –m raid
-t/--type {ld}
-l/--ldname < Logical_Osname>
-m/ --cachemode
-d/--diskname <diskname or slotindex>
-l/–ldname <ldname>
-t/--type {ld}
-s/ --disksize <disksize optional in GB>
-p/--stripesize <stripe size 64 KB>
-d / --diskname <diskname or slotindex>
-a/--sparediskname <sparediskname> (optional)
-e/--distspare <distributedspare> (optional)
-r / --raidlevel <raid
level(0/1/3/5/6/10/1N/10N/50/60) >
-m/--cachemode <cachemode>
-b/--subdisk <subdiskcount>
-n/--controllerno <controllerno>
For example:
cli create -t ld -p 64 -d 1:5 -d 1:6 -r 0 -m
WriteThrough:ReadAhead:Cached -n 0 raid
get raid
get raid
rebuild raid
create raid
Description
Displays the number of disks,
logical drives and controllers
respectively.
Displays the alarm mode and
battery status of controllers
respectively.
Displays the list of logical drives
and controllers respectively.
Displays the list of physical drives
and enclosures for controller
respectively.
Displays the list of spare disks.
Displays the information about
specified disk.
Gets the physical disk cache mode.
Gets the logical drive cache setting.
Rebuilds a logical drive with the
specified disk drive.
Creates a logical drive.
-s/ --disksize – only supported for
3U
For LSI RAID Controller - Cache
Modes Format writecache:readcache:cachemode
writecache values - WriteThrough
/ WriteBack / ForceWriteBack
readcache values ReadAheadNone / ReadAhead /
ReadAdaptive
cachemode values - Direct /
Cached
-p/ --stripesize – only 64 kb
supported for 3U
delete raid
-t/--type {ld}
-l / --ldname <drivename>
For example: delete –t ld –l /dev/md1 raid (1U)
For example: delete –t ld –l /dev/sdb raid (3U)
Minimum LD size: 10 GB
Deletes specified logical drive.
Chapter Two: Command Set
21
Command
expand raid
transform raid
blink raid
blink raid
set raid
Argument
-t/--type {ld}
-l/ -- ldname <ldname >
-d/ --diskname <diskname or slotindex(optional)>
-s/--disksize <disksize in GB>
-b/--subdisk <subdiskcount (Required only for
RAID10N and RAID50)>
-e/--distspare
-n/--controllerno <controllerno (Required only for
LSI RAID controller)
For example: expand -t ld -l /dev/sdb -d 2 -s 20 raid
-t/--type {ld}
-l / --ldname <ldname>
-d / --diskname <diskname or slotindex >
-r/ --raidlevel
<raid level (0/1/3/5/6/10/1N/10N/50/60)>
-s/--size <size (optional)> (enter ss for same size)
-b/--subdisk <subdiskcount (Required only for
RAID10N and RAID50)>
-e/--distspare
-n/--controllerno <controllerno (Required only for
LSI RAID controller)
For example: transform -t ld -l /dev/md0 -r 5 -d
/dev/sda -d /dev/sdb raid
-t/--type {ld/pd}
-d / --diskname<diskname or slotindex>
-n/--controllerno <controllerno>
For example: blink –t pd –l /dev/sda –n 0 raid
-t/--type {ld/pd}
-l / --ldname <ldname>
-t/--type {pd}
-d / --diskname<diskname or slotindex>
-m / --cachemode
< diskcache mode>
-n/--controllerno <controllerno>
Cache Modes - pd
0 - None 1 - Read 2 - Read-Write
3 - Read-Ahead 4 - Read-Ahead-Write
For example: set –t pd –d 2 –m 1 –n 0 raid
Description
Expands the logical drive to
specified disksize using specified
disk.
Transforms a logical drive.
Blinks a disk (not supported on a
1U yet).
Blinks a logical drive (not
supported on a 1U yet).
Sets the cache mode for disk (HW
RAID only).
For LSI RAID Controller - Cache
Modes Format writecache:readcache:cachemode
writecache values - WriteThrough
/ WriteBack / ForceWriteBack
readcache values ReadAheadNone / ReadAhead /
ReadAdaptive
cachemode values - Direct /
Cached
set raid
set raid
set raid
-t/--type {pd}
-d / --diskname<diskname or slotindex>
-g/--makegood
-n/--controllerno <controllerno>
-x/--xml
For example: set -t pd -d 1:2 -g -n 0 raid
-t/--type {controller}
-n/--controllerno<controller no>
-a / --alarmmode <alarm mode>
Alarm Modes - controller
0 - NP 1 - Enable 2 - Disable
3 - Mute 4 - UnMute
-t/--type {ld}
22 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Sets the alarm mode for controller
Set the cache mode for LD
Command
Argument
-l / --ldname <ldname>
-m/--cachemode <cache mode>
Cache Modes - ld
0 - None 1 - Read
2 - Write 3 - Read-Write
Description
rescan raid
-n/--controllerno <controller number>
remove raid
-t/--type {spare}
-d / --diskname <diskname or slotindex>
-l/ --ldname <ldname> (for dedicated spare)
-n/--controllerno <controllerno>
For example: remove -t spare -d 3 -n 0 raid
remove -t spare -l /dev/md0 -d /dev/sdb raid
-t/--type {spare}
-d / --diskname or slotindex or
enclosurenumber:slotindexl/--ldname <ldname>(for dedicated spare)
-n/--controllerno <controllerno>
For example: add -t spare -d 1:4 -n 0 raid
-t/--type {controller}
-n/--controllerno <controller number>
-o /--code <code>
-l/ --length <length>
-t/--type {pd}
-d / --diskname <diskname or slotindex>
-n/--controllerno <controller number>
-o /--code <code>
-l/ --length <length>
Initiates rescanning of the storage
bus connected to the controller.
Removes a drive assigned as a
spare disk or dedicated disk.
add raid
upgrade raid
upgrade raid
Adds the given drive as a global or
dedicated hot spare.
Upgrades the firmware for
controller.
Upgrades the firmware for a
physical disk.
Chapter Two: Command Set
23
Share, Directory & ACL Configuration
These commands work on NAS shares and directory.
Command
create dir
list dir
delete dir
Argument
-p/--path <directory path>
-x/--xml
For example: create –p c0_nas0/new dir
-p/--path <directory path>
-x/--xml
-p/--path <directory path>
-f/--force (optional)
-x/--xml
list share
get share
get share
get share
add share
delete share
delete share
set share
-t/--type {share}
-c/--count
-x/--xml
-t/--type {share}
-i/--info
-p/--path < path of the share >
-x/--xml
-t/--type {acl}
-p/--path < path of the share >
-x/--xml
-n/--name <name of the share >
-p/--path <path to be added>
- s/--prototype {cifs/nfs/upnp/apple/http/ftp}
-x/--xml
For example: add –n share0 –p c0_nas0/new –s cifs
–s ftp share
-t/--type {share}
-n/--name <name of the share >
-x/--xml
For example: delete -t share –n share1 share
-t/--type {acl}
-p <directory path>
-u/--username <username> or -g/--groupname
<groupname>
-x/--xml
For example: delete -t acl -p c0_v0/test1 -u test1
share
-t/--type {acl}
-x/--xml
-p/--path <directory path>
-m/--mode
<USERNAME:MODE{user/group}:PERMISSION
S:INHERITANCE:ALLOW:LEVEL>
-e/--enable or -d/--disable
-v/--voltype (0 for NT 1 for posix)
-i/--inherited (0 to not inherit 1 otherwise)share
For example: set -t acl -p Cont0_Volume0/dir1 m user1:user:agf:3:1:0 -m user2:user:agh:5:0:0 -m
group1:group:gd:3:1:1 -e -v 1 -i 0 share
24 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Creates a subdirectory with the
given complete path.
Displays all directories in the
volume.
Deletes a subdirectory with the
given complete path. The complete
path should also include the
volume path exported by the
system. The subdirectory should be
empty before deletion.
Note: the parent directory cannot
be deleted For example: c0_nas0
Displays all shares and details of
each.
Gets the number of shares.
Gets the share information
according to the path given.
Gets the acl permissions of a share.
Adds specified share to the system.
Note: Please make sure a directory
with the same path is made before
creating a share
Deletes a share from the system.
Deletes a acl share from the
system.
Sets the acl permission of the share
(maximum of 4 ACL permissions
can be entered at a time. And 237
acl permissions maximum per
share).
The -e/-d option is to enable or
disable ACL recursively for the
root folder and sub folders
ALLOW FOR NT
0 - Allow ACE 1 - Deny ACE
LEVEL FOR NT
0 - Apply to all levels 1 – Apply
to first level
PERMISSIONS FOR POSIX
0 - Read Write 1 - Read Only
2 - Deny
PERMISSIONS FOR NT : The 14
bits in following order
A - Traverse Folder / Execute file
B - List Folder / Read Data
C - Read Attributes
D - Read Extended Attributes
E - Create files/ Write Data
F - Create folders / Append Data
G - Write Attributes
H - Write Extended Attributes
I - Delete Subfolders and files
J - Delete
K - Read Permissions
L - Change Permissions
m - Take Ownership
INHERITANCE FOR NT
0 - No inheritance
1 - this folder sub folders and files
2 - this folder and sub folders
3 - this folder and files
4 - subfolders and files only
5 - subfolders only
6 - files only
set share
-t/--type {share}
-n/--name <name of the share>
-p/--path <path of the share>
-s/--prototype <cifs/nfs/upnp/apple/http/ftp>
-x/--xml
For example: set -t share -n test1 -p
Container0_Volume0/dir1 -s cifs -s http -s upnp
share
Sets a share properties.
Chapter Two: Command Set
25
System Control Configuration
These commands configure the System controls.
Command
shutdown system
get system
Argument
For example: shutdown system
For example: cli get -x system
set system
-f/--fansensors <on/off>
-t/--tempsensors <on/off>
-x/--xml
reboot system
Description
Shuts the system down.
Gets the auto shutdown
information.
Sets the fan sensors or temperature
sensors on or off for autoshutdown
(only temperature supported at this
release).
Reboots the system.
Volume and Snapshot Commands
These commands manage the way Containers, Volumes and Snapshots are created, or expanded. While some
of these commands are specific to either NAS or iSCSI volumes, most will work in both types of volumes.
Command
create volume
create volume
create volume
create volume
create volume
Argument
-t/--type {container}
-c/--containername<containername>
-k/--chunksize< {64} in KB>
-l/--ldname<logical device name> .....
For example: create –t container –c c0 –k 64 –l
/dev/md2 volume (1U)
For example: create –t container –c c0 –k 64 –l
/dev/sdb volume (3U)
-t/--type { volume }
-c/--containername <containername>
-v/--volumename <volumename>
-z/--volumesize <volumesize in GB>
-k/-- <chunksize {64 or 8} in KB }><volumesize>
-p/--provisiontype< provisiontype {0/1/2} >
-e/--volumetype <volumetype
{0} >
-f/--voldialect <volumedialect
{0/1} >
For example: create -t volume -c Cont0 -v
AutoNas -k 64 -z 20 -e 0 -p 2 -f 1 volume
-t/--type {snap}
-c/--containername <containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
For example: create –t snap –c c0 –v v0 –s snap00
volume
-t/--type {snap}
-c/--containername <containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
-w/--writablesnapname<writablesnapname >
For example: create –t snap –c c0 –v v0 –s snap00
–w wsnap00 volume
-t/--type { snap }
-c/--containername <containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
-R/--remotesnap
26 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Creates a container.
Note:
The chunk size should be 64K
The device name should be in the
form /dev/mdx or /dev/sdx where x
can be 0,1,2,3…
Creates a Volume.
Note:
1)volumetype ([0]-ROW
2) voldialect ([[0]-ISCSI [1]-NAS)
3)provisiontype ([0]-Thin [1]Exact 2 – Auto(Nas Only)
As a best practice measure, it is
recommended that 20% of
container capacity be reserved (left
free) for snapshots.
Creates a read-only Snapshot.
Note: A total of 254 read-only
Snapshot can be created per
volume. And the total number of
snapshots (read-only + writable) is
992 per iTX device.
Creates a writable Snapshot over a
read-only snapshot.
Note: A total of 254 writable
Snapshot can be created per
volume. But the total number of
snapshots (read-only + writable)
should be 992 per iTX device.
Creates a snapshot on the local
target as well as the remote target if
the volume is replication enabled.
If only –R is given, only the remote
snapshot is created. If only –L is
Command
Argument
-L/--localsnap
delete volume
-t/--type {container}
-c/--containername<containername>
-f/--force (optional)
-r/--recursive (optional)
-t/--type {volume}
-c/ --containername <containername>
-v/ --volumename <volumename>
-f/--force (optional)
-t/--type {snap}
-c/ --containername <containername>
-v/ --volumename <volumename>
-s/ --snapname <snapname>
-f/--force (optional)
-t/--type {snap}
-c/ --containername <containername>
-v/ --volumename <volumename>
-s/ --snapname <snapname>
-L/--localsnap
-R/--remotesnap
-f/--force (optional)
For example: delete –t snap –c c0 –v v0 –s snap00
–L –R –f volume
-t/--type {volume}
-c/ --containername <containername>
-a/--all
-f/--force (optional)
-t/--type {snap}
-c/ --containername <containername>
-v/ --volumename <volumename>
-a/--all
-f/--force (optional)
-t/--type {container}
-c/--containername <containername>
-l/--ldname<logical device name>
For example: expand –t container –c c0 –l /dev/sdc
volume
-t/--type {volume}
-c/--containername <containername>
-v/--volumename <volumename>
-z/-- capacity new volume size (in GB)
For example: expand –t volume –c c0 –v v0 –z 300
volume
-t/--type {container/volume/snap }
For example: list –t snap volume
delete volume
delete volume
delete volume
delete volume
delete volume
expand volume
expand volume
list volume
list volume
list volume
get volume
get volume
-t/--type {volume}
-c/--containername <containername>
-t/--type { snap}
-c/--containername <containername>
-v/--volumename <volumename>
-t/--type {container }
-i/ --info
-c /--containername <containername>
-t/--type {volume}
-i/--info
Description
used, then only the local snapshot
will be created.
By default, without the switches –L
and –R, it will create the local
snapshot only.
Deletes the container.
-r/ option deletes all volumes
within the container recursively.
Deletes the specified Volume.
Deletes the specified Snapshot.
Deletes the Snapshot on the local
target as well as the remote target if
the volume is replication enabled.
If –R is given, only the remote
snapshot is deleted. If –L is used,
only the local snapshot will be
deleted. By default, without the
switches –L and –R, it will delete
the local snapshot.
Deletes all the volumes within that
container.
Deletes all Snapshots for that
volume.
Expands Container by adding the
specified LD to it.
Logical Device name eg;/dev/md0
Use:–l option
Expands Volume.
List all the
Containers, Volumes, or Snapshots
in system.
List the details for all the
Volumes in specified container.
List the details about
SnapShots in specified volume and
container.
Gets the information about the
specified Container.
Gets the information about the
specified Volume.
Chapter Two: Command Set
27
Command
get volume
get volume
get volume
activate volume
deactivate volume
rollback volume
freeze volume
set volume
Argument
-c/ --containername <containername>
-v/--volumename <volumename>
-t/--type {snap}
-c/--containername <containername>
-v/--volumename <volumename>
-u/--schedule
-t/--type { snap}
-i/--info
-c/--containername <containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
For example: get –t snap –i –c c0 –v v0 –s snap00
volume
-t/--type {container}
-n /-- count
-t/--snap {snap}
-c/--containername <containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
-w/--writeable(optional)
For example: activate -t snap -c Cont0 -v Volume0
-s Volume0WriteableSnap0 -w volume
-t/--snap {snap}
-c/--containername<containername>
-v/--volumename <volumename>
-s/ --snapname <snapname>
-t/--snap {snap}
-c/--containername<containername>
-v/--volumename <volumename>
-s/--snapname <snapname>
-t/--type {container/volume/snap}
-t/--type {snap}
-u/--schedule
-c/--containername<containername>
-v/--volumename <volumename>
-s/-schedulesnap <scheduleduration:maxsnapshots>
-d/--description <description>
-n/--backtargetname <backuptargetname >
-p/--scheduleType 0-Windows,1-Local
[default:Windows] volume
For example: set -t snap -c Cont0 -v
Volume0ISCSILUN0 -s 5:10 -s 60:20 -d testing -n
backuptest -p 0 volume
28 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Description
Gets the snapshot schedule settings
for the specified volume.
Gets the information about the
specified Snapshot.
Gets the number of containers in
system.
Activates writeable Snapshot.
Deactivates the Snapshot.
Rolls back the Snapshot. Requires
disconnecting and stopping of all
I/Os.
Freezes the UVM
Container/volume/snap.
Note: Yet to be implemented.
Set the Snapshot Schedule.
Note: maximum number of read
only snapshots (read-only +
writable) is 254 per volume for a
total of 992 per system.
UPS Configuration
These commands configure the UPS for power management.
Command
get UPS
get UPS
set UPS
set UPS
set UPS
Argument
-i/--info
-x/--xml
-i/--info
-m/--monitor
-x/--xml
-d/--disable
-x/--xml
-e/--enable or
-d/--disable
-b/--battery <min battery value>
-t/--timeout <mins>
-m/--mode {1}
-x/--xml
For example: set –e –b 10 –t 3 –m 1 ups
-e/--enable or
d/--disable
-b/--battery <min battery value>
-t/--timeout <mins>
-m/--mode {2}
-i/--masterip <{HostName/Master Ip>
-x/--xml
For example: set -e -b 35 -t 300 -m 2 -i 10.0.0.218
ups
config UPS
config UPS
config UPS
-i/--info
-x/--xml
-l/--list
-x/--xml
-d/--driver <num>
-p/--port <value>
-x/--xml
For example: config –d 2 –p 1 ups
Description
Displays the existing UPS
configuration.
Display the monitoring
configuration for the configured
UPS devices.
Disables automatic shutdown.
Sets the UPS configuration to
given values. The enable mode is
to denote the shutdown option.
Timeout should be given in
minutes. Battery is the minimum
battery value below which the
shutdown is triggered Mode checks
whether it set to master or slave.
Note:
Minimum Battery value should be
between 0 and 100 %
Timeout value should be between
0 and 1000 minutes
Sets the UPS configuration to
given values. The battery value
indicates the minimum battery
value at which the alert has to be
generated. Timeout should be
given in minutes. Mode is set to
slave and the masterip is IP
Address of the master.
Note:
Minimum Battery value should be
between 0 and 100
Timeout value should be between
0 and 1000
Displays currently configured
driver for UPS monitoring.
Displays list of available drivers.
Sets driver to use with UPS
monitoring.
Driver number is from list obtained
from –list command.
Port value:
1 – COM1
2 – COM2
u - USB
Chapter Two: Command Set
29
Synchronous replication
These commands configure synchronous replication and High Availability using Windows DSM
(iTX 2.7v 2.x).
Command
create syncreplica
Argument
–l/--local < cont_vol_name>
-r/--remote < cont_vol_name>
-p/--priority <resync priority>
-i/--localhost <primary's IP address>
-m/--remotehost <rem host name>
-d/--mode [sync | ha]
Example: replication in local volumes
create -l c0_v0 -r c1_v1 -p 50 -i 172.16.70.70 -d
sync -m local syncreplica
Example: HA in remote volumes
create -l c0_v0 -r c1_v1 -p 50 -i 172.16.70.70 -m
172.16.70.102 –d ha syncreplica
update syncreplica
–l/--local < cont_vol_name>
-p/--priority <resync priority>
-m/--remotehost <rem host name>
-x/--xmlflag <xml flag>
Description
Creates a replication pair. Both the
primary and secondary volumes
should be present before this
operation.
For local volume copy, please enter
remote host as “local”. All other
parameters remain same. Default
resync priority is zero.
Specify sync for –d/--mode option
to create a synchronous replication
pair; specify ha for –d/--mode
option to create an high-availability
pair.
NOTE: management target name
for SR is the name of the virtual
target, as opposed to mtarget in
earlier versions (2.5/2.6).
Updates the given parameters of
the volpair in DDF and in module.
For example: update -l c0_v0 -p 50 -m
172.16.70.102 -x syncreplica
get syncreplica
-l/--local <local-primary cont_vol_name>
For example: get –l c0_v0 syncreplica
list syncreplica
-c/--container <container name>
For example: list –c c0 syncreplica
-l/--local < cont_vol_name >
-f/--force (optional)
delete syncreplica
split syncreplica
-l/--local <local-primary cont_vol_name>
join syncreplica
-l/--local <cont_vol_name>
perform syncreplica
-t/--type {failover}
-l/--local <cont_vol_name>
perform syncreplica
-t/--type {failback}
-l/--local <cont_vol_name>
For example: perform –t failback –l c0_v0
syncreplica
30 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Displays the replication details as
available from DDF as well as
runtime.
Lists available replication pairs in
the given container.
Deletes the given synchronous
replication pair. Note : Use --force
to clean up non-operational pair
locally.
Temporarily stops replication of
the replication pair. But at a later
time, the replication can be joined
to replicate from the place where it
stopped.
Manually joins or resync the
replication on the given
consistency group that was split
earlier. Also, this command should
be used to initiate a failback
resync.
Initiates failover on the given
consistency group. This command
has to be given in the secondary
target. All further I/Os will be
fielded by the secondary from now
on.
This will reinstate the initial
primary to start fielding I/Os after a
successful failback. Resync has to
be completed before activating the
failback.
High Availability (iTX27 v3.x and up )
These commands configure High Availability which is OS Agnostic
Command
syncparams
syncreplica
Argument
-r/--remoteip < remote ipaddress >
-x/--xmlflag
For example:
syncparams -r 172.16.70.148 syncreplica
managerg syncreplica
-t/--type <action{create/delete/get/editalias/
removealias/addalias/changeowner/forcetakeover}>
-n/--rgname <resource group name>
-a/--alias <Alias>
-r/--remoteip <remote ipaddress>
-v/--vipaddress <Virtual iapddress>
-l/--local <localipaddress>
-f/--force
-x/--xmlflag
For example:
managerg -t create -n rg0 -a Alias-1 -a Alias-2 -r
172.16.70.146 -l 172.16.70.176 syncreplica
managerg -t get syncreplica
managerg -t delete -n rg0 syncreplica
managerg -t editalias -n rg0 -v 172.16.70.10 -a
Alias-1 syncreplica
managerg -t addalias -n rg0 -a Alias-2 syncreplica
managerg -t removealias -n rg0 -a Alias-2
syncreplica
managerg -t changeowner -n rg0 syncreplica
managerg -t forcetakeover -n rg0 syncreplica
create syncreplica
–l/--local < cont_vol_name>
-r/--remote < cont_vol_name>
-p/--priority <resync priority>
-i/--localhost <primary's IP address>
-m/--remotehost <rem host name>
-d/--mode [hanodsm]
-g/--rgname <resource group name>
Example: HA NO DSM replication in remote
volumes
Description
Syncparams is used to sync the
iscsi base target names/date and
time between local and remote
machines before creating an HA
pair.
This command has to be executed
in the Primary machine before
creating the first RG between two
iTX machine.
Managerg command is used to
manage and configure Resource
Group. Action denotes the
operation to be perfomed on the
RG
This command is also used to
add/remove/edit virtual IP
configured for a specific RG.
Note: Atleast one VIP should be
present for an RG.
This command is also used the
change the original ownership of
an RG.
--forcetakeover option can be used
to takeover the RG forcefully if the
RG is in an inconsistent state but
this may result in data corruption.
--force option is used to delete an
non operational RG forcefully if
remote is dead.
Creates a replication pair. Both the
primary and secondary volumes
should be present before this
operation.
Default resync priority is 25.
Specify sync for –d/--mode option
to create a synchronous replication
pair; specify hanodsm for –d/-mode option to create an highavailability pair.
create -l c0_v0 -r c1_v1 -p 50 -i 172.16.70.70 -d
hanodsm -m 172.16.70.1
02 -t iqn.199110.com.ami:itx00c09f2164459104:virtual -g rg0
syncreplica
update syncreplica
–l/--local < cont_vol_name>
-p/--priority <resync priority>
-m/--remotehost <rem host name>
Updates the given parameters of
the volpair in DDF and in module.
Chapter Two: Command Set
31
Command
Argument
-g/--rgname <rgname>
-x/--xmlflag <xml flag>
For example:
update -l c0_v0 -p 50 -m 172.16.70.102 -x
syncreplica
Description
Update command is used to move a
replication volume pair from
Resource group to another.
-g stands for the destination rg
name.
update -l c0_v0 -g rg0 syncreplica
get syncreplica
-l/--local <local-primary cont_vol_name>
-r/--rginfo
-o/--owner
For example:
get –l c0_v0 syncreplica
get -r syncreplica
get -o syncreplica
list syncreplica
delete syncreplica
-c/--container <container name>
-r/--group
For example:
list –c c0 syncreplica
list -r syncreplica
-l/--local < cont_vol_name >
-f/--force (optional)
For Example:
delete -l c0_v0 syncreplica
delete -l c0_v0 -f syncreplica
delete -l c0_v0 -l c1_v2 -l c1_v2 -f syncreplica
split syncreplica
-l/--local <local-primary cont_vol_name>
-g/--rgname <resource group name>
For Example:
split -l c0_v0 syncreplica
split -g rg0 syncreplica
join syncreplica
-l/--local <cont_vol_name>
-g/--rgname <resource group name>
For Example:
join -l c0_v0 syncreplica
join -g rg0 syncreplica
convert syncreplica
convert -c/--container <container_name> -v/-volume <volume_name> -g/--rg <resource_group>
For Example:
convert -c c0 -v v0 -g rg0 syncreplica
32 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Displays information about
Resource Group.
This command can be used both in
Primary & Secondary storage
systems.
It Displays the replication details as
available from DDF as well as
runtime.
Lists available replication pairs in
the given container.
It can be used to display the details
about the resource group
configured in the system and the
corresponding replication pairs.
Deletes the given synchronous
replication pair. Note: Use --force
to clean up non-operational pair
locally.
Multiple pairs (up to 64) can be
deleted at the same time by using -l
repeatedly.
Temporarily stops replication of
the replication pair. But at a later
time, the replication can be joined
to replicate from the place where it
stopped.
This command can used to stop all
the replication pairs part of the RG
Manually joins or resync the
replication on the given
consistency group that was split
earlier. Also, this command should
be used to initiate a failback
resync.
This can be used to rejoin all the
volume replication pairs part of the
RG by specigying the RG name.
This command is used to convert a
synchronous replication pair to
operate in a High Availability
mode.
Asynchronous Replication
These commands configure asynchronous replication.
Command
create asyncreplica
Argument
-t/--type <sar/jar/hasar>
-n/--name <snap assisted replication name>
-f/--volumedialect
-a/--primarycontainer <primary contName>
-l/--primaryvolume <primary volName>
-i/--primaryip <primary host IP address>
-s/--secondarycontainer <secondary contName>
-r/--secondaryvolume <secondary volName>
-m/--secondaryip <secondary host IP>
-k/--hasecondaryip <HA secondary host IP> (Only
for HA-DR)
-z/--secsnapcount <secondary snap count>
-c/--compression <zlib compression
level>(optional)
-e/--encryption (optional)
-b/--dedup (optional)
-w/--wds <bandwidth in mbps> (optional)
Description
Creates a asynchronous replication
pair. Both the primary and
secondary volumes should be
present before this operation.
-u/--utilization <bandwidth utilization in
percentage>(optional only if wds enabled)
4) WDS mode is used only in Snap
Assisted Replication and HA-DR
Example: Single volume in CG
create -t sar -n name -f 1 -a c0 -l v0 -i
172.16.70.70 -s c1 -r v1 -m 172.16.70.153 -c 6 -z
10 -e asyncreplica
5) This command can be issued
only in the storage system that will
be the Primary.
Example: Multiple volumes in CG
create –t sar –n name -f 0 –a c0 -l v0 -l v1 -l v2
-i 172.16.70.70 –s c1 -r v0 –r v1 -r v2 -m
172.16.70.153 -153 -c 6 -z 10 -e asyncreplica
delete asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-f/--force(optional)
Example:
delete -n name -c c0 -d 1 asyncreplica
delete -n name -c c0 –d 1 -f asyncreplica
get asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name> (optional)
-s/--compressionstats (optional)
Example:
get -n name -c c0 -d 1 asyncreplica
list asyncreplica
-c/--containername <container name>
Note:
1) Volume Dialect
[0] - ISCSI
[1] – NAS
2) Compression Type
[0] – No compression
[1 - 9] – levels
3) secsnapcount can take values
between 1 to 1022
6) HA-DR (hasar) option can be
used only after HA is established
across all volumes of the DAR
(DR) group.
7) The HA secondary host IP is the
WAN IP of the HA pair which can
be reached from the SAR (DR)
secondary system.
Deletes the asynchronous
replication pair
-f/--force flag is optional and is
used where asynchronous
replication has to be deleted
forcefully
This command can be issued only
in the storage system that will be
the Primary.
Displays the asynchronous
replication details.
This command can be issued on
both Primary and Secondary
storage systems.
Lists available asynchronous
replication pairs in the given
Chapter Two: Command Set
33
Command
list asyncreplica
Argument
Example:
list -c c0 asyncreplica
-c/--containername <container name>
-n/--name <asynchronous replication name>
Example:
list -n name -c c0 asyncreplica
pause asyncreplica
Description
container.
This command can be issued on
both Primary and Secondary
storage systems.
Lists all the common snapshots (of
all volumes) in the asynchronous
replication pairs in the given
container.
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
This command can be issued on
both Primary and Secondary
storage systems.
Pauses the Asynchronous
replication until it is resumed by
resume cli.
Example:
pause -n name -c c0 –d 1 asyncreplica
This command can be issued in a
primary.
This command can be issued only
when the Asynchronous replication
has one of the following status
1. Paused
2. Idle
3. Active
4. Undefined
For all other status, this command
would return error.
resume asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
Example:
resume -n name -c c0 –d 1 asyncreplica
Resumes the Asynchronous
replication that was paused before.
This command can be issued in a
primary.
This command can be issued only
when the Asynchronous replication
has one of the following status
1. Paused
For all other status, this command
would return error.
failover asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
Example:
failover -n name -c c0 –d 1 asyncreplica
failbackjoin
asyncreplica
failback asyncreplica
Fails over the Asynchronous
replication to the secondary.
This command can be issued only
in the secondary.
-n/--name <asynchronous name>
-c/--containername <container name>
-d/--index <system assigned name>
Prepares the original primary of the
Asynchronous replication for
failback.
Example:
failbackjoin -n name -c c0 –d 1 asyncreplica
This command can be issued only
in the primary.
-n/--name <asynchronous replication name>
Fails back the Asynchronous
34 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Command
Argument
-c/--containername <container name>
-d/--index <system assigned name>
Example:
failback -n name -c c0 –d 1 asyncreplica
rollbackjoin
asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-s/--snapgrouptnum <t number>
-d/--index <system assigned name>
Example:
rollback -n name -c c0 –s 30 –d 1 asyncreplica
rollback asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-s/--snapgrouptnum <t number>
-d/--index <system assigned name>
Example:
rollback -n name -c c0 –s 30 –d 1 asyncreplica
update asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-i/--primaryip <primary host IP address>
-m/--secondaryip <secondary host IP>
-k/--hasecondaryip <HA secondary host IP>
-t/--primarymgmttgt <primary management target
name>
-z/--secsnapcount <secondary snap count>
-u/--secondarymgmttgt <secondary management
target name>
-g/--wds <wds {0/1}>
-w/--bwutilization <bandwidth utilization in
percentage>
-b/--bandwidth <bandwidth in mbps>
-f/--dedupe <deduplication {0/1}>
-y/--encryption <encryption {0/1}>
-o/--compression <compression level {0..9}>
Description
replication to the original primary.
This command can be issued only
in the original primary acting as a
secondary.
If the status is
FAILED_DUE_TO_ROLLBACK
after a Rollback on Primary, the
replication will continue after
issuing this command on the
primary to make the secondary
ready for resuming replication.
This command can be issued in a
primary.
Rolls back all the volumes of the
Asynchronous replication to a
particular set of snapshots.
This command can be issued in a
primary and/or secondary.
Update ‘priority’, ‘compression’,
‘primaryip, ‘secondaryip’,
‘hasecondaryip’
“primarymgmttgt”,
“secondarymgmttgt” fields.
Note:
1) Compression type
[0] - NO compression
[1-9] – Compression Levels
This command can be issued in a
primary.
Example:
update -n myname -d 1 -c Cont0 -o 2 –I
172.16.70.89 -m 172.16.70.90
-u iqn.199110.com.ami:itx00c09f2164459105:mtarget
-t iqn.199110.com.ami:itx00c09f2164459108:mtarget
-z 10 asyncreplica
update asyncreplica
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-f/--dedupe <deduplication {0/1}>
Update ‘deduplication’ field alone.
This command can be issued in a
primary.
Example:
update -n myname -d 1 -c Cont0 -f 1 asyncreplica
Chapter Two: Command Set
35
Command
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
update asyncreplica
add asyncreplica
Argument
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-z/--secsnapcount <secondary snap count>
Example:
update -n myname -d 1 -c Cont0 -z 200
asyncreplica
Description
Update ‘secondary snap count’
field alone.
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-w/--bwutilization <bandwidth utilization in
percentage>
Update ‘bandwidth utilization’
field alone.
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-b/--bandwidth <bandwidth in mbps>
Update ‘bandwidth’ field alone.
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-o/--compression {0-9}
Update ‘compression’ field alone.
-n/--name <asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-i/--primaryip <primary host IP address>
secsnapcount takes value between
1-1022
This command can be issued in a
primary.
This command can be issued in a
primary.
This command can be issued in a
primary.
Note:
1) Compression type
[0] - NO compression
[1-9] – Compression Levels
This command can be issued in a
primary.
Update ‘primaryip’ field alone.
This command can be issued in a
primary.
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-m/--secondaryip <secondary host IP>
Update ‘secondaryip’ field alone.
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-k/--hasecondaryip <secondary host IP>
Update ‘hasecondaryip’ field alone.
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-t/--primarymgmttgt <primary management target
name>
Update ‘primarymgmttgt’ field
alone.
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-u/--secondarymgmttgt <secondary management
target name>
Update ‘secondarymgmttgt’ field
alone.
-n/--name < asynchronous replication name>
-c/--containername <container name>
Add periodicity information for a
particular Asynchronous
36 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
This command can be issued in a
primary.
This command can be issued in a
primary of a HA-DR setup.
This command can be issued in a
primary.
This command can be issued in a
primary.
Command
Argument
-s/-- schedule>
-d/--index <system assigned name>
Description
Replication.
Note :
Example:
add -n myname -c Cont0 -s "0-24 0-7" -d 1
asyncreplica
add -n myname -c Cont0 -s "* 0-7" -d 1
asyncreplica
add -n myname -c Cont0 -s "0-24 *" -d 1
asyncreplica
add -n myname -c Cont0 -s "* *" -d 1 asyncreplica
1) The periodicity can be of one of
the following
a.“<start time>-<end time>
<start_day>-<end day>”
b.“<start time > <start_day>-<end
day>”
c.“<start time>-<end time>
<start_day>”
d.“<start time> <start_day>”
e.“ * *”
f.“ * <start_day>-<end day>”
g.“<start time>-<end time> *”
2) The ‘start time’ and ‘end time’
can take values from 0-24
representing the hour of the day
only.
3) The ‘start day’ and ‘end day’
can take values from 0-7
representing the day of the week
only.
4) ‘*’ indicates all hours of the day
or all days of the week based on its
position.
Note: The end_time and end_day
are not included. Meaning 15-16
means 1500-1559 Hours and 0-2
means Monday and Tuesday
5) A Maximum of 8 periodicity
information is allowed for
Asynchronous Replication pair
remove asyncreplica
-n/--name < asynchronous replication name>
-c/--containername <container name>
-s/-- schedule>
-d/--index <system assigned name>
6) This command can be issued in
a primary.
Remove periodicity information for
a particular Asynchronous
Replication.
Note:
Example:
remove -n myname -c Cont0 -s "0-24 0-7" -d 1
asyncreplica
1) The periodicity format should be
same as above.
remove -n myname -c Cont0 -s "* 0-7" -d 1
asyncreplica
2) This command can be issued in
a primary.
remove -n myname -c Cont0 -s "0-24 *" -d 1
asyncreplica
set asyncreplica
remove -n myname -c Cont0 -s "* *" -d 1
asyncreplica
-t/--type snap
-c/--containername <containername>
Sets the snapshot schedule for a
CG.
Chapter Two: Command Set
37
Command
enable asyncreplica
Argument
-n/--cgname <cgname>
-s/--schedulesnap
<scheduleduration:maxsnapshots>
-d/--description <description>
-b/--backuptargetname <backuptargetname>
-p/--scheduleType <0-Windows,1-Local>
Example:
set -t snap -c Cont0 -n mysar0 -s 5:10 -s 60:20 -d
testing -b backuptest -p 0 asyncreplica
-t hasar
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-i/--ip <other HA system IP>
Description
Enables HA-DR with the HA pair
system. IP addres should be the
WAN IP of HA pair that can be
reached from DR.
This command can be issued in a
primary of a HA-DR setup. Should
be used when HA was setup on an
existing SAR group.
update asyncreplica
-n/--name < asynchronous replication name>
-c/--containername <container name>
-d/--index <system assigned name>
-i/--ip <other HA system IP>
Removes the HA- DR setup on the
given IP. It must be the IP of the
HA pair. The HA pairing should
be removed after executing this
command.
This command can be issued in a
primary of a HA-DR setup.
38 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Journal Volume Management
These commands configure a journal and journal file.
create
journal
-t/--type journal
-j/--journalname <journalname>
-l/--ldname <ldname>
Creates journal.
Minimum LD size for journal
creation is 10GB
Example:
create -t journal -j jour0 -l /dev/sdb journal
create
journal
delete
journal
-t/--type journalfile
-j/--journalname <journalname>
-f/--journalfilename <journalfilename>
Example
create -t journalfile -j jour0 -f jf0 -z 10 -c cont1 -v
v1 -v v2 journal
-t/--type journal
-j/--journalname <journalname>
Creates journal file.
1)Minimum LD size for journal
creation is 10GB
Deletes journal
Example:
delete -t journal -j jour0 journal
delete
journal
-t/--type journalfile
-c/--containername <containername>
-f/--journalfilename <journalfilename>
Deletes journal file
Example:
delete -t journalfile -c cont0 -f jf0 journal
get
journal
-t/--type journal
-j/--journalname <journalname
Gets journal information
Example:
get
journal
get -t journal -j Jour0 journal
-t/--type journalfile
-c/--containername <containername>
-f/--journalfilename <journalfilename>
Gets journal file information
Example:
get -t journalfile -c Cont0 -f jf0 journal
get
journal
-t/--type journalfile
-c/--containername <containername>
-v/--volumename <volumename>
Gets journal file name for a
specific volume.
Example:
get -t journalfile -c Cont0 -v vol0 -v vol1 -v vol2
journal
get
journal
-t/ --type snaptable
-c/--containername <containername>
-f/--journal/CG name <journal/CG name>
Gets information for a specific
journal file snapshot.
Example:
Chapter Two: Command Set
39
get -t snaptable -c c0 -f cg0 -n 10 journal
list
journal
list
journal
list
journal
creategroup
journal
creategroup
journal
-t/ --type journal
List journal information.
-t/ --type journalfile
-c/--containername <containername
-t/ --type snaptable
-c/--containername <containername>
-f/--journal/CG name <journal/CG name>
List journal file information.
Example:
list -t snaptable -c containername -f cg0 journal
-t/--type snap
-s <contname:volumename:snapname>
-j <contname:journalfilename>
-d <volume_dialect>
Example: creategroup -t snap -s
c0:v0:Vsv0xxxxxxxxxxxxxxSchdL1RT -s
c0:v1:VsvixxxxxxxxxxxxxxSchdL1RT -j c0:jf0 -j
c0:jf1 -d 0 journal
-t/--type snap
-w
<contname:volumename:snapname:writsnapname>
-d <volume_dialect>
List information for a specific
journal file snapshot.
Creates group snapshot and post
event to journal
Creates group writeable snapshot
and post event to journal
Example:
creategroup -t snap -w
c0:v0:Vsv0xxxxxxxxxxxxxxSchdL1RT1:Vsv0xxx
xxxxxxxxxxxSchdL1WT1 -w
c0:v1:VsvixxxxxxxxxxxxxxSchdL1RT1:Vsvixxxx
xxxxxxxxxxSchdL1WT1 -d 0 journal
expand
journal
set
journal
-t/--type journal
-j/--journalname <journalname>
-l/--ldname <ldname>
Example:
expand -t journal -j jour0 -l /dev/sdc journal
-t/--type snap
-c/--containername <containername>
-j/--jfname <jfname>
-s/--schedulesnap
<scheduleduration:maxsnapshots>
-d/--description <description>
-b/--backuptargetname <backuptargetname>
-p/--scheduleType <0-Windows,1-Local>
Example:
set -t snap -c Cont0 -j mysar0 -s 5:10 -s 60:20 -d
testing -b backuptest -p 0 journal
40 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Expands journal.
1) Minimum LD size for journal
expansion is 10GB
Sets uniform scheduler settings in
journal file volumes.
Continuous Data Protection
These commands are to view cdp for journal file.
rollback
cdp
review
cdp
delete
cdp
get
cdp
-c/--container <containername>
-f/--journalfile <jfname>
Example:
rollback -c c0 -f jf0 cdp
-c/--container <containername>
-f/--journalfile <jfname>
-s/--basesnap <t-number>
-t/--deltatime <deltat from basesnap>
-i/--deltaio <delta IO from deltat>
-e/--eventindex <deltaevt from basesnap>
Example:
review -c c0 -f jf0 -s 1 -t 10 -i 54 cdp
review -c c2 -f jf1 -s 1 -e 15 cdp
-c/--container <containername>
-f/--journalfile <jfname>
Example:
delete -c c0 -f jf0 cdp
-t review
-c/--container <containername>
-f/--journalfile <jfname>
Performs rollback on journal file.
Performs CDP Review operation
for journal file.
1) -t and -i options ignored if -e is
specified
2) Delta time and IO must not be
specified for event review
Delete a currently existing CDP
session.
Gets CDP Review Progress
operation for journal file.
Example:
get -t review -c c0 -f jf0 cdp
Recovery Wizard
These commands are used as part of recovery wizard.
get recoverywizard
-c/--container <container name>
-v/--volume<volumename>
-x/--xml (optional)
-n/--tnum <writable snapshot number> (optional)
Get recoverywizard lists the snaps
that have common‘t’ number
across the given set of volume(s).
Example:
get -c c0 -v vol1 recoverywizard
get -c c0 -v vol1 -v vol2 -v vol3 -n 1 -x
recoverywizard
review
recoverywizard
-c/--container <container name>
-v/--volume<volumename>
-s/--snap<snapname>
-x/--xml (optional)
Example:
review -c c0 -v vol1 -s snapv1T1 recoverywizard
review -c c0 -v vol1 -v vol2 -v vol3 -s snap4v1T2
–s snap5v2T2 -s snap6v3T2 recoverywizard
Review recoverywizard activates a
set of snaps that have common ‘t’
number across the given set of
volume(s), adds them to a LUN
and enables them as a target to
which an initiator can login to
review the data.
Chapter Two: Command Set
41
remove
recoverywizard
-c/--container <container name>
-v/--volume<volumename>
-s/--snap<snapname>
-t/--tgt_name<tgt_name>
-x/--xml (optional)
Example:
remove -c c0 -v vol1 -s snap1 -t iqn.199110.com.ami:itx00c09f2164459105:t08212006tgt1
recoverywizard
rollback
recoverywizard
remove -c c0 -v vol1 -v vol2 -v vol3 –s snap4v1T2
-s snap5v2T2 -s snap6v3T2 -t iqn.199110.com.ami:itx00c09f2164459105:t08222006tgt2
recoverywizard
-c/--container <container name>
-v/--volume<volumename>
-s/--snap<snapname>
-x/--xml (optional)
Remove recoverywizard disables
the target enabled in the Review
recoverywizard, removes the set of
snaps that have common ‘t’
number across the given set of
volume(s) from the LUN, and
deactivates the snapshot.
Note:
1) All Snaps have same‘t’ number.
Rollback recoverywizard rollbacks
the set of volumes to set of
snapshots.
Note:
Example:
rollback -c c0 -v vol1 -s snap1 recoverywizard
rollback -c c0 -v vol1 -v vol2 -v vol3 –s
snap4v1T2 -s snap5v2T2 -s snap6v3T2
recoverywizard
1) All Snaps have same‘t’ number.
Storage Resource Management
These commands are used as part of SRM.
list srm
clear srm
start srm
stop srm
-q/--queue <workflow, pending, report>
-n/--num_tasks <number of tasks>
-o/--offset < offset in the queue >
-f/--filename <xml filename >
-x/--xml
Example:
list -q report -n 20 -o 5 srm
list -q pending -n 20 -o 5 srm
-q/--queue <workflow , pending, report >
-x/--xml
Example:
clear -q report srm
Example:
start srm
Example:
stop srm
42 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
List the tasks in report, pending
and workflow queue of the
SRM
Clears the SRM queues such as
workflow, pending, and report
Start the Storage resource
management activity. This is by
default started in the iTX box
Stop the Storage resource
management activity
Local and Replicated Snapshot validation
These commands are used as part of snap validation.
enable
snapvalidation
disable
snapvalidation
pause
snapvalidation
-t/--type local
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
Example:
enable -t local -c Cont0 -v Volume0 snapvalidation
-t/--type local
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
Example:
disable –t local -c Cont0 -v Volume0
snapvalidation
-t/--type local
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
This will enable local NAS snap
validation for the given NAS
volume. Once enabled, it will be
in “resumed” state by default –
meaning ALL scheduled snaps will
be validated, both already present
and those that will be created new.
This will disable local NAS snap
validation for already enabled NAS
volume.
This pause validation of NAS
snapshots for already enabled NAS
volume.
Example:
pause -t local -c Cont0 -v Volume0snapvalidation
resume
snapvalidation
-t/--type local
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
This will resume validation of
NAS snapshots for already paused
(enabled) NAS volume.
Example:
resume –t local -c Cont0 -v Volume0snapvalidation
get
snapvalidation
-t/--type local
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
Example:
get -t local -c Cont0 -v Volume0snapvalidation
list
snapvalidation
-t/--type local
-x/--xml
resume
snapvalidation
Example:
list -t local snapvalidation
-t/--type (SRP/HA)
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
Example:
resume -t SRP -c Cont0 -v Volume0 snapvalidation
resume -t HA -c Cont0 -v Volume0 snapvalidation
pause
snapvalidation
-t/--type (SRP/HA)
-c/--containername <containername>
This will return the status – paused
/ resumed of the given NAS
Volume for snap validation. It will
also return the list of snapshots that
are validated so far with the status
(passed / failed)
This will return the list of NAS
volumes that are enabled for NAS
snap validation, along with the
current status – paused / resumed.
This will resume replica validation
for the given volume or volumes
SRP/HA. The remote system
information will be taken from the
given replica pair itself, so no need
to add them separately.
SRP – Sync replica module
HA – High availablility module
Pauses the already running
SRP/HA replica validation of given
Chapter Two: Command Set
43
-v/--volumename<volumename>
-x/--xml
Example:
pause -t SRP -c Cont0 -v Volume0 snapvalidation
pause -t HA -c Cont0 -v Volume0 snapvalidation
get
snapvalidation
t/--type (SRP/HA)
-c/--containername <containername>
-v/--volumename<volumename>
-x/--xml
Example:
get -t SRP -c Cont0 -v Volume0 snapvalidation
get -t HA -c Cont0 -v Volume0 snapvalidation
resume
snapvalidation
-t/--type (CG)
-c/--containername<containername>
-n/--cgname <cgname>
-x/--xml
Example:
resume -t CG -c Cont0 -n CG1 snapvalidation
pause
snapvalidation
-t/--type (CG)
-c/--containername <containername>
-n/--cgname <cgname>
-x/--xml
set.
SRP – Sync replica module
HA – High availability module
This will return the status – paused
/ resumed as well as the list of
snapshots validated. For SRP/HA
with multiple volumes, the each
validated snap of each volume will
be returned.
SRP – Sync replica module
HA – High availability module
This will resume replica validation
for the given volume or volumes
CG. The remote system
information will be taken from the
given replica pair itself, so no need
to add them separately.
CG – Snap assisted replication
module
Pauses the already running CG
replica validation of given set.
CG – Snap assisted replication
module
Example:
pause -t CG -c Cont0 -n CG1 snapvalidation
get
snapvalidation
-t/--type (CG)
-c/--containername<containername>
-n/--cgname <cgname>
-x/--xml
Example:
get -t CG -c Cont0 -n CG1 snapvalidation
This will return the status – paused
/ resumed as well as the list of
snapshots validated. For CGs with
multiple volumes, the each
validated snap of each volume will
be returned.
CG – Snap assisted replication
module
44 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Appendix A
Code
0
1
2
3
4
5
6
10
11
12
13
14
15
20
21
22
23
24
25
26
27
31
32
33
34
35
36
37
38
40
41
42
43
44
45
46
47
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
68
69
Error Codes
Description
Command Succeeded
Command Failed
Invalid Parameter
Insufficient buffer
Insufficient memory
Invalid Operation
Error in opening file
User does not exist
User already exists
Selected user is a NIS user
User type did not match ADS NIS and LOCAL
User Count in UserList is not set
Invalid User ID
Group does not exist
Group already exists
Selected group is a NIS Group
Group Count in GroupList is not set
Group type did not match ADS, NIS and LOCAL
Invalid Group ID
Not able to init CLI command list
Not able to init CLI error list
Share does not exist
Share already exists
Path does not exist
Share does not exist
Invalid share count
Unable to create share entry
Unable to delete the share entry
Share operations not possible on iSCSI volumes
Read less number of event log records, than requested.
Event log database is full.
Event log database is Empty.
Event is not in list
Corrupted event list file
No Matching records were found.
Log database is Empty.
Read less number of records, than requested.
Volume does not exist
Volume already exists
Volume is busy. Retry later.
Disk is not available for use by the volume
Disk count is invalid for the requested raid level
Invalid Raid level
Volume is not ready or Volume does not exist
Raid Volume is a bootable volume
No Raid OS volume
Snapshot unsupported
Snapshot is inactive
Invalid Snapshot count
iSCSI Volume sync error
Snapshot is mounted
Readable snapshot cannot be mounted
Input has missing parameters
Input has excess parameters
Index
45
Code
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
90
91
92
93
94
95
96
97
98
99
110
111
112
113
114
115
116
117
118
119
120
121
122
150
151
160
161
162
163
164
165
166
167
168
169
170
171
172
174
Description
Null parameter
Invalid disk channel
Invalid Disk
Invalid Username
Invalid password
Invalid groupname
Invalid Network port
Invalid Path
Invalid Volume Name
Invalid share name
Invalid server name
Invalid member type
Invalid member count
Invalid access rights
Invalid address
Retry after system reboot
Invalid member name
Invalid service type
Invalid service status
Command is not processed
Command not supported
Reply packet is not good
Connection to Mstor Engine is lost
API is returned as success. but it got excess data than requested
Invalid payload size
Invalid host name
Invalid RPM name
Error in installing RPM
UPnP Share Does not exists
File open Error
User Operation busy
Unable to delete user
Unable to add group
Group operation busy
Unable to update user data
Unable to update group data
Invalid group ID
User ID already exists
Group ID already exists
Primary group error
Usergroup cache empty
Fewer members read
Group or Key does not exists in the file
Group already exists in the file
Error in initializing the health monitoring interface
Error in reading sensor value
Health monitoring SDK is not initialized
Path is used by other share
Record not found
Record addition failed
Record deletion failed
Record update failed
Entry not available
Error in getting container list
Volume list is NULL
Snapshot list is NULL
Entry addition failed
Error in setting ACL recursively
46 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Code
175
200
201
202
203
204
205
220
230
231
232
233
234
235
240
241
250
251
252
253
254
260
261
262
263
264
265
266
267
268
270
280
281
282
290
291
292
293
300
301
302
303
304
305
306
307
310
311
312
320
330
331
332
333
334
335
336
337
Description
Error in mounting the share
Upgrade version error
Upgrade package already installed
Upgrade package dependency failure
Upgrade package installation failed
Upgrade requires more disk space
Invalid package name
Error in upgrade operation
Duplicate IP address
Invalid IP address
Invalid subnet mask
Invalid gateway
Invalid DNS server
Failed to set IP
Disks are differing in geometry
The partition of the disks differ
Raid Device is busy with resync or rebuild
Directory is shared
Error in deleting directory
Error in creating directory
Directory operations are not possible on ISCSI volumes
Invalid IPX internal network number
Invalid IPX external network number
Invalid IPX frame type
Invalid CIFS workgroup
Invalid SNMP Trap Destination
Invalid SNMP community
Invalid domain name
Duplicate SNMP Trap Destination
Duplicate Email ID
ACL database error
Error_net_join
ADS domain already exists
NIS domain already exists
Invalid time
Invalid date
Sync to NTP fail
Invalid time zone
Invalid network team mode
Invalid network team member
Invalid network team name
Network team already exists
Network adapter part of team
Invalid network team deletion order
Prerequisite not met
Network team does not exist
Invalid Rule Index
Rule limit exceeded
Rule Already exists
EVMS API General Failure
Invalid License File
Error in trying to update Evaluation License over existing Extended License
Incompatible License according to the Product Type
Invalid Customer ID
Invalid version
Invalid license features
License General error
License file open error
Index
47
Code
338
350
351
352
353
354
355
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
550
551
552
553
554
555
556
557
558
559
560
561
562
601
603
604
605
606
607
608
609
Description
License file read write error
Duplicate Alias Name
Alias not found
Invalid Alias Name
DHCP is not supported for Alias Adapters
Maximum Alias Adapter count exceeded
Maximum Alias per NIC exceeded
No Target found
Object Not Found
Internal error
Limits exceeded for operation
Object does not have date
iSNS status returned
iSNS task error
Cannot communicate with iSNS daemon
Internal iSNS error
iSNS server signals error
iSNS object not found
iSCSI Service not running
Invalid Target name
iSNS service not running
Current operation failed as it needs iSCSI to be enabled on this Volume
Password for this user has to be between 12 and 16 characters
ISCSI Disk still in use
Too many ISNS servers
ISNS Server error
Cannot perform this operation; there are no iSNS servers
Unknown iSNS error
Cannot remove ISNS server, an operation is in progress
LUN serial number error
Error in loading SMA module
Error in unloading SMA module
Maximum number of LUNs/Volumes has been reached for this target
Cannot add NAS volume to target
Deactivate portal to change portal tag
LUN had been already added to target
Invalid LUN
Invalid Disk Selection
Invalid RAID Number
No RAID is Present
Invalid RAID Level
Invalid Cache Type
Invalid Disk Count for the RAID Level
Invalid Spare Disk Count
Invalid Disk Information
Selected array is part of Volume...Cannot be deleted
RAID Disks cannot be used as Spares
Size of Raid Array is greater than 2 TB
Distributed Spares is not supported in RAID0, RAID1 and RAID1n
Rebuild failed
Invalid controller
Function not supported
Null Controller list
Function not supported
Spare disk unsupported
Disk count limit exceeded
Error in initializing disk
IOCTL failure
48 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Code
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
631
632
633
634
635
636
637
638
639
640
642
643
644
645
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
Description
No spare support
Max limit reached
No MD device available
MD creation failed
Add entry to configuration file failed
disk is not free
Minimum disk count
Error in updating configuration file
Error in reading from configuration file read error
Raid hot remove failed
Disk partitioning failed
Raid hot add failed
No raid array found
OS raid device error
Swap raid device error
Device open Error
Error raid creation in progress
Invalid Sub raid disk count
Error on transforming offline raid
Invalid raid number
Invalid spare disk count
Illegal spare type
Invalid raid cache type
Invalid raid drive size
Maximum raid size
Insufficient disk space
Raid cannot be shrunk
API failure
Disk is not a Spare
Var Log device error
LD Create & Expand/Transform not supported while another LD Expand/Transform is in progress
LD Expand/Transformation is in progress, not able to change the configuration
Battery Not Available
Cache type is not supported by the controller
Container count limit exceeded
FileSystem error
Volume creation error
DM mount error
Delete container error
Create container error
Duplicate device error
Volume Deletion error
DM umount error
NAS Volume freeze error
NAS Volume unfreeze error
Start Container failed
Stop Container failed
Invalid LD Device
Invalid Container chunk size
Resource is busy
Error in getting container info
Invalid Container name
Error in deactivating snap
Error in activating snap
Error in creating snap
Error in deleting snap
Error in mounting volume
Error in unmounting volume
Index
49
Code
725
726
727
728
729
730
731
732
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
760
800
801
802
803
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
Description
Error in mounting file system
Error in getting snap info
Error in creating writable snap
Error in getting volume info
Max space reached
Invalid dialect
Invalid Snap
Error in rolling back Snap
Error in unmounting file system
Error in reading metadata
Serial already exists
Invalid mount type
Quota operations not possible on iSCSI volumes
Snapshot already activated
Snapshot already deactivated
Maximum volume count limit reached
Error in resizing the volume
Unsupported option
Error in DM reload
FileSystem growth failure
Volume already activated
Volume already deactivated
DMsetup info error
No space left in container
Permission denied
Session not found
Max user session limit
Max session limit
Management administrator not found
Maximum management stations configured
No free space to expand
Volume expansion limit exceeded
Read only snapshot count exceeded
Read write snapshot count exceeded
License – Read only snapshot count exceeded the license count
License – iSCSI volume license expired/disabled
License - SAS hard disk license expired/disabled
License – SATA hard disk license expired/disabled
License - Enclosure count exceeded/disabled
License - NAS volume license expired/disabled
License - Container size exceeded the license limit
License - Invalid License Key
License - License Structure is missing or License is absent
License - Service key is missing
License - Updation of Evaluation time failed
License - Limit on the particular feature is reached
License - Time for the particular feature usage expired or disabled
License - License Structure is corrupted
License - Temp file creation failed
License - Incorrect License for the System
License - Error Copying files
License - License File Decryption Failure
License - License File Encryption Failure
License - Setting License Failure
License - License Key is absent, License Module is not loaded.
License - Incorrect System for the License Key
Error in WINBIND
Error in YPBIND
50 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Code
876
877
878
879
880
881
882
883
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
Description
Error in BIND
License - HA pair creation license expired/disabled
License - Unable to Read the License File
License - License Validation Failure
License - New Motherboard or New Motherboard with Some External NIC cards found, For service key
generation, remove all External NIC cards from the system
License - Thin provision license expired/disabled, request denied.
License - ILM license expired/disabled, request denied.
License - Applying Old License File Again, request denied.
Replication is enabled
Incorrect Replication
Replication is enabled, secondary volume present in container
Replication is enabled, replication pair non-operational
Resource group is not owned
Resource group already started
Resource group is out of sync
Unable to get resource group information
Invalid resource group state
Machines chosen for HA are not identical
Subnet does not match in machines. All NICS should be on different subnets
Remote Resource group not accessible
Unable to set virtual ipaddress
Maximum of 1 Alias per NIC per RG exceeded
Primary Target Name already used for a different volume in secondary
Error in regenerating target name
Portal is inactive in Local/Remote
Replication command timed out on the remote box due to it being busy
No Target found for volume either in Primary/Secondary
Replication – Operation not permitted on Secondary
Replication - General error
Replication - Invalid parameters
Replication - Insufficient memory for performing the operation
Replication - Permission denied
Replication - system busy
Replication - Fatal error
Replication - Master Logical drive NOT available
Replication - Volume error
Replication - Volume size error
Replication - iSCSI target serial number error
Replication - Error while accessing Container DDF
Replication - Error while accessing Replication DDF
Replication - Initiator error
Replication - Remote device error
Replication - Error while accessing tab bits
Replication - iSCSI login error
Replication - Error while activation
Replication - Remote Volume device NOT found
Replication - Remote Management device NOT found
Replication - Sync replication feature is not licensed or time period expired
Replication - Error in establishing MPIO Session: Please check if secondary or link to it is alive, and it's
portal is activated
Replication - Error in creating HA Pair. Volume is part of a SAR pair
Replication - Resource group count exceeded
Replication - Resource group already present
Replication - Resource group not present
Replication - Failed to modify the resource group config
Replication - Resource group entry not present
Replication - Duplicate entry present in resource group config
Index
51
Code
1029
1030
1031
1032
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1130
1131
1132
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1250
1300
1301
1302
1303
1304
1305
Description
Replication - Volume is not in sync
Replication - Box owns RG but volumes are secondary
Replication - Box is not the orignal owner of the RG
Replication - Box does not own RG but volumes are primary
Asynchronous Replication – Asynchronous Replication CG not found
Asynchronous Replication – General Failure
Asynchronous Replication – Duplicate Asynchronous Replication CG name
Asynchronous Replication – Volume already part of Asynchronous Replication CG name
Asynchronous Replication – Invalid Volume size
Asynchronous Replication – Invalid Asynchronous Replication CG role
Asynchronous Replication – Invalid volume count
Asynchronous Replication – Volume not empty
Asynchronous Replication – IOCTL error
Asynchronous Replication – Error in Handshake
Asynchronous Replication – Maximum CG reached
Asynchronous Replication - Invalid opertion - replication not yet started - No valid snaps found
Asynchronous Replication - CG config metadata area is corrupted
Asynchronous Replication - Error in getting passive side CG info
Asynchronous Replication - Error in getting passive side CG list
Asynchronous Replication - Error in updating passive side CG info
Asynchronous Replication - Error in passive side resume operation
Asynchronous Replication - Error in passive side pause operation
Asynchronous Replication - No common T number snapshot found
Asynchronous Replication - Given T number snapshot info not available
Asynchronous Replication - Given volume already part of another CG
Asynchronous Replication - Remote machine unavailable
Asynchronous Replication - Invalid Remote machine CG info
Asynchronous Replication - Active volumes already paired with another SAR CG in this remote box
Asynchronous Replication - Volumes having different scheduler settings
Asynchronous Replication - Invalid Volume Chunk Size
Asynchronous Replication - Unable to get the initiator name
Asynchronous Replication - Unable to get mtarget name
Asynchronous Replication - Minimum snapshot retention should be more than 3 per level
Asynchronous Replication - Volume part of synchronous replication or HA grouping
Asynchronous Replication - Invalid configuration
JM – Failed to create Journal
JM – Journal File count limit exceeded
JM – Failed to create Journal File
JM – Error in getting Journal info
JM – Error in starting Journal
JM – Error in stopping Journal
JM – Invalid Journa Name
JM – Journal Count limit exceeded
JM – Failed to delete Journal
JM – Journal Event Failed
JM – Failed to expand Journal
JM – Failed to delete Journal File
JM – Error in getting Journal File Name
Invalid T number
JM – Journal in use
JM – JournalFile size exceeded the Free Space available in Journal
JM – Reached EOF
Snap Validation – Info file creation error
Snap Validation – Already paused
Snap Validation – Already resumed
Snap Validation – Config file creation error
Snap Validation – Block Dedupe enabled
Snap Validation – Remote side snapshot not available
52 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Code
1306
1307
1308
1325
1326
1327
1345
1351
1352
1353
1354
1355
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1504
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
2001
2002
2003
2004
2005
2006
2010
2011
2012
2013
2014
2015
2016
2017
4096
4097
4098
Description
Snap Validation – Local snapshot not available
Snap Validation – User snapshot validation pending
Snap Validation – Snapshot already validated
Read only snap count max reached
Snap count per volume max reached
Snap count per system max reached
Duplicate Frequency/Level entered for Snapshot Schedule
iSCSI MirrorConfig – Physical disk size mismatch found
iSCSI MirrorConfig – Invalid physical disk mapping found
iSCSI MirrorConfig – Hotspare creation failed
iSCSI MirrorConfig – Logical drive creation failed
iSCSI MirrorConfig – Container creation failed
CDP – General error
CDP – Invalid parameter
CDP – Invalid Journal file name
CDP – Invalid Container name
CDP – Journal not present
CDP – Failed to open resource
CDP – Snapshot not available
CDP – Memory constraint
CDP – Snapshot not available in Journal
CDP – CDP session for given parameters not available
CDP – Failed to renew CDP session
CDP – Event missing in Journal file
CDP – Thread creation error
CDP – Journal file overflow error
CDP – Snapshot is in unstable state
CDP – Failed to read from journal file
Upgrading packages failed
Upgrade Checksum failed
Upgrade error in downloading image
Upgrade image version is older than current version
Upgrade image version is same as current version
Insufficient disk space for upgrade
Upgrade image file is corrupted
Error in performing upgrade
Invalid parameters in upgrade
Upgrade image version is invalid
License is not valid for upgrade
Invald IP address or Host name
Error in performing upgrade
Remote Communication - General Error
Remote Communication - Invalid Parameters
Remote Communication - Insufficient memory for performing the operation
Remote Communication - Permission Denied
Remote Communication - Management Target Busy
Remote Communication - Fatal Error
Remote Communication - Invalid Packet Signature
Remote Communication - Version Error
Remote Communication - No such remote module
Remote Communication - Connection Error
Remote Communication - Inter-node Initiator error
Remote Communication - Login Error
Remote Communication - Module Connection Error
Remote Communication - Remote Device Error
DVM - Lib node open error
DVM - Lib invalid data
DVM - Device End of file
Index
53
Code
4099
4100
4101
4102
4103
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8236
Description
DVM - Device open error
DVM - Device access error
DVM - general error
DVM - Lib DM suspend error
DVM - Lib DM resume error
DVM - generic error
DVM - memory allocation errors
DVM - IOCTL Parameter passing failures copy_from_user, copy to user etc
DVM - generic invalid parameter error
DVM - container name is empty / unrecognizable by DVM driver
DVM - volume is empty / unrecognizable by DVM driver
DVM - snapshot name is empty / unrecognizable by DVM driver
DVM - Error persisting metadata to disk (or) reading metadata from disk
DVM - The number of LD segments is invalid
DVM - The stripe size for the LD segments is invalid
DVM - Duplicate container name
DVM - Too many containers in the system
DVM - Failed to open the LD segment
DVM - volume size specified container
DVM - invalid provisioning type specified
DVM - snap type specified is invalid
DVM - invalid UUID specified
DVM - duplicate volume name specified
DVM - duplicate volume UUID specified
DVM - too many volumes in the system
DVM - cannot create exact provisioned volume - No space available
DVM - when trying to take a snap of snapshot - assumes writ. snapshot is another ioctl
DVM - duplicate snap name
DVM - too many snaps in the volume or a writable snapshot already exists
DVM - too many snaps in the system
DVM - if the ld segment length is invalid
DVM - when trying to take a "writable" snap of volume
DVM - volume is in use
DVM - snap is in use
DVM - snap rollback bg fail
DVM - compaction bg fail
DVM - compaction already running
DVM - cannot pause compaction
DVM - cannot stop compaction
DVM - log fail
DVM - Container couldn't start, conflicts in vol-index with existing container-volumes
DVM - Obsolete command
DVM – Redundant Snapshot
DVM - Operation failed on invalidated snapshot
DVM – Invalid Pinned Volume
DVM – Pinned Volume exists
DVM – Source & Dest Volume size mismatch
DVM – Destination Volume is not empty
DVM - No events
54 StorTrends® iTX Software CLI (Command Line Interface) (Version 2.7) User’s Guide
Download PDF

advertising