Adaptec 2410SA - Serial ATA RAID Controller User manual

Adaptec Serial ATA RAID
2410SA Command Line
Interface
Software Reference Guide
R

ii
Copyright
© 2000 - 2003 Adaptec, Inc. All rights reserved. No part of this publication may be
reproduced, stored in a retrieval system, or transmitted in any form or by any means,
electronic, mechanical, photocopying, recording or otherwise, without the prior
written consent of Adaptec, Inc., 691 South Milpitas Blvd., Milpitas, CA 95035.
Trademarks
Adaptec, Adaptec Storage Manager, and the Adaptec logo are trademarks of
Adaptec, Inc., which may be registered in some jurisdictions.
Windows 2000 and Windows XP are trademarks of Microsoft Corporation in the US
and other countries, used under license.
All other trademarks are the property of their respective owners.
Changes
The material in this document is for information only and is subject to change
without notice. While reasonable efforts have been made in the preparation of this
document to assure its accuracy, Adaptec, Inc. assumes no liability resulting from
errors or omissions in this document, or from the use of the information contained
herein.
Adaptec reserves the right to make changes in the product design without reservation
and without notification to its users.
Disclaimer
IF THIS PRODUCT DIRECTS YOU TO COPY MATERIALS, YOU MUST HAVE
PERMISSION FROM THE COPYRIGHT OWNER OF THE MATERIALS TO AVOID
VIOLATING THE LAW WHICH COULD RESULT IN DAMAGES OR OTHER
REMEDIES.

iii
Contents
1 Getting Started
Audience 1-2
Supported Platforms 1-2
How to Use this Manual 1-2
Organization 1-3
Conventions 1-3
Related Documentation 1-4
2 Accessing the Command Line Interface
Accessing the CLI from the MS-DOS Prompt 2-2
Accessing the CLI from the Windows Start Button 2-2
Accessing the CLI from the NetWare Server Console 2-3
Accessing the CLI from the Linux/UNIX Prompt 2-3
3 Syntax and Conventions for CLI Commands
CLI Features 3-1
CLI Command Syntax 3-2
Class 3-3
Action 3-3
Object 3-3
Switch 3-3
Value 3-4
Parameter 3-4
Blank Space 3-4
CLI Parameter and Switch Value Types 3-4
boolean 3-5

iv
Adaptec SCSI RAID Software Reference Guide
integer 3-5
string 3-6
scsi_device 3-7
free_space 3-8
container 3-9
CLI Status Information 3-10
The Stat and Task Items 3-10
The Func Item 3-11
The Ctr and State Items 3-12
4 General Control Commands
close 4-2
Syntax 4-2
exit 4-2
Syntax 4-2
help, ? 4-2
Syntax 4-2
Parameters 4-2
Switches 4-2
history_size 4-3
Command Availability 4-3
Syntax 4-3
Parameters 4-3
open 4-3
Syntax 4-3
Parameters 4-3
Switches 4-4
reset_window 4-5
Command Availability 4-5
Syntax 4-5
toggle_more 4-5
Command Availability 4-5
Syntax 4-5
5 container Commands
container add_level 5-3

v
Adaptec SCSI RAID Software Reference Guide
Syntax 5-3
Parameters 5-3
Examples 5-3
Related Information 5-4
container create mirror 5-5
Syntax 5-5
Parameters 5-5
Switches 5-6
Examples 5-6
Related Information 5-8
container create mmirror 5-9
Notes 5-9
Syntax 5-9
Parameters 5-9
Switches 5-10
Examples 5-11
Related Information 5-12
container create mstripe 5-14
Notes 5-14
Syntax 5-14
Parameters 5-15
Switches 5-15
Examples 5-16
Related Information 5-18
container create mvolume 5-19
Notes 5-19
Syntax 5-19
Parameters 5-19
Switches 5-20
Examples 5-20
Related Information 5-23
container create raid5 5-24
Notes 5-24
Syntax 5-24
Parameters 5-24
Switches 5-25
Examples 5-27

vi
Adaptec SCSI RAID Software Reference Guide
Related Information 5-29
container create stripe 5-30
Notes 5-30
Syntax 5-30
Parameters 5-30
Switches 5-31
Examples 5-32
Related Information 5-34
container create volume 5-35
Notes 5-35
Syntax 5-35
Parameters 5-35
Switches 5-36
Examples 5-37
Related Information 5-38
container delete 5-40
Notes 5-40
Syntax 5-40
Parameters 5-40
Switches 5-40
Examples 5-41
Related Information 5-42
container extend file_system 5-43
Notes 5-43
Command And Switch Availability 5-44
Syntax 5-44
Parameters 5-44
Examples 5-44
Related Information 5-45
container extend mvolume 5-46
Command And Switch Availability 5-46
Syntax 5-46
Parameters 5-46
Examples 5-47
Related Information 5-49
container extend volume 5-50
Command And Switch Availability 5-50

vii
Adaptec SCSI RAID Software Reference Guide
Syntax 5-50
Parameters 5-50
Examples 5-51
Related Information 5-53
container list 5-54
Syntax 5-54
Parameters 5-54
Switches 5-54
Examples 5-55
Related Information 5-64
container lock 5-65
Syntax 5-65
Parameters 5-65
Examples 5-65
Related Information 5-66
container move 5-67
Notes 5-67
Syntax 5-67
Parameters 5-67
Examples 5-68
Related Information 5-68
container promote 5-69
Notes 5-69
Syntax 5-69
Parameters 5-69
Examples 5-70
Related Information 5-71
container readonly 5-72
Syntax 5-72
Parameters 5-72
Examples 5-72
Related Information 5-73
container readwrite 5-74
Syntax 5-74
Parameters 5-74
Examples 5-74
Related Information 5-75

viii
Adaptec SCSI RAID Software Reference Guide
container reconfigure 5-76
Notes 5-77
Syntax 5-77
Parameters 5-78
Switches 5-78
Examples 5-81
Related Information 5-82
container release_cache 5-83
Syntax 5-83
Parameters 5-83
Examples 5-83
Related Information 5-83
container remove drive_letter 5-84
Command Availability 5-84
Syntax 5-84
Parameters 5-84
Examples 5-84
Related Information 5-85
container remove failover 5-86
Syntax 5-86
Parameters 5-86
Examples 5-87
Related Information 5-87
container remove file_system 5-88
Command Availability 5-88
Syntax 5-88
Parameters 5-88
Examples 5-88
Related Information 5-89
container remove global_failover 5-90
Syntax 5-90
Parameters 5-90
Examples 5-90
Related Information 5-91
container restore RAID5 5-92
Syntax 5-92
Parameters 5-92

ix
Adaptec SCSI RAID Software Reference Guide
Examples 5-92
Related Information 5-93
container scrub 5-94
Syntax 5-94
Parameters 5-94
Switches 5-94
Examples 5-95
Related Information 5-96
container set cache 5-97
Notes 5-97
Syntax 5-97
Parameters 5-98
Switches 5-98
Examples 5-98
Related Information 5-99
container set failover 5-100
Syntax 5-100
Parameters 5-100
Examples 5-100
Related Information 5-101
container set global_failover 5-102
Syntax 5-102
Parameters 5-102
Examples 5-102
Related Information 5-103
container set io_delay 5-104
Syntax 5-104
Parameters 5-104
Examples 5-105
Related Information 5-106
container set label 5-107
Syntax 5-107
Parameters 5-107
Examples 5-107
Related Information 5-108
container show cache 5-109
Syntax 5-109

x
Adaptec SCSI RAID Software Reference Guide
Parameters 5-109
Examples 5-109
Related Information 5-110
container show failover 5-112
Syntax 5-112
Parameters 5-112
Examples 5-112
Related Information 5-112
container split 5-113
Syntax 5-113
Parameters 5-114
Examples 5-114
Related Information 5-116
container unlock 5-117
Syntax 5-117
Parameters 5-117
Examples 5-117
Related Information 5-118
container unmirror 5-119
Syntax 5-119
Parameters 5-119
Examples 5-119
Related Information 5-120
6 controller Commands
controller details 6-2
Syntax 6-2
Examples 6-2
Related Information 6-5
controller firmware compare 6-6
Syntax 6-6
Switches 6-6
Examples 6-6
Related Information: 6-6
controller firmware save 6-7
Syntax 6-7
Switches 6-7

xi
Adaptec SCSI RAID Software Reference Guide
Examples 6-7
Related Information: 6-8
controller firmware update 6-9
Syntax 6-9
Switches 6-9
Examples 6-9
Related Information: 6-9
controller list 6-10
Syntax 6-10
Parameters 6-10
Switches 6-10
Examples 6-10
Related Information 6-11
controller pause_io 6-12
Command And Switch Availability 6-13
Notes 6-13
Syntax 6-13
Parameters 6-13
Examples 6-13
Related Information 6-14
controller rescan 6-15
Syntax 6-15
controller reset_scsi_channel 6-16
Syntax 6-16
Parameters 6-16
Examples 6-16
controller resume_io 6-17
Syntax 6-17
Examples 6-17
Related Information 6-17
controller set automatic_failover 6-18
Notes 6-18
Syntax 6-18
Examples 6-19
Related Information 6-19
controller set array_verify 6-20
Syntax 6-20
Examples 6-20

xii
Adaptec SCSI RAID Software Reference Guide
Related Information 6-21
controller show automatic_failover 6-22
Syntax 6-22
Examples 6-22
Related Information 6-22
controller show channels 6-23
Syntax 6-23
Examples 6-23
Related Information 6-24
controller show array_verify 6-25
Syntax 6-25
Examples 6-25
Related Information 6-25
7 disk Commands
disk blink 7-2
Syntax 7-2
Parameters 7-2
Switches 7-2
Examples 7-2
disk initialize 7-3
Syntax 7-3
Parameters 7-3
Switches 7-3
Examples 7-4
disk list 7-5
Syntax 7-5
Parameters 7-5
Switches 7-5
Examples 7-5
Related Information 7-8
disk remove dead_partitions 7-9
Syntax 7-9
Parameters 7-9
Examples 7-9
Related Information 7-9
disk set default 7-10

xiii
Adaptec SCSI RAID Software Reference Guide
Syntax 7-10
Parameters 7-10
Examples 7-10
Related Information 7-11
disk set smart 7-12
Syntax 7-12
Parameters 7-12
Switches 7-13
Examples 7-14
Related Information 7-14
disk show partition 7-15
Syntax 7-15
Examples 7-15
disk show smart 7-18
Syntax 7-18
Parameters 7-18
Switches 7-18
Examples 7-19
Related Information 7-21
disk show space 7-22
Syntax 7-22
Parameters 7-22
Switches 7-22
Examples 7-22
disk verify 7-25
Syntax 7-25
Parameters 7-25
Switches 7-25
Examples 7-26
disk zero 7-27
Command And Switch Availability 7-27
Syntax 7-27
Parameters 7-27
Switches 7-27
Examples 7-28

xiv
Adaptec SCSI RAID Software Reference Guide
8 logfile Commands
logfile end 8-2
Syntax 8-2
Examples 8-2
Related Information 8-2
logfile start 8-3
Syntax 8-3
Parameter 8-3
Switches 8-3
Examples 8-3
Related Information 8-4
9 task Commands
task list 9-2
Syntax 9-2
Parameters 9-2
Switches 9-2
Examples 9-2
The Specific2 Column 9-6
Related Information 9-7
task resume 9-8
Syntax 9-8
Parameters 9-8
Switches 9-8
Examples 9-8
Related Information 9-9
task stop 9-10
Syntax 9-10
Parameters 9-10
Switches 9-10
Examples 9-10
Related Information 9-11
task suspend 9-12
Syntax 9-12
Parameters 9-12
Switches 9-12

xv
Adaptec SCSI RAID Software Reference Guide
Examples 9-12
Related Information 9-13
A Automated Scripts
Creating an Automated Script A-1

1-1
1
Getting Started
In this Chapter
The Adaptec SCSI RAID controller integrates advanced RAID
technology with state-of-the-art controller hardware to deliver
leadership performance, data availability, and storage management
features.
To configure and manage components running on the Adaptec SCSI
RAID controller, Adaptec has developed an easy-to-use graphical
user interface (GUI) called Adaptec Storage Manager as well as a
command line interface (CLI).
The CLI provides a rich alternative to Adaptec Storage Manager.
Through the CLI, you perform most of the storage management
tasks that you can perform with the Adaptec Storage Manager GUI
and, in addition, some tasks not available in the GUI. The CLI also
enables you to use the CLI commands in DOS command scripts and
Linux/UNIX shell scripts.
Audience 1-2
Supported Platforms 1-2
How to Use this Manual 1-2
Organization 1-3
Conventions 1-4
Related Documentation 1-4

1-2
Getting Started
This reference guide describes each of the commands available in
the CLI.
Audience
This reference guide is written for system administrators and
experienced users who are familiar with device configuration and
who have a general understanding of Microsoft Windows NT®4.0 /
Windows 2000 (basic disk) /Windows XP (basic disk). If you are
running under NetWare, the guide assumes you are familiar with
NetWare-related concepts and commands.
Supported Platforms
The Adaptec SCSI RAID controller operates on a variety of
operating system platforms. See the installation guide that was
supplied with your controller for a list of the supported operating
system platforms.
Unless otherwise indicated, the commands and switches discussed
in this guide are supported on the operating systems listed in the
installation guide. For the latest supported operating system
versions of the Adaptec SCSI RAID controller, visit Adaptec’s
product web site at www.adaptec.com.
How to Use this Manual
The Adaptec Advanced RAID Command Line Interface utility is
intended for use with both Adaptec SCSI and SATA RAID
controllers. This utility was originally created for SCSI controllers
and consequently many commands and their output use SCSI
terminology. The most significant differences for a SATA controller
are: The number of buses and devices is not always reported
correctly The device ID is interpreted differently for SATA devices
Some commands are intended specifically for SCSI devices and do
not function on SATA devices. These problems do not affect the
basic functionality of the CLI utility or your ability to create and
manage arrays or the controller using the CLI.
This manual documents software originally written to support SCSI
RAID controllers. With the introduction of Serial ATA RAID

1-3
Getting Started
technology, the software has been adapted by mapping of ports 0
through 3 to the following SCSI IDs:
■Bus 0, ID 0, Lun 0
■Bus 0, ID 1, Lun 0
■Bus 0, ID 2, Lun 0
■Bus 0, ID 3, Lun 0
In general, SCSI IDs will be populated from Bus 0, ID 0 upwards
(always LUN 0).
Organization
Chapter 1, Getting Started, provides an overview of this reference
guide.
Chapter 2, Accessing the Command Line Interface, provides
information on the ways you can access the CLI.
Chapter 3, Syntax and Conventions for CLI Commands, describes the
features, conventions, command syntax, parameters, and value
types that define the command line interface.
Chapter 4, General Control Commands, details general purpose
commands such as open and close.
Chapter 5, container Commands, describes all the commands related
to arrays.
Chapter 6, controller Commands, describes all the commands related
to controllers.
Chapter 7, disk Commands, describes the commands related to disks.
Chapter 8, logfile Commands, describes the commands used to record
CLI command activities.
Chapter 9, task Commands, describes the commands used to work
with tasks.
Appendix A, Automated Scripts, provides examples of how to use the
CLI commands in DOS command scripts.

1-4
Getting Started
Conventions
The following typographical conventions are use in this reference
guide.
Related Documentation
Use this reference guide when you need specific information about a
CLI command (for example, syntax and parameter descriptions).
Note: When consulting the Command Line Interface Reference
Guide, you can consider the terms “array” and “container”
as synonymous if you keep in mind that containers have
features that no other arrays have; such as, using the full
capacity of a disk when creating a container and sharing a
disk’s full capacity across multiple containers.
In addition, the term “array” has a general meaning beyond
“RAID array;” for example, a rack of disks is often referred
to as a disk array.
Other related documents include the following:
■Adaptec Serial ATA RAID Installation & User’s Guide
The installation guide that ships with your RAID controller
explains how to install it in your computer system. The
installation guide also provides instructions on how to install
the RAID software.
Describes the features available in Adaptec Storage Manager
and how to use them.
The guide assumes that you are familiar with:
– Basic functions of your operating system
– Basic network administration terminology and tasks
– RAID technology
bold Used to highlight information depicted in examples (for
example, the Type column indicates that a RAID-5 set
resides on array 0).
Courier Used to highlight commands in text (for example, the
array create mirror command).

2-1
2
Accessing the Command
Line Interface
In this Chapter
Note: When the CLI executes an asynchronous command, it
displays status information in the title bar of a DOS
command prompt window. The status information includes
a percent number that indicates percentage completion. On
NetWare, the status information appears in a different
console screen. On UNIX, the status information appears at
the bottom of the CLI window.
Accessing the CLI from the MS-DOS Prompt 2-2
Accessing the CLI from the Windows Start Button 2-2
Accessing the CLI from the NetWare Server Console 2-3
Accessing the CLI from the Linux/UNIX Prompt 2-3