Command Line Interface

(1)

Command Line Interface

User’s Guide

(2)

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.

(3)

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

(4)

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

(5)

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

(6)

(7)

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

(12)

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.

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

Source and Location Content 700i Series Quick Start Guide

Product Packaging and Web

Details package contents, identifies server 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 Product Package and Web

Details package contents, identifies expansion 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

User Guide User CD and Web

Adaptec Storage Manager Online Help

Provides an overview of the configuration and maintenance of the Snap Server 700i Series, gives detailed instructions on using Adaptec Storage Manager to configure and manage your iSCSI storage, and provides hardware specifications for the Snap Server 700i Series and the SANbloc S50 expansion array.

Readme.txt User CD

Contains late-breaking information, corrections, and known issues concerning the Snap Server 700i Series.

Field Service Documentation Service CD and Web

Provides detailed instructions for the replacement of disk drives, adapter cards, power assemblies, slide rails, and other hardware components.

(13)

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:

(14)

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.

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.

Operators can... Operators can’t... Blink a hardware component, such as a disk

drive or iSCSI Storage Appliance

Provision storage to an iSCSI Storage Host View Properties window of all storage

components of your IP SAN

Create, modify, or delete a pool, volume, or 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

(15)

Access Levels and Passwords

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

(16)

(17)

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:

Within each functional context are action commands. For example, these commands are available in the initiator context:

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:

• administrator • interface • route

• clone • isns • service

• controller • license • set

• device • logical • show

• diagnostics • network • snapshot • events • operator • system

• image • password • ups

• initiator • pool

• create • info • local

(18)

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

(19)

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

(20)

Leaving a Context and Exiting the CLI

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

(21)

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.

(22)

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

(23)

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

Administrator 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 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:

(24)

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:

(25)

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.)

(26)

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:

(27)

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:

(28)

Diagnostics Commands

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:

pinghost_IP_address

To ping an iSCSI Storage Host for ten seconds, enter:

pinghost_IP_address timeout 10

To ping an iSCSI Storage Host five times, enter:

pinghost_IP_address count 5

To ping an iSCSI Storage Host five times for three seconds each time, enter:

pinghost_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:

pinghost_IP_address source eth0 or

(29)

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.

tracerthost_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.)

(30)

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".

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:

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)

(31)

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.

(32)

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:

(33)

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".

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.

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)

(34)

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.

(35)

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:

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: Image Number Image Name Version Date and Time Version Number

(36)

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

(37)

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:

(38)

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

(39)

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:

(40)

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:

(41)

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:

(42)

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

(43)

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).

(44)

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:

(45)

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:

(46)

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

Logical (Device) Commands

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:

(47)

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:

create logical_device_name pool_name logical_device_size

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:

(48)

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 device by its name. (To find the name of a logical device, enter list.) You will be 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:

(49)

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:

(50)

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

(51)

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

(52)

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:

infological_device_name

To view iSCSI session information about multiple logical devices simultaneously, enter:

info logical_device_name_list List

In the sessions context, this command lists all current iSCSI sessions:

(53)

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:

resetlogical_device_name

yes

Up

This command brings up 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 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

(54)

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.

(55)

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:

gatewayserver_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

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.

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.

Command Line Interface