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 Created iTX 2.1 CLI document.
02/16/06 iSCSI Tape command added.
02/16/06 UPS driver config command added.
02/23/06 Synchronous replication commands added.
06/20/06 Volume and Snapshot commands updated.
06/21/06 Synchronous replication, iSCSI configuration updated.
06/23/06 Document is revised and examples are added.
07/14/06 General Server configuration section updated.
07/27/06 Updated for version 2.5.1011 and above.
08/17/06 Added Error Codes section.
04/26/07 Changed the volume chunk size.
04/26/07 Added the SRM commands.
06/28/07 Removed Tape commands.
01/16/09 Updated document and added journal and cdp commands.
12/11/09 Update the network command usage and CLI error text
01/25/10 Updated the OS Agnostic HA related commands and CLI error text
01/25/10 Updated Network Alias commands
01/25/10 Updated the iSCSI commands and corrected wrong format updation
03/30/10 Corrected the Create Volume usage and Get Eventlog Usage.
04/11/10 Update the create replication commands
06/07/10 Corrected the output of ‘cli main’.
06/07/10 Removed the term apple
06/07/10 Corrected set -t nfs command.
06/07/10 Corrected set raid commands.
06/07/10 Added available cache options for create raid.
06/07/10 Since alarm and cache is supported for set raid; the ‘not supported’ was removed.
06/07/10 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
Overview of CLI ......................................................................................................................................... 1
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
General Server Configuration .................................................................................................................. 13
Health Configuration ................................................................................................................................ 13
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… Then…
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,
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/
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.
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.
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.
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
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:
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.)
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.
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>
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
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 Argument Description
set timezone -z/--zone <zone name>
-x/--xml
For example: set –z America/New_York timezone
get timezone For example: get timezone Shows the configured time zone.
set datetime -n/--ntp <FQDN of NTP server or ipaddress> Configures the NTP server to be
get timezone -c/--count Gets the number of time zones.
set datetime -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
list timezone For example: list timezone Lists the time zones supported.
get datetime For example: get datetime Shows the date & time.
Sets the time zone of StorTrends®
iTX to given time zone.
used for time synchronization.
Sets the date and time to given
values.
Domain Configuration
These commands configure the domain server to be used for authentication.
Command Argument Description
get domain -t/--type {nis/ms}
-x/--xml
For example: get –t nis domain
set 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
set domain -t/--type {ms}
-m/--mtype {wg}
-d/--domain< domainname>
-x/--xml
For example: set -t ms -m wg -d MYGROUP
domain
set 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
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.