Command Line Interface

Transcription

1 Command Line Interface User s Guide for Adaptec OnTarget -Powered Snap Servers

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

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 reproduce 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

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 of the Federal Acquisition Regulations and its successors and 48 C.F.R 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: or by writing to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 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.

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 (408)

6

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

8 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 Before You Begin...71 Working in the Setup Wizard...72 Configuring Your iscsi Storage Appliance Snap Server 700i User s Guide

9 Appendix B Updating the Adaptec OnTarget Operating System...75 Uploading a New Image Checking the Current Image Reverting to the Previous Image Chapter C Command Tree

10 4 Snap Server 700i User s Guide

11 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 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

12 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 Source and Location 700i Series Quick Start Guide Product Packaging and Web SANbloc S50 Quick Install Guide Product Package and Web Snap Server 700i Series User Guide User CD and Web Adaptec Storage Manager Online Help Readme.txt User CD Field Service Documentation Service CD and Web Content 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. 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. 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. Contains late-breaking information, corrections, and known issues concerning the Snap Server 700i Series. Provides detailed instructions for the replacement of 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 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 you with a response. To obtain additional service or technical support for your Snap Server 700i Series, call Command Line Interface User s Guide

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: P:\>telnet Command Line Interface User s Guide 3

14 Access Levels and Passwords 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... Blink a hardware component, such as a disk drive or iscsi Storage Appliance View Properties window of all storage components of your IP SAN Verify a pool Create a hot spare View event logs Save a support archive Change Adaptec Storage Manager preferences View online Help Operators can t... Provision storage to an iscsi Storage Host Create, modify, or delete a pool, volume, or logical device Mirror a volume or modify or break a mirrored volume Create or delete a snapshot 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 4 Command Line Interface User s Guide

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 Server 700i Series User s Guide). Chapter 1 Accessing the CLI 5

16 Access Levels and Passwords 6 Command Line Interface User s Guide

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: 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. Command Line Interface User s Guide 7

18 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... N or F or the spacebar D or J or Enter B U or K P or < or Home E or > or End R or F5 Q H or? or F1 To... Move down to the next full page of the report Move down to next line of the report Move up to the previous full page of the report Move up to previous line of the report Go to the beginning of the report Go to the end of the report Refresh the current page Exit the report Display this list of keyboard shortcuts 8 Command Line Interface User s Guide

19 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 Ctrl+A Ctrl+B Ctrl+C Ctrl+D Ctrl+E Ctrl+F Ctrl+H; or Backspace Ctrl+K Ctrl+N; or down arrow Ctrl+P; or up arrow Ctrl+S Ctrl+T Ctrl+U Esc B Esc D Esc F Function Jump to the start of the line Move the cursor back (left) one character Escape and terminate a lengthy job Delete the character at, or in front of, the cursor Jump to the end of the current line Move the cursor forward (right) one character Erase a mistake when entering a command Delete from the cursor forward (right) to the end of the line Display the next command in the command history Display the previous command in the command history Search for a command in the command history Transpose two characters Delete a complete line Move the cursor back (left) one word Delete from the cursor to end of the word Move the cursor forward (right) one word Chapter 2 Working in the CLI 9

20 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. 10 Command Line Interface User s Guide

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. 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 Command Line Interface User s Guide 11

22 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 12 Command Line Interface User s Guide

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

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: list 14 Command Line Interface User s Guide

25 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 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 Chapter 3 Commands and Parameters 15

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: unused 16 Command Line Interface User s Guide

27 Diagnostics Commands 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 Chapter 3 Commands and Parameters 17

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: 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 Command Line Interface User s Guide

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. tracert host_ip_address interface_name For example: tracert 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. Chapter 3 Commands and Parameters 19

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". 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 20 Command Line Interface User s Guide

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. Reporting All Events To generate a report of all events in the event log, enter: report all Chapter 3 Commands and Parameters 21

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: report level error 22 Command Line Interface User s Guide

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". 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. Chapter 3 Commands and Parameters 23

34 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 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. 24 Command Line Interface User s Guide

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: Image Image Number Name Version Date and Time Version 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 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.) Chapter 3 Commands and Parameters 25

36 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 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. 26 Command Line Interface User s Guide

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: local Chapter 3 Commands and Parameters 27

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 This command displays information about the iscsi initiator, including its IQN and settings: info 28 Command Line Interface User s Guide

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