Command Line Interface: User's Guide

Command Line Interface
User’s Guide
for Adaptec OnTarget™-Powered Snap Servers
COPYRIGHT
Copyright © 2007, Adaptec, Inc. All rights reserved worldwide.
Information in this document is subject to change without notice and does not represent a
commitment on the part of Adaptec or any of its subsidiaries. The software described in this document
is furnished under a license agreement. The software may be used only in accordance with the terms
of the license agreement. It is against the law to copy the software on any medium. No part of this
manual may be reproduced or transmitted in any form or by any means, electronic or mechanical,
including photocopying and recording, for any purpose without the express written permission of
Adaptec, Inc.
TRADEMARKS
Adaptec, the Adaptec logo, Adaptec OnTarget, Storage Manager, Snap Server, the Snap Server logo,
GuardianOS, SnapOS, and Snap Disk are trademarks or registered trademarks of Adaptec, Inc. in the
U.S.A. and other countries.
Products mentioned herein are for identification purposes only and may be registered trademarks or
trademarks of their respective companies. Microsoft, Windows, Windows Vista, Internet Explorer,
and Active Directory are registered trademarks of Microsoft Corporation. Java and Solaris, are
registered trademarks of Sun Microsystems, Inc. Netscape is a registered trademark of Netscape
Communications Corp. AppleShare, AppleTalk, Macintosh, and MacOS are registered trademarks of
Apple Computer. BakBone and NetVault are trademarks of BakBone Software. AIX is a registered
trademark of IBM Corporation. OpenView and HP-UX are trademarks or registered trademarks of
Hewlett-Packard Company. BrightStor, Unicenter TNG, ARCserve, eTrust, and Unicenter are
trademarks or registered trademarks of Computer Associates, Inc. Smart UPS and APC are registered
trademarks of American Power Conversion Corporation. UNIX is a registered trademark of The Open
Group. XFS is a trademark of Silicon Graphics, Inc. Backup Exec, VERITAS NetBackup
BusinessServer, and VERITAS NetBackup DataCenter are trademarks or registered trademarks of
VERITAS Software Corporation. Legato NetWorker is a trademark of Legato Systems, Inc. Linux is a
registered trademark of Linus Torvalds. SCO Open Server and UnixWare are trademarks of the SCO
Group. StorAssure is a registered trademark of Adaptec, Inc. All other brand names or trademarks are
the property of their respective owners.
REVISIONS
Adaptec, Inc. provides this publication “as is” without warranty of any kind, either express or
implied, including but not limited to the implied warranties of merchantability or fitness for a
particular purpose. Adaptec and its subsidiaries reserve the right to revise this publication and to
make changes in the content hereof without the obligation of Adaptec to notify any person of such
revision or changes.
ADAPTEC, INC. SOFTWARE LICENSE AGREEMENT
CAREFULLY READ THE FOLLOWING TERMS AND CONDITIONS. BY YOUR USE OF THE SOFTWARE
INCLUDED WITH THIS PRODUCT, YOU AGREE TO BE BOUND BY THESE TERMS, CONDITIONS, AND
REQUIREMENTS. IF YOU DO NOT AGREE TO THE LICENSE TERMS, CONDITIONS, AND REQUIREMENTS
APPLICABLE TO THE SOFTWARE, YOU ARE NOT PERMITTED TO USE THE SOFTWARE AND MAY
RETURN THE ENTIRE UNUSED HARDWARE PRODUCT FOR A FULL REFUND. THESE TERMS,
CONDITIONS, AND REQUIREMENTS DO NOT APPLY TO ANY OPENSOURCE SOFTWARE, WHICH MAY
BE DELIVERED TOGETHER WITH THE ADAPTEC PRODUCTS, EXCEPT FOR THE PROVISIONS SET FORTH
IN SECTION 7 AND 9 BELOW.
In return for acquiring a license to use the Adaptec software ("Software") and the related documentation, you
agree to the following terms and conditions:
1. License. This Agreement grants you, the Licensee, a license to:
• Use the Software on a single computer system or on multiple workstations, systems and servers which
incorporate an Adaptec Hardware product and may be accessed by multiple users from multiple locations.
You may make as many installations of the Software as needed, but must restrict such installation only to
systems, workstations or servers using an Adaptec hardware product.
• Make one copy of the Software in machine readable form solely for back-up purposes provided you repro-
duce Adaptec’s copyright notice and any proprietary legends.
2. Restrictions. You may not distribute copies of the Software to others. You may not post or otherwise make
available the Software, or any portion thereof, in any form, on the Internet. You may not use the software in a
computer service business, including in time sharing applications. The Software contains trade secrets and in
order to protect them you may not decompile, reverse engineer, disassemble, or otherwise reduce the Software
to a human perceivable form. YOU MAY NOT MODIFY, ADAPT, TRANSLATE, RENT, LEASE, LOAN,
RESELL FOR PROFIT, DISTRIBUTE OR CREATE DERIVATIVE WORKS BASED UPON THE SOFTWARE OR
ANY PART THEREOF.
3. Ownership. As Licensee, You own the media upon which the Software is recorded or fixed, but Adaptec and
its licensors retain title, ownership and intellectual property rights of the Software recorded on the original
media and all subsequent copies of the Software, regardless of the form or media in which or on which the
original and other copies may exist. This license is not a sale of the Software or any copy. The Software is
copyrighted by, proprietary to and a trade secret of Adaptec or its licensors. The Software is protected by the
copyright laws of the United States and international copyright treaties.
4. Termination. This license is effective until terminated. This license will terminate automatically without notice
if you fail to comply with any of the provisions. You may terminate the license at any time by destroying the
Software (including the related documentation) together with all copies or modifications in any form. Upon
termination you shall destroy all copies of the Software (including the related documentation), together with
any partial copies.
5. Limited Warranty. Adaptec and its Licensors warrant only that the media upon which the Software is
furnished will be free from defects in material or workmanship under normal use and service for a period of
thirty (30) days from the date of delivery to you. THE FOREGOING WARRANTY EXPRESSLY EXCLUDES
ANY OPEN SOURCE SOFTWARE PROVIDED TO YOU WITH THE ADAPTEC SOFTWARE. ADAPTEC
AND ITS LICENSORS DO NOT AND CANNOT WARRANT THE PERFORMANCE OR RESULTS YOU MAY
OBTAIN BY USING THE SOFTWARE, OPEN SOURCE SOFTWARE OR DOCUMENTATION. EXCEPT FOR
THE FOREGOING LIMITED WARRANTY, ADAPTEC AND ITS LICENSORS MAKE NO WARRANTIES,
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED, AS TO NON-INFRINGEMENT OF THIRD
PARTY RIGHTS, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not
allow the exclusion of implied warranties or limitations on how long an implied warranty may last, so the
above limitations may not apply to you. This warranty gives you specific legal rights and you may also have
other rights which vary from state to state.
The entire liability of Adaptec and its licensors, and your exclusive remedy for a breach of this warranty, shall
be the replacement of any media not meeting the above limited warranty which is returned to Adaptec; or if
Adaptec or its distributor is unable to deliver replacement media which is free from defects in materials or
workmanship, you may terminate this Agreement by returning the Software and your money will be
refunded.
THE FOREGOING STATES THE SOLE AND EXCLUSIVE REMEDIES ADAPTEC AND ITS LICENSORS
WILL PROVIDE FOR BREACH OF WARRANTY.
6. Limitation of Liability. IN NO EVENT WILL ADAPTEC OR ITS LICENSORS BE LIABLE TO YOU FOR ANY
INCIDENTAL, CONSEQUENTIAL OR INDIRECT DAMAGES, INCLUDING ANY LOST PROFITS, LOST
SAVINGS, OR LOSS OF DATA, EVEN IF ADAPTEC OR A LICENSOR HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES, OR FOR ANY CLAIM BY ANY OTHER PARTY. IN NO EVENT WILL
ADAPTEC BE LIABLE UNDER THIS AGREEMENT FOR ANY AMOUNT IN EXCESS OF THE LICENSE
FEES YOU PAID FOR THE SOFTWARE OR, IF THE SOFTWARE WAS FREE, IN AN AMOUNT IN EXCESS
OF THE AMOUNT PAID BY YOU FOR THE HARDWARE SOLD IN CONJUNCTION WITH THE
SOFTWARE. Some states do not allow the exclusion or limitation of special, incidental, or consequential
damages, so the above limitation or exclusion may not apply to you.
7. Export. You acknowledge that the laws and regulations of the United States restrict the export and re-export of
the Software and/or the Open Source Software. Further, you agree that you will not export or re-export the
Software and/or the Open Source Software or media in any form without the appropriate United States and
foreign government approval.
8. U.S. Government Restricted Rights. If the Software is acquired under the terms of a GSA contract, use,
reproduction or disclosure is subject to the restrictions set forth in the applicable ADP Schedule contract. If the
Software is acquired under the terms of a DoD or civilian agency contract, use, duplication or disclosure by the
Government is subject to the restrictions of this license in accordance with 48 C.F.R. 12.212 of the Federal
Acquisition Regulations and its successors and 48 C.F.R. 227.7202-1 of the DoD FAR Supplement and its
successors.
9. Open Source Software. Certain programs distributed in conjunction with the Software may be distributed
subject to third party licensing terms, including without limitation, the GNU General Public (“GPL”) License
available at: http://www.gnu.org/licenses/gpl.txt or by writing to the Free Software Foundation, Inc., 59
Temple Place, Suite 330, Boston, MA 02111-1307 USA. The source code for the programs licensed under the
GPL is available to You, for a period of three (3) years from the date of first commercial distribution of the
Software, upon request by contacting Adaptec in writing at 691 South Milpitas Boulevard, Milpitas, California
95035, ATTN: Legal Department, Open Source Request. Adaptec will only charge you the actual cost of the
medium used to distribute the source code for these programs and the cost of shipping. More details regarding
the open source software and the applicable open source licenses are available in the README files.
10. Export Compliance. Each party agrees that the Software is subject to the U.S. Export Administration Act and
Export Administration Regulations, as well as applicable import and export regulations of the countries in
which each party transacts business. Each party shall comply with such laws and regulations, as well as all
other laws and regulations applicable to the Software. Each party agrees that it will not export, re-export,
transfer or divert any of the Software to any country for which United States' laws or regulations require an
export license or other governmental approval, without first obtaining such license or approval, nor will each
party export, re-export, transfer or divert any of the Software to any restricted place or party in accordance
with U.S. export regulations.
11. General. You agree this is the complete agreement concerning this license. In order to amend this license, a
writing executed by both parties is required. You assume full responsibility for the legal and responsible use of
the Software. This license shall be governed by California law as such law applies to agreements between
California residents entered into and to be performed within California, except as governed by Federal law.
Should any provision of this license be declared unenforceable in any jurisdiction, then such provision shall be
deemed to be severable from this license and shall not affect the remainder hereof. All rights in the Software
not specifically granted in this license are reserved by Adaptec.
Should you have any questions concerning this license, contact:
Adaptec, Inc.
Legal Department
691 South Milpitas Boulevard
Milpitas, California 95035
(408) 957-1718
Contents
Preface ..................................................................................... 1
About this Guide....................................................................................1
The CLI and Adaptec Storage Manager ...................................................1
Finding More Information ......................................................................2
Service and Technical Support ................................................................2
Chapter 1 Accessing the CLI ................................................................................ 3

Using a Terminal Emulation Program.......................................................3
Using Telnet...........................................................................................3
Access Levels and Passwords ..................................................................4
Chapter 2 Working in the CLI .............................................................................. 7

About the Main Mode and Functional Contexts ........................................7
Getting Help..........................................................................................8
About Case-sensitivity and Spaces ..........................................................8
Viewing Long Lists or Reports..................................................................8
Using the Tab Key to Complete Commands..............................................9
Abbreviating Commands........................................................................9
Command Line Editing ...........................................................................9
Leaving a Context and Exiting the CLI ....................................................10
Chapter 3 Commands and Parameters .............................................................. 11

Terminology Used in This Chapter .........................................................11
How this Chapter is Organized.............................................................11
About the Command Format in This Chapter..........................................12
Administrator Command ......................................................................13
Snap Server 700i User’s Guide 1

Clone Commands ................................................................................13
Device Commands ...............................................................................15
Diagnostics Commands ........................................................................17
Events Commands................................................................................19
Help Command ...................................................................................23
Image Commands................................................................................24
Initiator Commands..............................................................................26
Interface Commands ............................................................................29
iSNS Commands .................................................................................35
License Commands ..............................................................................35
Logical (Device) Commands..................................................................36
Network Commands ............................................................................44
Operator Command ............................................................................46
Password Command ............................................................................46
Pool Commands ..................................................................................47
Quit Command....................................................................................56
Route Commands.................................................................................56
Service Info Command .........................................................................58
Setup Command ..................................................................................58
Show Command ..................................................................................59
Snapshot Commands ...........................................................................59
System Commands...............................................................................63
UPS Commands...................................................................................67
Appendix A Using the Wizard to Configure Your iSCSI Storage Appliance .......... 71
Before You Begin .................................................................................71
Working in the Setup Wizard ...............................................................72
Configuring Your iSCSI Storage Appliance ............................................72
2 Snap Server 700i User’s Guide

Appendix B Updating the Adaptec OnTarget Operating System ..........................75
Uploading a New Image...................................................................... 75
Checking the Current Image ................................................................. 76
Reverting to the Previous Image ............................................................ 77
Chapter C Command Tree..................................................................................79
3
4 Snap Server 700i User’s Guide
Preface
The Command Line Interface (CLI) software is a terminal-based command line

interface that allows you to monitor and manage your Snap Server 700i Series iSCSI
Storage Appliance.
Note If you are a novice command line user, Adaptec highly recommends that you
manage your iSCSI Storage Appliance with the Adaptec Storage Manager software
(included with the appliance) instead of the CLI. For more information, or to
download the latest version of Adaptec Storage Manager, refer to the Adaptec Web
site at www.adaptec.com.
About this Guide

This User’s Guide introduces the CLI, provides instructions for navigating the CLI
and structuring commands, and describes the commands and parameters available.
It also provides example commands when they’re helpful for clarity.
Additionally, this Guide provides a top-level list of all commands for easy reference.
See “Command Tree” on page 79.
The appendices of this Guide provide step-by-step instructions for completing the
initial set-up of your iSCSI Storage Appliance and for updating the Adaptec
OnTarget operating system.
Notes and Cautions

This Guide uses these conventions to call out useful or important information:
Note A note presents time-saving shortcuts and other information related to the
main topic.
Caution A caution alerts you to potential hardware or software issues or hazards in
the configuration or operation of your iSCSI Storage Appliance. Consider cautions
carefully before proceeding with any operation.
The CLI and Adaptec Storage Manager

The CLI and Adaptec Storage Manager (the storage management software that was
included with your iSCSI Storage Appliance) occasionally differ in terminology and
other types of information.
• Adaptec Storage Manager uses a disk drive’s World Wide Name (WWN), the CLI
uses the disk drive's device ID for drive numbering.
• Separate status PDU (Adaptec Storage Manager) and Piggybacking of SCSI status
(CLI) both refer to the same advanced iSCSI initiator setting.
Command Line Interface User’s Guide 1
Finding More Information
Finding More Information

Product documentation related to the Adaptec OnTarget-powered Snap Server 700i
Series is listed below. The current versions of all these documents are always
available from http://www.snapserver.com/support.
Source and Location Content

700i Series Quick Start Guide Details package contents, identifies server
Product Packaging and Web hardware components, and provides complete
instructions for installing the server to a rack,
connecting the server to the network, and
configuring the iSCSI Storage Appliance. Also
contains the EULA and warranty.
SANbloc S50 Quick Install Guide Details package contents, identifies expansion
Product Package and Web array hardware components, and provides
complete instructions for installing the SANbloc S50
to a rack and connecting it to a Snap Server.
Snap Server 700i Series Provides an overview of the configuration and
User Guide maintenance of the Snap Server 700i Series, gives
User CD and Web detailed instructions on using Adaptec Storage
Manager to configure and manage your iSCSI
storage, and provides hardware specifications for
Adaptec Storage Manager Online
the Snap Server 700i Series and the SANbloc S50
Help
expansion array.
Readme.txt Contains late-breaking information, corrections, and
User CD known issues concerning the Snap Server 700i
Series.
Field Service Documentation Provides detailed instructions for the replacement of
Service CD and Web disk drives, adapter cards, power assemblies, slide
rails, and other hardware components.
Service and Technical Support

For an immediate response to a service inquiry, use our Expert Knowledge Base
System at http://www.snapserver.com/kb. Simply type in your question to view a
list of possible resolutions to known issues. However, if none of the listed topics
resolves your inquiry, you can forward the question to our Technical Support
department who will then e-mail you with a response. To obtain additional service
or technical support for your Snap Server 700i Series, call +1 408-934-7274.
2 Command Line Interface User’s Guide

Chapter 1
Accessing the CLI

This chapter explains how to access the CLI and describes the access levels.
You can access the CLI two ways—using a terminal emulation program, or using
Telnet. Each method presents the CLI automatically.
Using a Terminal Emulation Program

Attach a null modem cable to the COM 1 port of the iSCSI Storage Appliance and
use a VT100 terminal emulation program (for example, Hyperterminal™).
Use these terminal emulation program settings:
• Null Modem Cable
• Baud Rate: 115,200
• Data Bits: 8
• Parity: None
• Stop Bits: 1
• Flow Control: Off
Note Flow control must be set to Off. Otherwise, the system will appear to hang.
Using Telnet
Once the initial network values have been set (in either the CLI or Adaptec Storage
Manager), you can connect to the iSCSI Storage Appliance through a Telnet session.
Telnet to the IP address that is assigned to the management port on the iSCSI
Storage Appliance.
For example:
P:\>telnet 10.20.30.400

Access Levels and Passwords

The CLI has two access levels: Operator and Administrator. You can set separate
passwords for each level. This section describes both levels.
Administrator Level
Administrators have full access to your IP SAN, and can manage and modify iSCSI
storage as required.
Operator Level
Operators have restricted access to your IP SAN, as described in this table.
Operators can... Operators can’t...

Blink a hardware component, such as a disk Provision storage to an iSCSI Storage Host
drive or iSCSI Storage Appliance
View Properties window of all storage Create, modify, or delete a pool, volume, or
components of your IP SAN logical device
Verify a pool Mirror a volume or modify or break a
mirrored volume
Create a hot spare Create or delete a snapshot
View event logs
Save a support archive
Change Adaptec Storage Manager
preferences
View online Help
Changing from One Access Level to the Other

By default, the CLI opens in the Operator access level. To switch to Administrator
level, enter:
administrator
administrator_password
Note The default password is admin.
When you are logged in as Administrator, the CLI prompt displays a #. (When you
are logged in as Operator, the # does not display.)
To switch from Administrator level to Operator level, enter:
operator

Changing Access Level Passwords

The default password for both the Administrator and Operator levels is admin.
You can set separate passwords for each level, or remove the password requirement
for one or both levels.
You can change the passwords in the CLI during set-up (see page 71) or at any time
after set-up is complete (see “Password Command” on page 46.) You can also
change the passwords in the Adaptec Storage Manager wizard (refer to the Snap
Server 700i Series User’s Guide).
Chapter 1 Accessing the CLI 5


Chapter 2
Working in the CLI

This section provides basic CLI orientation information as well as directions, tips,
and shortcuts for working in the CLI.
About the Main Mode and Functional Contexts

The CLI opens in the main mode, where the top-level commands are available. The
top-level commands are areas of functionality, or functional contexts, in which you
can perform related tasks on a particular part of your iSCSI Storage Appliance or IP
SAN. These commands are available in the main mode:
• administrator • interface • route
• clone • isns • service
• controller • license • set
• device • logical • show
• diagnostics • network • snapshot
• events • operator • system
• image • password • ups
• initiator • pool
Within each functional context are action commands. For example, these commands
are available in the initiator context:
• create • info • local
• destroy • list • manage
Some action commands, such as the manage commands, open a second layer of
functional context—a separate area of functionality within a top-level area of
functionality, with its own set of action commands. For example, these commands
are available in the initiator context’s manage context:
• alias • disco • piggyback
• align • info • ping
Note Some action commands, like list and info, are available in multiple functional
contexts. How they behave depends on what context they’re in.

Getting Help
Getting Help
You can request help at any time by entering help or ? anywhere in a line. The type
of help provided depends on where you are in the CLI. For instance, typing help
may generate a list of valid commands or parameters, or a list of all available
commands. To request help completing a command, press Tab (see page 9).
About Case-sensitivity and Spaces

In general, the CLI is not case-sensitive. Commands and parameters can be typed
using upper or lower case letters, except where noted. However, all EUIs, IQNs,
iSCSI aliases, and initiator names must be entered in lower-case letters.
Place a single space between a command and its parameters, and between
parameters. For example:
cache read enable.
If a space has to be entered as part of a parameter, enclose the parameter in a pair of
double-quotes (“ ”). Everything between the quotes, including spaces, is used as the
parameter. For example:
delete “logical group1”
Viewing Long Lists or Reports

When a command generates a report (including help messages) that is too long to fit
onto your screen, use these keystrokes to move through the pages of the report.
Keyboard shortcuts are not case-sensitive.
Press... To...
N or F or the spacebar Move down to the next full page of the report
D or J or Enter Move down to next line of the report
B Move up to the previous full page of the report
U or K Move up to previous line of the report
P or < or Home Go to the beginning of the report
E or > or End Go to the end of the report
R or F5 Refresh the current page
Q Exit the report
H or ? or F1 Display this list of keyboard shortcuts

Using the Tab Key to Complete Commands
Using the Tab Key to Complete Commands

If you have typed part of a command and require help to finish it, press Tab. If the
partial command you’ve typed can be completed only one possible way, pressing
Tab completes the line automatically.
If the partial command requires more information, press Tab again to display a list
of options. The command line prompt automatically redisplays the partial
command so that you can finish it.
Abbreviating Commands
Most commands can be abbreviated to their shortest unique abbreviation. For
example, if you are in the Operator level and wish to change to the Administrator
level, you only have to enter ad.
Command Line Editing

You can edit commands and parameters by using these keystrokes:
Keystroke Function
Ctrl+A Jump to the start of the line
Ctrl+B Move the cursor back (left) one character
Ctrl+C Escape and terminate a lengthy job
Ctrl+D Delete the character at, or in front of, the cursor
Ctrl+E Jump to the end of the current line
Ctrl+F Move the cursor forward (right) one character
Ctrl+H; or Backspace Erase a mistake when entering a command
Ctrl+K Delete from the cursor forward (right) to the end of the line
Ctrl+N; or down arrow Display the next command in the command history
Ctrl+P; or up arrow Display the previous command in the command history
Ctrl+S Search for a command in the command history
Ctrl+T Transpose two characters
Ctrl+U Delete a complete line
Esc B Move the cursor back (left) one word
Esc D Delete from the cursor to end of the word
Esc F Move the cursor forward (right) one word
Chapter 2 Working in the CLI 9

Leaving a Context and Exiting the CLI
Leaving a Context and Exiting the CLI

To leave a context, such as interface, enter end.
To exit the CLI, enter quit.

Chapter 3
Commands and Parameters

This chapter describes the commands available in the CLI and provides examples
when useful for clarification.
Terminology Used in This Chapter

In the context of a command, “enter” means to type the command, then press Enter.
These terms are used to describe the three main parts of a command:
• Functional context—The area of functionality, such as pool, device, or snapshot.
• Command—An action, such as create, list, or remove.
• Parameter—Specific information related to the command, such as the name of a
pool (pool_name), the size of a new logical device (logical_device_size), or a list of
interfaces (eth0 eth1).
The next chapter, “Commands and Parameters” on page 11, which describes all CLI
commands, is organized alphabetically by area of functionality, then by action.
How this Chapter is Organized

This chapter is organized alphabetically by area of functionality (such as device or
snapshot) then by command (such as add or list).
All commands listed in this chapter are available to users logged in as either
Administrator or Operator, except where noted. Administrator-only commands
won’t be recognized if you are logged in as an Operator.
Command and Example Context

The commands and examples shown in this chapter assume that you are working in
a functional context of the CLI, such as device or snapshot.
To use the commands in the main mode, specify the area of functionality at the
beginning of each line.
For instance, if the command in the clone context is:
add clone_name
the correct version of this command in the main mode would be:
clone add clone_name

About the Command Format in This Chapter
About the Command Format in This Chapter

This Guide uses these formats are used to express commands and parameters.
Note A command or parameter presented in emphasis (pool_name) indicates that
you must enter an actual value (pool1).
Basic Command
A basic command with no options:
network
Enter the command as shown. For example:
network
Choice Between Two Commands (Toggle Settings)

A command that has two options:
enable_or_disable
Enter one of the two options. For example:
disable
Command and Parameter

A command that requires specific information to follow it:
rename new_logical_device_name
Enter the command and use an actual value to replace the text in emphasis. For example:
rename logical3
Command and Parameter List

A command that requires or supports a list of specific information:
info logical_device_name_list
Enter the command and use a list of actual values to replace the text in emphasis. Put
a single space between each value in the list. For example:
info logical3 logical6 logical7
Command and Choice Between Two Parameters (Toggle Settings)

A command that requires a parameter which can be one of two options:
cache read enable_or_disable
Enter one of the two options. For example:
cache read enable

Administrator Command
Multiple Parameters
A command that requires multiple parameters on the same line:
create logical_device_name pool_name logical_device_size
Enter the command and use actual values to replace the text in emphasis. Put a single
space between each value. For example:
create logical4 pool-A 10GB
By default, the CLI opens at the Operator level (see page 4). If an Operator
password is set, you will be prompted to enter it before you can begin working in
the CLI.
To switch to the Administrator level, enter:
administrator
Note Optionally, enter a shorthand version of the command: ad.
If prompted, enter the Administrator password. The default password is admin.
Clone Commands
Use the commands in this section to create and manage clones. A clone is a full copy
of a logical device. When you create a clone, the logical device is copied into a new
volume created in the pool that you have specified.
To enter the clone context, enter:
clone
Abort
Note Administrator access only.
This command stops the creation of a clone. You might want to do this if a pool
failure occurs while the clone is being created. You must specify the clone by name.
Enter:
abort clone_name
Chapter 3 Commands and Parameters 13

Clone Commands
Create
This command creates a new clone. You must specify a name for the clone and
specify the logical device you are cloning. Enter:
create clone_name logical_device_name
For example:
create clone1 deviceA
Depending on the size of the original logical device, it can take several hours for a
new clone to be created.
Note Once a clone is created, you can access and manage the clone (the destination
logical device) as a normal logical device. You can’t apply clone commands to the
destination logical device.
Info
In the clone context, enter this command to display information (such as the source
pool, destination pool, size, and status) about all the clones you have created:
info
List
In the clone context, enter this command to view a list of all the clones you have
created:
list

Device Commands
Device Commands
Use the commands in this section to manage the disk drives in your iSCSI Storage
Appliance.
To enter the device context, enter:
device
Identify
This command helps you identify specific disk drives by blinking their LEDs. You
must specify which disk drives you want to identify by their ID number. (To find a
disk drive’s ID, enter list.)
Note To identify all the disk drives in a pool, see “Identify” on page 50.
To start blinking disk drive LEDs, enter:
identify disk_drive_ID_list start
For example:
identify 0 256 start (blinks 2 disk drives, ID# 0 and 256)
identify 512 start (blinks 1 disk drive, ID# 512)
The LEDs will stop blinking automatically after 30 seconds. You can stop the
blinking sooner by entering:
identify disk_drive_ID_list stop
Info
This command displays the status, capacity, and other information about a
specified disk drive. You must specify the disk drive by its ID number. (To find a
disk drive’s ID, enter list.)
info disk_drive_ID_list

Device Commands
Initialise
This command removes all RAID information from the specified disk drive(s).
Caution Do not initialise a disk drive that is part of a logical device or the data on
that logical device may become unusable. Back up all data from your disk drive
before initialising it.
To initialise a disk drive, enter:
initialise disk_drive_ID_list
List
In the device context, this command lists all disk drives attached to your iSCSI
Storage Appliance:
list
To view a list of all devices that are part of foreign pools (pools on another iSCSI
Storage Appliance), enter:
list foreign
To view a list of all devices being used as hot spares, enter:
list spare
Manage Commands
At this time, the only available manage commands are identical to the identify and
info commands already described in this section. See page 15.
Unused
This command lists any disk drive attached to your iSCSI Storage Appliance which
is not currently part of any pool:
unused

Diagnostics Commands
Use the commands in this section to perform diagnostics tests on your iSCSI Storage
Appliance and IP SAN.
Note This area of functionality is available to users with Administrator access only.
To enter the diagnostics context, enter:
diagnostics
Check
This command performs diagnostic tests of your iSCSI Storage Appliance hardware
and its interface configuration.
A hardware test lists the appliance’s components (memory configuration, RAID
controller, Ethernet interfaces) and tests whether the components form a valid
combination.
To perform a diagnostic test on your appliance’s hardware, enter:
check hardware
An interface test checks the configuration of each network interface and reports
each interface’s status, ping results, link state, and other information.
To perform a diagnostic test on your appliance’s network interfaces, enter:
check interface
Dump
This command dumps (copies without formatting) raw data to a specifed location
where you can use it to identify problems. You must specify the connection type
and location.
Dump Using an FTP Connection

To do a diagnostics dump using an FTP connection, you must specify the FTP site’s
host name or IP address:
dump ftp FTP_hostname_or_IP_address
For example:
dump ftp 10.20.1.100

Dump Using a Serial Connection

To do a diagnostics dump using a serial connection, you must specify the same file
transfer protocol (1kxmodem or xmodem) as the serial terminal program you are
using:
dump serial file_transfer_protocol
For example:
dump serial 1kxmodem
Ping
This command tests to see if an iSCSI Storage Host on your IP SAN can be
contacted. The results of each ping attempt (successful or failed) appear on their own
line in the CLI.
You must specify the host by its IP address. You can also specify the number of ping
attempts to make (count) and/or the duration of each ping attempt, in seconds
(timeout).
The full command syntax is:
ping host_IP_address [timeout time] [count number] [source interface_name_or_IP_address]
To ping an iSCSI Storage Host, enter:
ping host_IP_address
To ping an iSCSI Storage Host for ten seconds, enter:
ping host_IP_address timeout 10
To ping an iSCSI Storage Host five times, enter:
ping host_IP_address count 5
To ping an iSCSI Storage Host five times for three seconds each time, enter:
ping host_IP_address timeout 3 count 5
To ping an iSCSI Storage Host over a specific network interface, you must specify
the interface by either its name or its IP address. For example:
ping host_IP_address source eth0
or
ping host_IP_address source 10.20.300.401

Events Commands
Tracert
This command traces the route to an iSCSI Storage Host on your IP SAN. It lists all
the intermediate gateways between your iSCSI Storage Appliance and the specified
destination. You must specify the host by its IP address and interface name.
tracert host_IP_address interface_name
For example:
tracert 10.20.300.400 eth0
Note You can terminate a tracert command by pressing Ctrl+C.
Events Commands
Use the commands in this section to view the status of your iSCSI Storage
Appliance and monitor and modify its event logs. The event logs contain all event
information for the appliance. See page 76 for a list of all the event severity levels.
Clear
This command clears all events from the event log for your iSCSI Storage
Appliance. Don’t use this command unless you’re sure that you no longer require
the information in the event log—this function can’t be undone. You will be
prompted to confirm that you want to clear all events.
To clear the event log, enter:
clear
yes
Inactive Commands
These commands mark a specified group events as inactive in the event log. Inactive
events don’t affect overall system status. You might want to use this command to
return system status to normal by inactivating a warning event, for instance.
(Marking events as inactive is a less drastic step than clearing all events from the
event log.)
You can use the commands in this section individually or combine them on one line
to define the group of events as broadly or as narrowly as required.

Events Commands
Inactivating All Events

To inactivate all events in the event log, enter:
inactive all
Inactivating All Events of a Specified Level

You can inactivate all events of the same level. You must specify the level using one
of these parameters: info, warning, or error.
inactive level level_of_event
For example:
inactive level warning
Inactivating Events in a Specified Date or Time Range

You can inactivate all events that occurred within a date or time range by using the
commands and parameters in the next table.
Note For more information about the absolute_date and relative_period
parameters, see the "Glossary".
Command Parameter Description

from absolute_date Inactivates all events from the specified date to the
current date and time
from relative_period Inactivates all events from the beginning of the relative
period (for example, two hours ago) to the current date
and time
to absolute_date Inactivates all events that happened before the specified
date
to relative_period Inactivates all past events that happened before the
beginning of the relative period (for example, up to five
minutes ago)
Use these commands in combination to narrow the scope of the inactivation. For
instance, to inactivate all events during a specific time period, enter:
inactive from absolute_date to absolute_date
For example:
inactive from 25/07/07 to 30/07/07
To inactivate all events that occurred in a period relative to the current time, enter:
inactive from relative_period to relative_period

Events Commands
For example, to inactivate all events that occurred between ninety minutes and
three hours ago, enter:
inactive from -3h to -90m
To inactivate all events that occurred from a specific date until the beginning of a
period relative to the current time, enter:
inactive from absolute_date to relative_period
For example, to inactivate all events from July 13 to one hour ago, enter:
inactive from 13/07/07 to -1h
Inactivating All Events by Originator

You can inactivate all events originated by a specific component of the Adaptec
OnTarget operating system:
inactive originator name
Note Type inactive originator then press Tab twice to display a list of Adaptec
OnTarget operating system components to choose from. The list includes Service
Control, Feature Enable Keys, iSCSI Protocol, Flash, and Health Daemon.
(Remember that if a parameter includes a space, such as Health Daemon, you
must enclose it in a pair of double-quotes—“health daemon”. See page 8 for more
information.)
For example:
inactive originator “health daemon”
Info
In the events context, this command displays a summary of event log information,
including system status, the current size of the event log, and the number of
recorded events:
info
Report
This command displays event log reports. You can use the commands in this section
individually or combine them on one line to define the report you want as broadly
or as narrowly as required.
Reporting All Events

To generate a report of all events in the event log, enter:
report all

Events Commands
Reporting All Active Events

To generate a report of all active events in the event log, enter:
report active
Reporting All Events by a Specified Operating System Component

To generate a report of all events originated by a specific component of the Adaptec
OnTarget operating system, enter:
report originator name
Note Type report originator, then press Tab twice to display a list of Adaptec
OnTarget operating system components to choose from. The list includes Service
Control, Feature Enable Keys, iSCSI Protocol, Flash, and Health Daemon.
(Remember that if a parameter includes a space, such as Health Daemon, you
must enclose it in a pair of double-quotes—“health daemon”. See page 8 for more
information.)
For example:
report originator flash
or
report originator “service control”
Generating a Long Report

To generate a report that includes all text associated with each event, enter:
report long
Reporting All Events of a Specified Level

You can generate a report of all events of the same level. You must specify the level
using one of these parameters: info, warning, or error.
report level level_of_event
For example:
report level error

Help Command
Reporting Events in a Specified Date or Time Range

Note For more information about the absolute_date and relative_period
parameters, see the "Glossary".
Command Parameter Description

from absolute_date Reports all events from the specified date to the current
date and time
from relative_period Reports all events from the beginning of the relative
period (for example, two hours ago) to the current date
and time
to absolute_date Reports all events that happened before the specified
date
to relative_period Reports all past events that happened before the
beginning of the relative period (for example, up to five
minutes ago)
Use these commands in combination to narrow the scope of the report. For instance,
to report all events during a specific time period, enter:
report from absolute_date to absolute_date
For example:
report from 25/07/07 to 30/07/07
To report all events that occurred in a period relative to the current time, enter:
report from relative_period to relative_period
For example, to report all events that occurred between ninety minutes and three
hours ago, enter:
report from -3h to -90m
Help Command
Enter help or ? in the main mode or within a functional context to see a list of
currently available commands and a brief description of each.
If you are viewing a long report in the CLI (such as the list of available commands
in the main mode), enter help or ? to display a list of keyboard shortcuts that will
help you move through the report.
Note Keyboard shortcuts are also listed in this Guide. See “Working in the CLI” on
page 7.

Image Commands
Image Commands
Use the commands in this section to view information about the two Adaptec
OnTarget operating system images stored on your iSCSI Storage Appliance, and
upload and install new images onto the appliance.
For step-by-step instructions on using these commands, see “Updating the Adaptec
OnTarget Operating System” on page 75.
To enter the image context, enter:
image
Boot
Note Administrator access only. For step-by-step instructions on using this
command, see “Reverting to the Previous Image” on page 77.
This command selects the boot image, the image that you want your appliance to use
the next time it is restarted. You must specify the image by its number. (To find the
image numbers, enter list. See “List” on page 25 for more information.)
boot image_number
For example, to change the default boot image to image number 2, enter:
boot 2
To apply the image, restart your iSCSI Storage Appliance.
Caution Do not make any configuration changes before you restart the appliance.
Any changes that you make will be lost when the appliance restarts.

Image Commands
Info
In the image context, this command shows information about the boot images stored
on your iSCSI Storage Appliance:
info
This information appears:
Image Image Version Date Version

Number Name and Time Number
In the figure above, Image 2 is the image running currently. Image 2 is also the
image that will be used the next time the iSCSI Storage Appliance is restarted or
powered on.
List
In the image context, this command lists the number, name, version number, and
date of the two boot images stored on your iSCSI Storage Appliance:
list
Upload
Note Administrator access only. For step-by-step instructions on using this
command, see “Uploading a New Image” on page 75.
This command uploads a new image to your iSCSI Storage Appliance. You will be
prompted to confirm the command before the image is uploaded.
To upload a new image to your iSCSI Storage Appliance, enter:
upload URL_to_image
yes
Alternatively, to upload the image through your iSCSI Storage Appliance’s serial
port, enter:
upload 1kxmodem
yes
The image is uploaded and your iSCSI Storage Appliance is automatically restarted.
(This may take a few minutes.)

Initiator Commands
Initiator Commands
Use the commands in this section to create, manage, and delete the local and remote
iSCSI initiators on your IP SAN.
To enter the initiator context, enter:
initiator
Create
This command adds a new remote iSCSI initiator to list of initiators accessing
storage on your iSCSI Storage Appliance. You must specify the name (or alias) and
IQN of the iSCSI initiator.
By default, the initiator is added with these default settings:
• Align disabled—When this setting is enabled, Protocol Data Units (PDUs) are
aligned on Ethernet frames.
• Piggyback enabled—When this setting is enabled, the SCSI Response PDU can be
merged with the last Data-In PDU.
• Ping disabled—When this setting is enabled, the iSCSI initiator is pinged
regularly to test the connection.
To create a new remote iSCSI initiator, enter:
create initiator_name initiator_IQN
For example:
create initiator1 iqn.2007-07.com.adaptec:01.b3544e7c24dd
The iSCSI intiator is created with the default settings. To change the default settings,
see the “Manage Commands” on page 28.
To create a new remote iSCSI initiator with the piggyback and/or ping settings
enabled, enter:
create initiator_name initiator_IQN piggyback
or
create initiator_name initiator_IQN ping
or
create initiator_name initiator_IQN piggyback ping
To create a new remote iSCSI initiator with the align setting disabled, enter:
create initiator_name initiator_IQN noalign
Note Remote iSCSI initiators are also implicitly created by other commands.

Initiator Commands
Destroy
This command removes all references to specified iSCSI intiators from any iSCSI
targets that refer to them. You must specify the iSCSI intiators by name. (To find the
name of an initiator, enter list.) You will be prompted to confirm that you want to
delete the specified iSCSI initiators.
To delete an iSCSI initiator, enter:
destroy initiator_name
yes
To delete more than one iSCSI initiator, add the names of the additional iSCSI
intiators to the end of the line, with one space between each name:
destroy initiator_name initiator_name initiator_name
yes
Info
In the initiator context, this command displays information about all or some iSCSI
initiators in the iSCSI initiator list, including their IQNs and settings. (To find the
name of a specific initiator, enter list.)
To view information about all iSCSI initiators, enter:
info
To view information about a specific iSCSI initiator, enter:
info initiator_name
List
In the initiator context, this command displays the list of all known initiators
accessing storage on your iSCSI Storage Appliance:
list
Local
This command displays the EUI of the local iSCSI initiator:
local

Initiator Commands
Manage Commands
Use these commands to modify the settings on an individual iSCSI initiator. You
must specify the initiator by its name. To enter the manage context, enter:
manage initiator_nameAA
Alias
This command changes the name (or alias) of the iSCSI initiator:
alias new_initiator_name
The name is changed immediately.
Align
This command enables or disables the align setting of the iSCSI initiator, which
determines whether or not PDUs are aligned. The align setting is disabled by default.
Note Only advanced users familiar with the function of the align setting should
enable it.
To change the align setting, enter:
align enable_or_disable
For example:
align enable
Disco
This command enables or disables a permanent discovery session for the iSCSI
initiator. The disco setting is disabled by default.
To change the permanent discovery session setting, enter:
disco enable_or_disable
For example:
disco enable
The permanent discovery session is enabled immediately.
Info
This command displays information about the iSCSI initiator, including its IQN and
settings:
info

Interface Commands
Piggyback
This command enables or disables the piggyback setting, which determines
whether or not the SCSI Response PDU can be merged with the last Data-In PDU.
The piggyback setting is enabled by default.
Note Only advanced users familiar with the function of the piggyback setting
should disable it.
To change the piggyback setting, enter:
piggyback enable_or_disable
For example:
piggyback disable
Ping
This command enables the ping setting, which controls whether or not the iSCSI
initiator is pinged regularly to test the connection. The ping setting is disabled by
default.
To change the ping setting, enter:
ping enable_or_disable
For example:
ping enable
Interface Commands
Use the commands in this section to modify and manage your iSCSI Storage
Appliance’s network interfaces. To enter the interface context, enter:
interface
Info
In the interface context, this command displays information about some or all of the
network interfaces. This command lists the interface’s status, link state, IP address,
speed, and so on.
To display information about all the network interfaces, enter:
info
To display information about a specific interface, enter:
info interface_name
To display information about more than one specific interface, enter:
info interface_name interface_name
Chapter 3 Commands and Parameters 29P

Interface Commands
List
This command lists the name, IP address, service type (management, iSCSI, or
management and iSCSI), status, and link state of all network interfaces on your
iSCSI Storage Appliance:
list
Manage Commands
Use these commands to modify the settings on an individual network interface. You
must specify the interface by its name. To find the name of the interfaces on your
iSCSI Storage Appliance, enter list.
To enter the manage context, enter:
manage interface_name
For example:
manage eth0
Broadcast
This command sets the broadcast address for the interface:
broadcast broadcast_address
For example:
broadcast 10.20.255.255
The broadcast address is changed immediately.
DHCP
This command enables or disables Dynamic Host Configuration Protocol (DHCP)
on the interface. To change the DHCP setting, enter:
dhcp enable_or_disable
For example:
dhcp disable

Interface Commands
Down
This command brings down (shuts off connection to and from) the interface. You
might want to use this command in conjunction with the up command to reset or
clear the interface.
To take down the interface, enter:
down
The interface is taken down immediately.
Interfacetype
Note Administrator access only. This command is only available for the eth0
interface.
This command sets the service type for the eth0 interface. The interface type setting
determines what data is supported by the interface. You can set the interface to
support management data only (mgmt) or management and iSCSI data (iscsi_mgmt).
To set the service type, enter:
interfacetype service_type
For example:
interfacetype iscsi_mgmt
Info
This command lists the interface’s status, link state, IP address, speed, and so on:
info

Interface Commands
IP
This command sets the interface’s IP address. You can use this command on the
same line as the netmask command (see page 33). If you don’t specify a netmask
address, the ip command sets a default netmask automatically.
To set the interface’s IP address, enter:
ip IP_address
For example:
ip 10.20.30.400
The IP address is changed immediately.
To set the interface’s IP address and netmask, enter:
ip IP_address netmask netmask_address
For example:
ip 10.20.30.400 netmask 10.255.255.255
MTU
This command sets the Maximum Transmission Unit (MTU) size for the interface.
To see a list of supported size values (shown in bytes), type mtu, then press Tab. The
values will be listed and the command prompt will return to the mtu command. For
example:
mtu [Tab]
1500 9000 <mtu>
mtu
To change the MTU setting, enter the size value after mtu:
mtu size_value
For example:
mtu 9000
The setting is changed immediately.

Interface Commands
Netmask
This command sets the netmask for the interface. You can use this command on the
same line as the ip command (see page 32).
If DHCP is enabled, this command changes the stored value that is used if DHCP is
ever disabled; otherwise it doesn’t change the actual value of the interface. If DHCP
is disabled, this command resets the interface.
To set the interface’s netmask, enter:
netmask netmask_address
For example:
netmask 10.255.255.255
The netmask is changed immediately.
To set the interface’s IP address and netmask, enter:
ip IP_address netmask netmask_address
For example:
ip 10.20.30.400 netmask 10.255.255.255
Rename
This command sets a new name for the interface. You might want to do this to make
it easier to identify the individual Ethernet ports on your iSCSI Storage Appliance.
rename new_interface_name
Speed
This command sets the speed of the devices accessing the interface. If a device
supports auto-negotiation, you can use this command to limit its speed. You can set
the speed to 10 MB per second, 100 MB per second, or auto-negotiation (if a device
supports that setting).
To change the speed setting, enter:
speed 10_100_or_auto
For example:
speed 100

Interface Commands
Statistics
This command displays these statistics about the interface:
• Number of collisions
• Number of transmitted packets with a breakdown of errors (dropped, overrun,
and framing)
• Number of received packets with a breakdown of errors (dropped, overrun, and
framing)
To view the interfaces statistics, enter:
statistics
Up
This command brings up (opens connection to and from) the interface. You might
want to use this command in conjunction with the down command to reset or clear
the interface.
To bring up the interface, enter:
up
Statistics
This command produces the same information as the statistics command in the
manage context (see page 34). You can choose to view statistics for all the interfaces
on your iSCSI Storage Appliance, or you can specify a particular interface in the
command line.
To view statistics for all interfaces, enter:
statistics
To view statistics for a specific interface only, enter:
statistics interface_name
For example:
statistics eth0

iSNS Commands
iSNS Commands
Use these commands to manage and modify the Internet Storage Name Service
(iSNS) server on your IP SAN.
To enter the iSNS context, enter:
isns
Info
In the iSNS context, this command displays information about the iSNS server on
your IP SAN:
info
server
This command sets or clears an iSNS server. You must specify the server by its
hostname or IP address.
To set an iSNS server, enter:
server server_hostname_or_IP_address
For example:
server 10.20.300.400
To clear an iSNS server, enter:
server server_hostname_or_IP_address clear
For example:
server iSNSserver clear
License Commands
Use the commands in this section to view the list of features supported by your
current license or update your iSCSI Storage Appliance to a new license code (or key).
To enter the license context, enter:
license
Info
This command lists the features that are supported by your current license key:
info

Logical (Device) Commands
Key
This command enters a new license key for your iSCSI Storage Appliance. License
keys are 20 characters long.
To enter a new license key, enter:
key
When prompted, enter the license key. For example:
ABCD-CDEF-FGHJ-KLMN-MNOP

Use the commands in this section to create, delete, and modify logical devices on
your iSCSI Storage Appliance.
To enter the logical context, enter:
logical
Note If the logical device you want to modify is a snapshot, you can use these
commands in the snapshot context. For more information about snapshots, see
page 59.
CHAP Commands
Use the commands in this section to set up Challenge Handshake Authentication
Protocol (CHAP) user names and passwords for the logical devices on your iSCSI
Storage Appliance.
Changes made using these commands take effect immediately.
To enter the chap context, enter:
chap
Info
This command displays all CHAP user names that have been set:
info

Password
This command sets the CHAP secret. You will be prompted to enter the password
twice and then confirm the password. Enter:
password
When prompted, enter the password twice.
When prompted, confirm the password.
Notes 1) If your password doesn’t meet the minimum iSCSI RFC 3720 protocol, you
are prompted to create a different password; enter either yes or no, as desired. 2) If
you are using CHAP with the Microsoft iSCSI initiator, the CHAP secret must be
12–16 characters long or it will be rejected by the iSCSI initiator.
User
This command sets the CHAP user name:
user user_name
Create
This command creates a new logical device. The complete command syntax is:
Where:
• logical_device_name is a unique name for the logical device
• pool_name is the name of the pool from which to build the logical device
• logical_device_size is either:
• the size of the logical device (for example, 10GB), or
• available (the logical device will use all available pool space)
When the logical device is created, the IQN that the iSCSI initiator uses to access the
logical device is generated automatically.
To create a new logical device of a specific size, enter:
For example:
create device-1 pool-A 50.00GB
To create a new logical device that uses all available pool space, enter:
create device-1 pool-A available

Destroy
This command deletes a specified logical device. You must specify the logical
device by its name. (To find the name of a logical device, enter list.) You will be
prompted to confirm that you want to delete the specified logical device.
To delete a logical device, enter:
destroy logical_device_name
yes
To delete multiple logical devices simultaneously, enter:
down logical_device_name_list
yes
Down
This command takes down a specified logical device. You must specify the logical
prompted to confirm that you want to take down the specified logical device.
To take down a logical device, enter:
down logical_device_name
yes
To take down multiple logical devices simultaneously, enter:
down logical_device_name_list
yes
Info
In the logical context, this command displays information about one or more logical
devices, including status, the amount of space used, and auto-discovery control
lists. You must specify each logical device by its name. (To find the name of a logical
device, enter list.)
To display information about all logical devices associated with your iSCSI Storage
Appliance, enter:
info
To display information about a specific logical device, enter:
info logical_device_name
To display information about multiple logical devices simultaneously, enter:

List
In the logical context, this command lists all known logical devices associated with
your iSCSI Storage Appliance:
list
Manage Commands
Note Administrator access only, except for the info command.
Use these commands to modify a specified logical device. For instance, you can
control access to the logical device, increase the size of a logical device, and manage
authentication settings. You must specify each logical device by its name. (To find
the name of a logical device, enter list.) To enter the manage context for a logical
device, enter:
manage logical_device_name
Allow
This command adds specified iSCSI initiators to the logical device’s auto-discovery
control list. You must specify each iSCSI initiator by its name. (To find the name of
an iSCSI initiator, see “List” on page 27.) If you specify read-only (readonly), the
iSCSI initiator will have read-only access to the logical device.
To add specified iSCSI initiators to the logical device’s auto-discovery control list,
enter:
allow iSCSI_initiator_name_list
To give specified iSCSI initiators read-only access to the logical device, enter:
allow readonly iSCSI_initiator_name_list
Authentication
This command sets authentication for the logical device. You can choose between
CHAP, SRP, and none. (These commands are not case-sensitive.)
To change the authentication setting for the logical device, enter:
authentication authentication_setting

Chapusers Commands
Use these commands to manage CHAP authentication settings on the logical
device. To enter the chapusers context, enter:
chapusers
• List
In the chapusers context, this command lists all CHAP users of the logical device:
list
• Password
This command sets a new CHAP secret:
password new_CHAP_secret
• Remove
This command removes one or more specified CHAP users from the list of those
allowed to access the logical device. You must specify each CHAP user by name.
(To find the name of a CHAP user, see “Info” on page 36.)
To remove one or more CHAP users, enter:
remove chap_user_name_list
Note For more CHAP commands, see page 36.
Deny
This command removes specified iSCSI initiators from the logical device’s auto-
discovery control list. You must specify each iSCSI initiator by its name. (To find the
name of an iSCSI initiator, see “List” on page 27.)
To complete the removal of the iSCSI initiator, you will be prompted to enter a
CHAP user name and secret for that initiator.
To remove specified iSCSI initiators from the logical device’s auto-discovery control
list, enter:
allow iSCSI_initiator_name_list
CHAP_user_name
CHAP_password
CHAP_password

Growby
This command grows (or expands) a logical device by a specified size or by a
percentage of the available pool space. If you specify the percentage, you can choose
any whole percentage between 1 and 99; partial percentages (for instance, .5) are not
supported.
To expand a logical device, enter:
growby size_or_percentage
For example:
growby 10GB
or
growby 25%
Growto
This command grows (or expands) a logical device to a specific size:
growto new_logical_drive_size
For example:
growto 50GB
Info
In the manage context, this command displays information about the logical device,
including its status, the amount of space used, and its auto-discovery control list:
info
Interface
This command specifies the iSCSI interface(s) through which the logical device can be
accessed. You can specify a single iSCSI interface, multiple interfaces, or all interfaces.
To allow access to the logical device through one or more iSCSI interfaces, enter:
interface iSCSI_interface_list
To allow access to the logical device through all iSCSI interfaces, enter:
interface all
Rename
This command sets a new name for the logical device:
rename new_logical_device_name

Sessions
These commands are identical to those listed in the following section (“Sessions
Commands”).
Sessions Commands
Use these commands to end or view information about current iSCSI sessions on
your iSCSI Storage Appliance. To enter the sessions context, enter:
sessions
Info
In the sessions context, this command displays information about current iSCSI
sessions. You can view iSCSI session information about all logical devices, or you
can view iSCSI session information about specified logical devices. You must
specify each logical device by its name. (To find the name of a logical device, enter
list.)
To view iSCSI session information about all logical devices, enter:
info
To view iSCSI session information about a specific logical device, enter:
info logical_device_name
To view iSCSI session information about multiple logical devices simultaneously,
enter:
List
In the sessions context, this command lists all current iSCSI sessions:
list

Reset
This command ends all current iSCSI sessions on a specified logical device. You
must specify the logical device by its name. (To find the name of a logical device,
enter list.) You will be prompted to confirm that you want to stop the iSCSI sessions
on the specified logical device.
Caution After you enter and confirm this command, all current iSCSI sessions on
the logical device stop. Stop all active applications before you begin.
To end all current iSCSI sessions on a specified logical device, enter:
reset logical_device_name
yes
Up
This command brings up a specified logical device. You must specify the logical
prompted to confirm that you want to bring up the specified logical device.
To bring up a logical device, enter:
up logical_device_name
yes
To bring up multiple logical devices simultaneously, enter:
up logical_device_name_list
yes

Network Commands
Network Commands
Use the commands in this section to modify your network settings, including server
and iSCSI Storage Appliance settings.
To enter the network context, enter:
network
DNS
This command sets up a Domain Name System (DNS) server. You can also use this
command to remove a DNS server from your IP SAN. You must specify each server
by its IP address.
You can have up to three DNS servers on your IP SAN (primary, secondary, and
tertiary). You can add them all simultaneously on the same command line.
To set up a DNS server, enter:
dns server_IP_address
You can enter up to three IP addresses, leaving one space between each. For example:
dns 10.20.30.400 10.20.30.401 10.20.30.402
To remove a DNS server, enter:
dns server_IP_address clear
Domain
This command sets a new domain name for your iSCSI Storage Appliance. You can
use this command on the same line as the SANname command (see page 46) and
hostname command (see page 45), to configure the network details in one command.
domain new_domain_name
To set a new domain name, host name, and IP SAN name, enter:
domain new_domain_name sanname new_IPSAN_name hostname new_host_name
Note The commands can be entered in any order.

Network Commands
Gateway
This command sets a new gateway server for your IP SAN. You can also use this
command to remove a gateway server from your IP SAN. You must specify the
server by its IP address.
gateway server_IP_address
The gateway server is changed immediately.
To remove a DNS server, enter:
gateway server_IP_address clear
Hostname
This command sets a new host name of your iSCSI Storage Appliance. You can use
this command on the same line as the domain command (see page 44) and SANname
command (see page 46), to configure the network details in one command.
hostname new_host_name
Info
This command displays information about your network, including server and
Ethernet port details.
info
NTP
This command sets a Network Time Protocol (NTP) server for your IP SAN. You
can also use this command to remove an NTP server from your IP SAN. You must
specify the server by its IP address.
ntp server_IP_address
The NTP server is changed immediately.
To remove an NTP server, enter:
ntp server_IP_address clear

Operator Command
SANname
This command sets a new name for your IP SAN. You can use this command on the
same line as the domain command (see page 44) and hostname command (see
page 45), to configure the network details in one command.
To set a new name for your IP SAN, enter:
sanname new_IPSAN_name
Operator Command
By default, the CLI opens at the Operator level (see page 4). If an Operator password
is set, you will be prompted to enter it before you can begin working in the CLI.
To switch back to the Operator level from the Administrator level, enter:
operator
Note Optionally, enter a shorthand version of the command: op.
Password Command
Use this command to set a new password for Operator- or Administrator-level
access, or remove the requirement for a password at either level.
Setting a New Administrator Password

To change the Administrator password, enter:
password
When prompted, enter the current password. (The default password for both levels
is admin.) When prompted, enter the new password, then enter it again. For example:
password
admin [current password]
adaptec
adaptec
Note Press Ctrl+C at either password prompt to exit without changing the existing
password.

Pool Commands
Removing a Password Requirement

To remove the requirement for an Administrator password, press Enter at each
password prompt instead of entering a new password.
Setting a New Operator Password

To change the Operator password, enter:
password operator
When prompted, enter the new password, then enter it again. For example:
adaptec
adaptec
Note Press Ctrl+C at either password prompt to leave the existing password
unchanged.
Removing a Password Requirement

To remove the requirement for an Operator password, press Enter at each
password prompt instead of entering a new password.
Pool Commands
Use the commands in this section to manage the storage pools on your iSCSI
Storage Appliance. To enter the pool context, enter:
pool
Alarm
This command manages the alarm on your iSCSI Storage Appliance. You can use
this command to view the current alarm settings, and you can enable or disable the
alarm, test it, and silence a sounding alarm.
To view current alarm settings, enter:
alarm info
To enable or disable the alarm, enter:
alarm enable_or_disable
To test the alarm, enter:
alarm sound
To silence a sounding alarm, enter:
alarm silence

Pool Commands
Create
This command creates a new pool. Up to 20 pools are supported on a single iSCSI
Storage Appliance. The complete command syntax is:
create pool_name RAID_level stripe_depth disk_drive_list
Where:
• pool_name is a unique name for the pool
• RAID_level is the RAID level you want to apply to the pool (if any)
Note Ensure that you have enough available disk drives to support the RAID
level you want.
• stripe_depth is the stripe depth for the pool
• disk_drive_ID_list is the ID number of the disk drive(s) to be included in the pool
Note To find a disk drive’s ID, exit the pool context then enter device list.
To create a pool with no RAID level, enter:
create poolA 0
To create a pool with RAID 5, enter:
create poolB raid5 256 0 512 768
Note Ensure that you list the minimum number of disk drives required to
support the RAID level you want.
Creating a Pool with RAID 50 or RAID 60

To create a pool with RAID 50 or RAID 60, you must specify six or eight disk drives
(respectively) and arrange them into groups. You must also specify the number of
groups you want.
To create a pool with RAID 50 or RAID 60, enter:
create pool_name RAID_50_or_60 stripe_depth disk_drive_list group number_of_groups
For example:
create poolA raid50 256 0 256 512 768 1024 1280 group 2

Pool Commands
Destroy
This command deletes a specified pool or pools. After a pool is deleted, the disk
drives that comprised it become available for use.
You must specify each pool by its name. Enter destroy then press Tab twice, to see
the names of pools that can be deleted. You can’t delete a pool that includes logical
devices. (To delete a logical device, see “Destroy” on page 38.)
Foreign pools must be imported before they can be deleted. See “Import” on page
50 for more information.
Caution Before you begin, ensure that you have backed up any data you want to save.
When the pool is deleted, any data or programs stored on that pool are also deleted.
You will be prompted to confirm the deletion before the task completes.
To delete a pool or pools, enter:
destroy pool_name_list
yes
The pool is deleted immediately.
Note Depending on your OS, the drive-letter assignments of any remaining drives
may change after a pool is deleted and the system is rebooted.
Export
Note Administrator access only. This command is used in conjunction with the
import command. See “Import” on page 50 for more information.
This command exports one or more pools so that it can be moved to a different iSCSI
Storage Appliance. You must specify each pool by its name. (To find the name of a pool,
enter list.) You will be prompted to confirm the export before the task is completed.
Notes 1) Ensure that no iSCSI initiators are accessing a pool before you attempt to
export it. Pools being accessed can’t be exported. 2) Adaptec recommends that you
not export a pool while it is building, rebuilding, or synchronizing. If you do, it
appears as an alien pool when you import it to a new iSCSI Storage Appliance. (An
alien pool is a partially completed pool whose creation was interrupted; it contains
no iSCSI Storage Appliance information. Alien pools can’t be imported or used to
store data, and should be deleted.)
To export a pool or pools, enter:
export pool_name_list
yes
Exported pools are called foreign pools. Only one foreign pool at a time appears in
the CLI.

Pool Commands
Next Steps
After the pool has been exported, shut down both iSCSI Storage Appliances—the
appliance you are exporting from and the appliance you are importing to. (For
instructions refer to the Snap Server 700i Series User’s Guide on the User CD.)
Move the disk drives that comprise the pool to the new iSCSI Storage Appliance,
following the manufacturer’s instructions, power on the new iSCSI Storage
Appliance, then import the foreign pools using the import command (see page 50).
Only one foreign pool at a time appears in the CLI; after you import the first foreign
pool, the next foreign pool appears in the CLI, and so on.
Identify
This command helps you identify disk drives included in a pool or pools by
blinking their LEDs. You must specify each pool by its name. (To find the name of a
pool, enter list.)
To start blinking disk drive LEDs, enter:
identify pool_name_list start
For example:
identify pool-1 pool-2 start (blinks the disk drives in pool-1 and pool-2)
identify pool-3 start (blinks the disk drives in pool-3)
identify pool_name_list stop
Import
Note Administrator access only. This command is used in conjunction with the
export command. See “Export” on page 49 for more information.
This command imports foreign pools to your iSCSI Storage Appliance. You will be
prompted to confirm the export before the task is completed.
To import a pool, enter:
import pool_name_list
yes
The pool is imported. This may take a few minutes.

Pool Commands
Info
In the pool context, this command displays information about one or more pools,
including status, cache settings, and the disk drives that comprise each pool. You
must specify each pool by its name. (To find the name of a pool, enter list.)
To display information about all pools associated with your iSCSI Storage
Appliance, enter:
info
To display information about a specific pool, enter:
info pool_name
To display information about multiple pools simultaneously, enter:
info pool_name_list
List
In the pool context, this command lists all known pools associated with your iSCSI
Storage Appliance:
list
Manage Commands
Use these commands to modify the settings for a specified pool. You must specify
the pool by its name. (To find the name of a pool, enter list.)
To enter a pool’s manage context, enter:
manage pool_name
Cache
This command enables or disables the cache settings for the pool. You can set the
read cache and write cache settings separately.
To change the cache settings for the pool, enter:
cache read_or_write enable_or_disable
For example:
cache read enable

Pool Commands
Identify
This command helps you identify the disk drives included in the pool by blinking
its LEDs:
identify
identify stop
Info
In a pool’s manage context, this command displays information about the pool,
including its status, cache settings, and disk drives that comprise the pool:
info
Rename
This command changes the name of the pool:
rename
Spare Commands
In a pool’s manage context, these commands create and remove designated hot
spares for the pool. You can also use this command to view a list of the pool’s
existing hot spares.
To enter the pool’s spare context, enter:
spare
• Add—This command designates a specified disk drive as a dedicated hot spare.
Only disk drives that are available (not used in any existing pools) can be
designated as hot spares. You must specify the disk drive by its ID number. (To
find a disk drive’s ID number, exit the pool context and enter device list.)
add disk_drive_ID
The disk drive is immediately designated as a dedicated hot spare.
• List—This command lists the disk drives in your iSCSI Storage Appliance that
are designated as dedicated hot spares for the pool:
list
• Remove—This command removes the dedicated hot spare designation from a
disk drive. You must specify the disk drive by its ID number. (To find a disk
drive’s ID number, exit the pool context and enter device list.)
remove disk_drive_ID

Pool Commands
Task Rate
This command sets the speed of whatever job is currently running on the pool
(building, rebuilding, synchronizing, or verifying). You can change this setting to
high, medium, or low.
To change a job’s speed, enter:
task rate speed
Verify
This command begins a background verification on the pool:
verify
To stop all running background verifcation jobs, see “Verify Commands” on page 55.
Migrate
This command modifies a specified pool by changing its RAID level, stripe depth,
and/or list of disk drives that comprise the pool.
This table lists supported RAID-level migrations. Ensure that you have enough
available disk drives to support the new RAID level.
From RAID Level To RAID Level

Simple Volume RAID 1
RAID 0 RAID 5 or RAID 10
RAID 1 Simple Volume, RAID 5, or RAID 10
RAID 5 RAID 0, RAID 10, or RAID 6
RAID 6 RAID 5
RAID 10 RAID 0 or RAID 5
Note You can also migrate from RAID 1 or RAID 5 to RAID 0. If the pool has a
spare drive associated with it, the RAID 0 pool retains the spare drive.
You must specify the pool by its name. (To find a pool’s name, enter list. To view a
pool’s other settings, enter info.) You must specify disk drives by their ID number.
(To find a disk drive’s ID, exit the pool context and enter device list.) You will be
prompted to confirm the migration before the task completes.

Pool Commands
The complete command syntax is:

migrate pool_name RAID_level stripe_depth disk_drive_ID_list
Where:
• pool_name is the name of the pool
• RAID_level is either the existing RAID level or a new RAID level for the pool
• stripe_depth is either the existing stripe depth or a new stripe depth for the pool
• disk_drive_ID_list is either the existing or a new list of disk drives (by disk drive
IDs) comprising the pool
For example, to migrate an existing pool with RAID 1, a stripe depth of 128, and two
disk drives (ID 0 and 256), to a RAID 5 pool with the same stripe depth, enter:
migrate pool-1 raid5 128 0 256 512
yes
Spare Commands
Use these commands to designate a global hot spare for your iSCSI Storage
Appliance. You can also use this command to remove a hot spare designation, or to
view a list of existing hot spares on your iSCSI Storage Appliance.
To enter the spare context, enter:
spare
Add
This command designates a specified disk drive as a global hot spare. Only disk
drives that are available (not used in any existing pools) can be designated as hot
spares. You must specify the disk drive by its ID number. (To find a disk drive’s ID
number, exit the pool context and enter device list.)
add disk_drive_ID
The disk drive is immediately designated as a global hot spare.
List
This command lists the disk drives in your iSCSI Storage Appliance that are
designated as global hot spares:
list

Pool Commands
Remove
This command removes the global hot spare designation from a disk drive. You
must specify the disk drive by its ID number. (To find a disk drive’s ID number, exit
the pool context and enter device list.)
To remove the global hot spare designation from a disk drive, enter:
remove disk_drive_ID
Unused
This command lists any pool that contains no logical devices:
unused
Verify Commands
These commands change the background verification settings for all the pools on
your iSCSI Storage Appliance. To enter the verify context, enter:
verify
Rate
This command sets the speed of all background verification jobs. You can change
this setting to high, medium, or low.
To set the speed of all background verification jobs, enter:
rate speed
Start
This command begins a background verification job. All pools are checked.
start
Status
This command displays the current status of any running background verification
jobs, including its speed:
status
Stop
This command stops a running background verification job:
start

Quit Command
Quit Command
Use this command to exit the CLI:
quit
Note Optionally, enter a shorthand version of the command: q.
Route Commands
Use the commands in this section to control static routes on your IP SAN. To enter
the route context, enter:
route
Add
This command adds a new static route for your iSCSI Storage Appliance. You must
specify this information in the command:
• Destination—The IP address or host name of the destination system and the
netmask bits of the destination system, in this format: IP address/netmask bits
• Gateway—The IP address (and interface name, if required) of the gateway server
on your IP SAN.
To add a new static route, enter:
add destination gateway interface_name
For example:
add 123.456.789.0/12 10.20.300.402 eth3
or
add 123.456.789.0/12 10.20.300.409

Route Commands
Delete
This command removes an existing static route. You must specify the destination,
netmask, and gateway of the destination system in the command. (See the previous
section for definitions of these values.)
To delete a static route, enter:
delete destination gateway interface_name
For example:
delete 123.456.789.0/12 10.20.300.402 eth3
or
delete 123.456.789.0/12 10.20.300.409
Info
In the route context, this command displays all static routes by destination. The
netmask, gateway, and Ethernet port information for each route is also included.
info
List
In the route context, this command lists all static routes, including the destination,
netmask, and gateway:
list

Service Info Command

This command displays the status of all services running on the iSCSI Storage
Appliance:
service info
The services listed include:
• dvtd—The event logging service
• inetd—Basic networking support (Linux)
• snmpd—SNMP service (Linux)
• datapathd—The core iSCSI storage service
• hdmd—The system health and monitoring service
• nadd—The Service Location Protocol (SLP) configuration change service
• evmd—The support service for datapathd
• mfsad—The storage array configuration service
• mgmtagent—The SAN management agent (for example, WinAgent on Windows
hosts)
• slpd—The SLP service (iSCSI target discovery)
• isnsd—The iSNS service (iSCSI target discovery)
• rhrdd—The storage array monitoring service
Setup Command
This command opens the Setup Wizard, which helps you enter the information
required to connect your iSCSI Storage Appliance to a local network.
For step-by-step instructions for using the Setup Wizard, see “Using the Wizard to
Configure Your iSCSI Storage Appliance” on page 71.

Show Command
Show Command
This command displays information about functional areas of your iSCSI Storage
Appliance. The information that displays is identical to the information that
displays when you use either the info or list command within a functional context.
To display information about a functional area, enter:
show functional_area
For example:
show initiator
or
show device
To display information about all functional areas, enter:
show all
Snapshot Commands
Use the commands in this section to create, delete, and modify snapshots on your
iSCSI Storage Appliance.
Snapshots created on systems running Windows 2003 are application-consistent;
snapshots created on systems running Windows XP, Windows Vista, Linux, or
VMware are file-consistent only. For more information about snapshots, refer to the
Snap Server 700i Series User’s Guide on the User CD.
To enter the snapshot context, enter:
snapshot
Note Snapshots are special logical devices. Many of the commands in this section
are identical to the commands in “Logical (Device) Commands” on page 36.
Abort
Note Administrator access only. For more information about rolling back a
snapshot, see “Rollback” on page 62.
This command stops a rollback in process. You must specify the name of the
snapshot that is being rolled back.
abort snapshot_name

Snapshot Commands
Create
This command creates a snapshot of a logical device. You must specify a name for
the snapshot; you must also specify the logical device by its name. (To find the
name of a logical device, exit the snapshot context, then enter device list.)
To create a snapshot, enter:
create snapshot_name device_name
Destroy
This command deletes a snapshot. You must specify the snapshot by its name. To
find the name of a snapshot, enter list.) You will be prompted to confirm the deletion
before the task is completed.
To delete a snapshot, enter:
destroy snapshot_name
yes
The snapshot is deleted immediately.
Down
This command takes a snapshot offline. You might want to do this to temporarily
disallow login to that snapshot. You must specify the snapshot by its name. To find
the name of a snapshot, enter list.) You will be prompted to confirm the command
before the task is completed.
To take down a snapshot, enter:
down snapshot_name
yes
The snapshot is taken offline immediately. Bringing down a snapshot does not
make it inconsistent in any way.

Snapshot Commands
Info
In the snapshot context, this command displays information about one or more
snapshots, including status, the amount of space used, and auto-discovery control
lists. You must specify each snapshot by its name. (To find the name of a snapshot,
enter list.)
To display information about all snapshots associated with your iSCSI Storage
Appliance, enter:
info
To display information about a specific snapshot, enter:
info snapshot_name
To display information about multiple snapshots simultaneously, enter:
info snapshot_name_list
List
In the snapshot context, this command lists all known snapshots associated with
your iSCSI Storage Appliance:
list
Manage Commands
Note Administrator access only, except for the info command.
Use these commands to modify a specified snapshot. You must specify the snapshot
by its name. (To find the name of a snapshot, enter list.) To enter the manage context
for a snapshot, enter:
manage snapshot_name
Allow
For more information, see “Allow” on page 39.
Authentication
For more information, see “Authentication” on page 39.
Chapusers Commands
For more information, see “Chapusers Commands” on page 40.
Deny
For more information, see “Deny” on page 40.

Snapshot Commands
Info
In the manage context, this command displays information about the snapshot,
including its status, the amount of space used, and its auto-discovery control list:
info
Interface
For more information, see “Interface” on page 41.
Rename
This command sets a new name for the snapshot:
rename new_snapshot_name
Sessions Commands
For more information, see “Sessions Commands” on page 42.
Rollback
This command rolls back a snapshot. You must specify the snapshot by its name.
(To find the name of a snapshot, enter list.)
rollback snapshot_name
Up
This snapshot returns a ‘downed’ (offline) snapshot to normal, online status. You
must specify the snapshot by its name. (To find the name of a snapshot, enter list.)
up snapshot_name

System Commands
System Commands
Use the commands in this section to change the settings of your iSCSI Storage
Appliance.
To enter the system context, enter:
system
Date
This command sets a new date or time on your iSCSI Storage Appliance. You can
also use this command to view the current date and time setting.
Note 1) Your iSCSI Storage Appliance appliance uses the time setting for event
timestamps only. 2) The Adaptec OnTarget operating system does not
automatically adjust the time setting on your iSCSI Storage Appliance to
accommodate Daylight Saving Time. 3) Only users with Administrator access can
change the date and time setting.
Notes
To view the current date and time on your iSCSI Storage Appliance, enter:
date
To set a new date or time on your iSCSI Storage Appliance, enter:
date absolute_date
or
date relative_period
For example, to change the date and time to 6:00 am July 25, 2007, enter:
date 06:00:00@07/25/07
or , to move the time ahead by three hours, enter:
date +3h
Note For more information about the absolute_date and relative_period parameters
used with the date command, see the "Glossary".

System Commands
Defaults
This command returns your iSCSI Storage Appliance to its factory default settings.
You will be prompted to confirm the command before the appliance is reset.
Caution After you enter and confirm this command, your iSCSI Storage Appliance
is restarted automatically. Stop all active applications before you begin.
To return your iSCSI Storage Appliance to its factory default settings, enter:
defaults
yes
The appliance is returned to its factory default settings and is restarted
automatically.
Halt
This command shuts down your iSCSI Storage Appliance. You will be prompted to
confirm the command before the appliance is shut down.
is powered down. Stop all active applications before you begin.
To shut down your iSCSI Storage Appliance, enter:
halt
yes
The appliance is powered down.
Info
In the system context, this command displays information about your iSCSI Storage
Appliance and the Adaptec OnTarget operating system, including uptime status
and firmware image version:
info

System Commands
Keyboard
This command changes the configuration of the keyboard you are using with your
iSCSI Storage Appliance. The default setting is US (American English). You can
choose from these configuration codes:
• de—German (QWERTZ configuration)
• es—Spanish (QWERTY configuration)
• fr—French (AZERTY configuration)
• it—Italian (QWERTY configuration)
• uk—British English (QWERTY configuration)
• us—American English (QWERTY configuration)
To change the keyboard configuration, enter:
keyboard configuration_code
For example:
keyboard uk
Reboot
This command shuts down and restarts your iSCSI Storage Appliance. You will be
prompted to confirm the command before the appliance is shut down and restarted.
is powered down and then restarted. Stop all active applications before you begin.
To shut down and restart your iSCSI Storage Appliance, enter:
reboot
yes
The appliance is powered down and restarted.
Status
This command displays the current status of your iSCSI Storage Appliance:
status
Note To clear existing warning or error events and return the appliance status to
normal, use the “Events Commands” on page 19.

System Commands
Timezone
This command sets the time zone for your iSCSI Storage Appliance. You can also
use this command to view the current time zone setting.
Note Only users with Administrator access can change the time zone setting.
To change the time zone setting, enter a positive (+) number to indicate the number
of hours ahead of Greenwich Mean Time (GMT) or a negative (-) number to indicate
the number of hours behind GMT.
To view the current time zone setting, enter:
timezone
To change the time zone setting, enter:
timezone hours_+/-_GMT
For example:
timezone -5
TSID Commands
Use these commands to view or set your iSCSI Storage Appliance’s Technical
Support Identification (TSID) number.
Info
This command displays your iSCSI Storage Appliance’s TSID number:
tsid info
SetID
This command sets a TSID number for your iSCSI Storage Appliance. To set the
TSID number, enter:
tsid setid
When prompted, enter the 12-character TSID. For example:
123234345456

UPS Commands
UPS Commands
Use the commands in this section to modify the settings of your Uninterruptible
Power Supply (UPS).
To enter the ups context, enter:
ups
Info
In the ups context, this command displays the current settings for the UPS:
ups
Monitor Commands
Use these commands to add, modify, and delete UPS monitors. Changes made
using these commands are implemented immediately.
Disable
To disable the existing UPS monitor, enter:
monitor disable
Local
To define the local system as the UPS monitor, enter:
monitor local
Remote
To define a remote system as the UPS monitor, enter:
monitor remote remote_monitor_IP_address
For example:
monitor remote 10.20.300.400
SNMP
To specify that the UPS will be monitored using SNMP, enter:
monitor snmp UPS_IP_address
For example:
monitor snmp 10.20.300.401

UPS Commands
Permit Commands
Use these commands to specify which remote host systems are permitted to
monitor the UPS. You must specify the host systems by their IP addresses.
Note You must have a local UPS defined before you can add remote systems to the
permit list.
Changes made using permit commands are implemented immediately. To enter the
permit context, enter:
permit
Add
This command adds a host system to the permit list:
add host_system_IP_address
List
This command displays the permit list, which includes the IP addresses of all host
systems that are permitted to monitor the UPS:
list
Remove
This command removes a host system from the permit list:
remove host_system_IP_address
Status
This command displays basic information about which UPS is being monitored
(local or remote), if any. If a remote UPS is being monitored, its IP address is also
listed.
status

UPS Commands
Threshold Unit
This command sets the halt unit threshold, the level at which the iSCSI Storage
Appliance is shut down gracefully to protect your data from a failing battery. The
default setting is 2 minutes. You can set the halt unit threshold to any value from 2
to 50 minutes.
To set the halt unit threshold to 5 minutes, enter:
threshold unit 5

UPS Commands

Appendix A
Using the Wizard to Configure Your

iSCSI Storage Appliance
The CLI includes a Setup Wizard, which helps you enter the information required
to connect your iSCSI Storage Appliance to a local network.
The Setup Wizard opens automatically if your iSCSI Storage Appliance is in the
factory default state when you start the CLI.
You can also run the Setup Wizard at any time by using the setup command.
Note You must be logged in as Administrator to access the setup command.
Before You Begin

Prepare these values for the iSCSI Storage Appliance, as required:
• A name for the iSCSI Storage Appliance (the host name); the name can be any
combination of alphabetical and/or numerical characters
• The network domain to which the iSCSI Storage Appliance belongs; the name can
be any combination of alphabetical and/or numerical characters
• A password for Administrator-level (full) access to the CLI, if required
• A password for Operator-level (limited) access to the CLI, if required
Note The Administrator- and Operator-level passwords both default to admin if
you don’t customize them.
• IP addresses for each Ethernet Port on the iSCSI Storage Appliance
• The netmask of the iSCSI Storage Appliance
• The IP address to be used for broadcasts
• Optional:
• Default gateway address—The name or IP address of a router where packets
are sent if their destinations are not defined
• DNS server IP addresses—IP addresses of up to 3 systems that will act as DNS
servers
Note Adaptec highly recommends that you record the values you enter during this
task and store them for future reference.

Working in the Setup Wizard
Working in the Setup Wizard

When the Wizard opens, it prompts you to enter the values you prepared in “Before
You Begin” on page 71.
You can also use these three commands in the Wizard, if required:
Command Function
*abort Quit the Setup Wizard without saving any new settings
*back Go to re-enter the previous value
help or ? Describe the current options
If a question has a predefined or default answer, the answer appears beside the
prompt in square brackets [ ].
Configuring Your iSCSI Storage Appliance

To configure the iSCSI Storage Appliance:
1 Connect to the appliance, following the instructions in “Accessing the CLI” on
page 3, then power it on.
If the appliance is in the factory default state, the Setup wizard opens
automatically. Skip to Step 3.
2 Enter the Administrator password, then enter:
setup
The Setup Wizard opens.
Enter a number to select the keyboard configuration you are using. The default is 6,
the American (US) English configuration.
3 At the Hostname prompt, enter a name for the iSCSI Storage Appliance. Use
alphanumeric characters. For example:
Hostname or Hostname1
4 Enter the network domain to which the iSCSI Storage Appliance belongs. Use
alphanumeric characters. For example:
Domain or Domain1
5 Press Enter to accept the current system date, or enter a new date. Use this format:
[hh:mm:ss@mm/dd/yy]

6 Press Enter to accept the current time zone, or enter a new time zone. Use this
format:
GMT+12 to GMT-12
7 Enter yes (the whole word, not just “y”) to create a new Administrator password.
Enter the new password, then enter it again as confirmation.
If you don’t enter a new Administrator password, the password defaults to
admin.
8 Enter a new Operator password, then enter it again as confirmation.
9 Press Enter to accept the DHCP default setting (No).
10 Enter a default gateway address (the name or IP number of a router to which
packets for destinations that do not have routes defined for them in the system
should be sent).
If you are not using a gateway address, press Enter to skip to the next prompt.
11 Enter the IP addresses of your DNS servers (up to three are supported).
If you are not using DNS servers, press Enter to skip to the next prompt.
12 Enter the IP address for the iSCSI Storage Appliance. Use this format:
xxx.yyy.zzz.aaa
13 Enter the netmask of the iSCSI Storage Appliance. Use this format:
xxx.yyy.zzz.aaa
14 Enter the IP address to be used for broadcasts. Use this format:
xxx.yyy.zzz.aaa
When the configuration is complete, the host name given to the iSCSI Storage
Appliance displays. For example:
myhostname#
15 Enter quit to log out of the CLI, or any other command to continue working in the
CLI.
Caution To avoid permanent data loss, do not modify the default BIOS settings of
the RAID controller in your iSCSI Storage Appliance. To safely configure or modify
the appliance, use either the CLI or Adaptec Storage Manager only.
73

Appendix B
Updating the Adaptec OnTarget

Operating System
As newer versions of the Adaptec OnTarget operating system become available,
you can update your iSCSI Storage Appliance. Your iSCSI Storage Appliance stores
two versions (or images) at a time, so that if you experience problems with a newly
downloaded one, you can revert to the previous image (see page 77).
This appendix explains how to update to a new image using the CLI. You can also
update to a new image using Adaptec Storage Manager. Refer to the Snap Server
700i Series User’s Guide on the Adaptec OnTarget User CD for instructions.
Note This task is recommended for advanced users only. If you are also updating to
a newer version of Adaptec Storage Manager, complete that update before
updating the Adaptec OnTarget operating system image. Refer to the Snap Server
700i Series User’s Guide on the Adaptec OnTarget User CD for instructions.
Uploading a New Image

New images for your iSCSI Storage Appliance are posted on the Adaptec Web site
at www.adaptec.com. Image files have a .upgrade file extension and can be
uploaded using http, ftp or ikxmodem.
Once you have downloaded a new image, follow these instructions to update your
iSCSI Storage Appliance.
Caution Because all updated iSCSI Storage Appliances will be automatically
rebooted after the image has been updated, stop all active applications before you
begin.
To upload a new image to your iSCSI Storage Appliance, enter:
image upload URL
For example:
image upload http://imageserver/x86.1345.upgrade
or
image upload ftp://10.20.300.400/images/x86.1345.upgrade

Checking the Current Image
Alternatively, use this command to upload the image through your iSCSI Storage
Appliance’s serial port:
image upload ikxmodem
When prompted to confirm the upload, enter:
yes
The image is uploaded and your iSCSI Storage Appliance is automatically restarted.
(This may take a few minutes.)
Checking the Current Image

To see what image is currently running, enter:
image info
This information appears:
Image Image Version Date Version

Number Name and Time Number
In the figure above, Image 2 is the image running currently. Image 2 is also the image
that will be used the next time the iSCSI Storage Appliance is restarted or powered on.

Reverting to the Previous Image

Your iSCSI Storage Appliance stores two versions (or images) of Adaptec OnTarget
at a time. If you experience problems with a newly downloaded image, you can
revert to the previous one. You can also return from the previous image to the new
one, if required.
Note Reverting to a previous image is not always supported, as some upgrades are
not backward-compatible. If upgrading to a new image will make it impossible to
revert to a previous image, without the loss of configuration data, you will receive a
warning when you download the new image.
To see which images are available, enter:
image info
To choose the image to use the next time the iSCSI Storage Appliance is restarted or
powered on:
1 Enter this command, specifying the image by its number:
boot image_number
For example, to change the default boot image to image number 2, enter:
boot 2
The CLI confirms that the image you specified is now the default boot image.
2 To apply the image, restart your iSCSI Storage Appliance.
Caution Do not make any configuration changes before you restart the appliance.
Any changes that you make will be lost when the appliance restarts.
3 To check that the image you selected is running, enter:
image info
then check that Current Image is the image you selected.
Updating the Adaptec OnTarget Operating System 77


Appendix C
Command Tree
This section provides a map to the commands available in the CLI. For detailed
information about each command and its optional parameters, see “Commands and
Parameters” on page 11.
Clone Commands
Abort
Create
Info
List
Device Commands
Identify
Info
Initialise
List
Manage Commands
Unused
Check
Dump
Ping
Tracert

Events Commands
Clear
Inactive Commands
Info
Report
Help Command
Image Commands
Boot
Info
List
Upload
Initiator Commands
Create
Destroy
Info
List
Local
Manage Commands
Alias
Align
Disco
Info
Piggyback
Ping
Interface Commands
Info
List
Manage Commands
Broadcast
DHCP

Down
Interfacetype
Info
IP
MTU
Netmask
Rename
Speed
Statistics
Up
Statistics
iSNS Commands
Info
server
License Commands
Info
Key
CHAP Commands
Info
Password
User
Create
Destroy
Down
Info
List
Manage Commands
Allow
Authentication
Command Tree 81
Chapusers Commands
Deny
Growby
Growto
Info
Interface
Rename
Sessions
Sessions Commands
Info
List
Reset
Up
Network Commands
DNS
Domain
Gateway
Hostname
Info
NTP
SANname
Operator Command
Password Command
Pool Commands
Alarm
Create
Destroy
Export
Identify
Import

Info
List
Manage Commands
Cache
Identify
Info
Rename
Spare Commands
Task Rate
Verify
Migrate
Spare Commands
Add
List
Remove
Unused
Verify Commands
Rate
Start
Status
Stop
Quit Command
Route Commands
Add
Delete
Info
List
Setup Command
Command Tree 83
Show Command
Snapshot Commands
Abort
Create
Destroy
Down
Info
List
Manage Commands
Allow
Authentication
Chapusers Commands
Deny
Info
Interface
Rename
Sessions Commands
Rollback
Up
System Commands
Date
Defaults
Halt
Info
Keyboard
Reboot
Status
Timezone

TSID Commands
Info
SetID
UPS Commands
Info
Monitor Commands
Disable
Local
Remote
SNMP
Permit Commands
Add
List
Remove
Status
Threshold Unit
Command Tree 85

Command Line Interface: User's Guide

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Command Line Interface: User's Guide

Uploaded by

Copyright:

Available Formats

Command Line Interface

The CLI and Adaptec Storage Manager ...................................................1

Finding More Information ......................................................................2

Service and Technical Support ................................................................2

Chapter 1 Accessing the CLI ................................................................................ 3

Access Levels and Passwords ..................................................................4

Chapter 2 Working in the CLI .............................................................................. 7

About Case-sensitivity and Spaces ..........................................................8

Viewing Long Lists or Reports..................................................................8

Using the Tab Key to Complete Commands..............................................9

Command Line Editing ...........................................................................9

Leaving a Context and Exiting the CLI ....................................................10

Chapter 3 Commands and Parameters .............................................................. 11

How this Chapter is Organized.............................................................11

About the Command Format in This Chapter..........................................12

Administrator Command ......................................................................13

Snap Server 700i User’s Guide 1

Device Commands ...............................................................................15

Diagnostics Commands ........................................................................17

Help Command ...................................................................................23

Interface Commands ............................................................................29

iSNS Commands .................................................................................35

License Commands ..............................................................................35

Logical (Device) Commands..................................................................36

Network Commands ............................................................................44

Operator Command ............................................................................46

Password Command ............................................................................46

Pool Commands ..................................................................................47

Service Info Command .........................................................................58

Setup Command ..................................................................................58

Show Command ..................................................................................59

Snapshot Commands ...........................................................................59

Working in the Setup Wizard ...............................................................72

Configuring Your iSCSI Storage Appliance ............................................72

2 Snap Server 700i User’s Guide

Checking the Current Image ................................................................. 76

Reverting to the Previous Image ............................................................ 77

Chapter C Command Tree..................................................................................79

The Command Line Interface (CLI) software is a terminal-based command line

About this Guide

Notes and Cautions

The CLI and Adaptec Storage Manager

Finding More Information

Source and Location Content

Service and Technical Support

2 Command Line Interface User’s Guide

Accessing the CLI

Using a Terminal Emulation Program

Command Line Interface User’s Guide 3

Access Levels and Passwords

Operators can... Operators can’t...

Changing from One Access Level to the Other

4 Command Line Interface User’s Guide

Changing Access Level Passwords

Chapter 1 Accessing the CLI 5

6 Command Line Interface User’s Guide

Working in the CLI

About the Main Mode and Functional Contexts

Command Line Interface User’s Guide 7

About Case-sensitivity and Spaces

Viewing Long Lists or Reports

8 Command Line Interface User’s Guide