Preface

Use the Sun StorEdgetrademark 3000 Family Command-Line Interface (Sun StorEdge CLI) to manage Sun StorEdge 3000 family array controllers, examine and configure Sun StorEdge 3000 family arrays, save and restore configuration data, and download new firmware to RAID controllers and Just a Bunch of Disks (JBODs). The Sun StorEdge CLI communicates with the storage subsystem using inband or out-of-band communication with the RAID controller over low voltage differential (LVD) SCSI, Fibre Channel, or Ethernet connections.

The commands in this document apply to the:



Note - The Sun StorEdge 3120 SCSI array is a standalone JBOD. It does not have a RAID controller to manage the disks. For a list of the Sun StorEdge CLI commands that work with JBODs, see JBOD Commands.


For instructions on installing the Sun StorEdge CLI, refer to the Sun StorEdge 3000 Family Software Installation Guide.

This guide is written for experienced system administrators who are familiar with Sun hardware and software products.


How This Book Is Organized

This book covers the following topics:

Chapter 1 introduces the Sun StorEdge CLI and provides an overview.

Chapter 2 provides the available system function commands with sample code.

Chapter 3 provides the available controller and disk commands with sample code.

Chapter 4 provides the available host and drive channel commands with sample code.

Chapter 5 provides the available Sun StorEdge CLI commands with sample code for logical drives, partitions, and logical volumes.

Chapter 6 provides the firmware, disk drive, SCSI Enclosure Services (SES), SCSI Accessed Fault-Tolerant Enclosure (SAF-TE), programmable logic device (PLD), and serial ATA (SATA) router and path controller show and download commands.

Appendix A contains a list of the Sun StorEdge CLI options, a list of Sun StorEdge CLI commands for RAID arrays, and a list of Sun StorEdge CLI commands for JBODs.

Appendix B lists error and status messages and error codes.

Appendix C includes a list of the items included in the output of the show configuration command and the sample XML output of the show configuration XML file command.

The Glossary provides RAID terminology and definitions used throughout the product documentation.


Using UNIX Commands

This document does not contain information on basic UNIX® commands and procedures such as shutting down the system, booting the system, and configuring devices. See the following for this information:

http://docs.sun.com


Shell Prompts


Shell

Prompt

C shell

machine-name%

C shell superuser

machine-name#

Bourne shell and Korn shell

$

Bourne shell and Korn shell superuser

#


Table with examples of the types of shell prompts that are used in this book.


Typographic Conventions

The Sun StorEdge CLI syntax and examples use the typeface conventions described in the following table.


Typeface[1]

Meaning

Examples

AaBbCc123

The names of commands, files, and directories; on-screen computer output

Edit your.login file.

Use ls -a to list all files.

% You have mail.

AaBbCc123

What you type, when contrasted with on-screen computer output

% su

Password:

AaBbCc123

Book titles, new words or terms, words to be emphasized. Replace command-line variables with real names or values.

Read Chapter 6 in the User’s Guide.

These are called class options.

You must be superuser to do this.

To delete a file, type rm filename.


The Sun StorEdge CLI syntax and examples use the special characters described in the following table.


Character

Description

Example

[ ] brackets

Brackets indicate that the option or argument is optional. If the brackets are omitted, the argument must be specified.

mute [controller]

{ } braces

Braces indicate that the enclosed options or arguments are mutually dependent. Treat everything enclosed in braces as a unit.

check parity {ld-index | ld-id}

| separator

A separator indicates that only one of the arguments separated by this character can be specified.

shutdown logical-drive ld-index | ld-id

Table with descriptions and examples of the typographic conventions that are used in this book.


Related Documentation

The following table contains a list of related software documentation. For a complete list of all related documentation, refer to the Sun StorEdge 3000 Family Installation, Operation, and Service Manual for your array.


Title

Part Number

Sun StorEdge 3120 SCSI Array Release Notes

816-7955

Sun StorEdge 3310 SCSI Array Release Notes

819-7109

Sun StorEdge 3320 SCSI Array Release Notes

817-7660

Sun StorEdge 3510 FC and 3511 SATA Array Release Notes

817-6597

Sun StorEdge 3000 Family 2.5 Software Installation Guide

817-3764

Sun StorEdge 3000 Family RAID Firmware 4.2x User’s Guide

817-3711

Sun StorEdge 3000 Family Configuration Service 2.5 User’s Guide

817-3337

Sun StorEdge 3000 Family Diagnostic Reporter 2.5 User’s Guide

817-3338

Sun StorEdge 3000 Family RAID Controller Firmware Migration Guide

819-6573


Table listing other documents that are related to this book or product.


Accessing Sun Documentation

All Sun StorEdge 3000 family documentation is available online in both PDF and HTML format at the following location:

http://www.sun.com/products-n-solutions/hardware/docs/Network_Storage_Solutions/Workgroup/

You can view, print, or purchase a broad selection of Sun documentation at:

http://www.sun.com/documentation


Contacting Sun Technical Support

For late-breaking news and troubleshooting tips, review the Release Notes for your array located in the appropriate directory:

http://www.sun.com/products-n-solutions/hardware/docs/Network_Storage_Solutions/Workgroup/

If you have technical questions about this product that are not answered in the documentation, go to:

http://www.sun.com/service/contacting

To initiate or check on a USA-only service request, contact Sun support at:

800-USA-4SUN

To obtain international technical support, contact the sales office of each country at:

http://www.sun.com/service/contacting/sales.html


508 Accessibility Features

The Sun StorEdge documentation is available in Section 508-compliant HTML files that can be used with assistive technology programs for visually impaired personnel. These files are provided on the Documentation CD for your product as well as on the web sites identified in the previous “Accessing Sun Documentation” section. Additionally, the software and firmware applications provide keyboard navigation and shortcuts, which are documented in the user’s guides.


Sun Welcomes Your Comments

Sun is interested in improving its documentation and welcomes your comments and suggestions. You can submit your comments by going to:

http://www.sun.com/hwdocs/feedback

Please include the title and part number of your document with your feedback: Sun StorEdge 3000 Family CLI 2.5 User’s Guide, part number 817-4951-18.

 


1 (TableFootnote) The settings on your browser might differ from these settings.