Adaptec AAR-2020SA User manual

R
Command Line Interface
Reference Guide

ii
Copyright
©2000 – 2004 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 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 Introduction
Audience 1-1
Accessing the CLI 1-2
Accessing the CLI from the MS-DOS Prompt 1-2
Accessing the CLI in Windows 1-2
Accessing CLI in Linux and UNIX 1-2
Accessing CLI in NetWare 1-3
Terminology 1-3
Conventions 1-4
Command Syntax 1-5
Class 1-5
Action 1-6
Object 1-6
Switch 1-6
Value 1-6
Parameter 1-7
Blank Space 1-7
Parameter and Switch Value Types 1-7
Boolean 1-7
integer 1-8
string 1-9
scsi_device 1-10
free_space 1-11
container 1-12
Status Information 1-13
The Stat and Task Items 1-13
The Func Item 1-13
The Ctr and State Items 1-14

iv
Contents
2 General Control Commands
close 2-2
exit 2-3
help, ? 2-4
history_size 2-5
open 2-6
reset_window 2-8
toggle_more 2-9
3 container Commands
container add_level 3-3
container create mirror 3-5
container create mmirror 3-8
container create mstripe 3-12
container create mvolume 3-17
container create raid5 3-21
container create stripe 3-27
container create volume 3-32
container delete 3-37
container extend file_system 3-40
container extend mvolume 3-43
container extend volume 3-47
container list 3-50
container lock 3-59
container move 3-61
container promote 3-63
container readonly 3-66
container readwrite 3-68
container reconfigure 3-70
container release_cache 3-77
container remove drive_letter 3-78
container remove failover 3-80
container remove file_system 3-82
container remove global_failover 3-84
container restore RAID5 3-86
container scrub 3-88
container set cache 3-91

v
Contents
container set failover 3-95
container set global_failover 3-97
container set io_delay 3-99
container set label 3-101
container show cache 3-103
container show failover 3-108
container split 3-109
container unlock 3-112
container unmirror 3-114
4 controller Commands
controller details 4-2
controller firmware compare 4-6
controller firmware save 4-7
controller firmware update 4-9
controller list 4-10
controller pause_io 4-12
controller rescan 4-14
controller reset_scsi_channel 4-15
controller resume_io 4-16
controller set automatic_failover 4-17
controller set array_verify 4-19
controller show automatic_failover 4-21
controller show channels 4-22
controller show array_verify 4-25
5 disk Commands
disk blink 5-2
disk initialize 5-3
disk list 5-5
disk remove dead_partitions 5-10
disk set default 5-11
disk set smart 5-13
disk show default 5-16
disk show defects 5-17
disk show partition 5-19
disk show smart 5-22

vi
Contents
disk show space 5-26
disk verify 5-29
disk zero 5-31
6 diagnostic Commands
diagnostic clear boot_parameters 6-2
diagnostic dump structures 6-3
diagnostic dump text 6-4
diagnostic load_arrays 6-6
diagnostic moderation set count 6-7
diagnostic moderation set timer 6-8
diagnostic moderation show count 6-9
diagnostic moderation show timer 6-10
diagnostic set boot_parameter 6-11
diagnostic show boot_parameter 6-12
diagnostic show history 6-13
7 logfile Commands
logfile end 7-2
logfile start 7-3
8 task Commands
task list 8-2
task resume 8-8
task stop 8-10
task suspend 8-12
9 enclosure Commands
enclosure activate slot 9-2
enclosure identify slot 9-4
enclosure list 9-6
enclosure prepare slot 9-11
enclosure set alarm 9-13
enclosure set door 9-14
enclosure set fan 9-15
enclosure set interval 9-17

vii
Contents
enclosure set power 9-19
enclosure set scsiid 9-21
enclosure set temperature 9-24
enclosure show fan 9-26
enclosure show power 9-29
enclosure show slot 9-32
enclosure show status 9-36
enclosure show temperature 9-41
A Automated Scripts
Creating an Automated Script A-1

1-1
1
Introduction
In this Chapter
The CLI provides a command line 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 Storage
Manager. With CLI, you can also use the CLI commands in DOS
command scripts and UNIX shell scripts.
Audience
This Reference Guide is for system administrators and experienced
users who are familiar with drive configuration and who have a
general understanding of the operating systems they are using.
This guide also assumes you are familiar with RAID concepts.
Audience 1-1
Accessing the CLI 1-2
Terminology 1-3
Conventions 1-4
Command Syntax 1-5
Parameter and Switch Value Types 1-7
Status Information 1-13

1-2
Introduction
Accessing the CLI
This section discusses accessing the CLI in various operating
systems.
Accessing the CLI from the MS-DOS Prompt
To access the CLI from the MS-DOS prompt, move to the directory
containing the afacli executable and then type afacli, as in the
following example:
C:\>cd Program Files\Adaptec_SCSI_RAID\AAC
C:\Program Files\Adaptec_SCSI_RAID\AAC>afacli
Accessing the CLI in Windows
This section discusses the various methods for accessing the CLI in
Windows.
Note: The following procedure assumes that you
accepted the default location for the software during
installation.
To access the CLI:
1Click the Start button and move the mouse cursor to Programs.
Click on Programs.
2Move the mouse cursor to SMBE. The Adaptec program group
will display.
3Move the mouse cursor to the CLI icon. Click on CLI.
Accessing CLI in Linux and UNIX
To access the CLI from the UNIX/Linux prompt, display a window
and type aaccli in any directory. When the system displays the
CLI> prompt, you can use CLI commands.
For the commands to work in any directory, the path in the startup
file (.login or .cshrc) must include the directory where the
software is installed. See your UNIX/Linux documentation for
information on setting up directory paths in the .login and
.cshrc files.

1-3
Introduction
Accessing CLI in NetWare
To access the CLI from the NetWare server console, type aaccli at
the prompt. When the system displays the CLI> prompt, which
indicates that you can now use CLI commands.
Terminology
This section discusses terminology used in this Appendix.
Adaptec 2410SA/2810SA Controllers Only
In the device ID format C:ID:L :
■C represents Channel, which is always zero.
■ID represents Port ID, or Port number, on the SATA RAID
controller. This is the only value that is used.
■L represents LUN, which is always zero.
Note: Only the value for Port ID is used.
Adaptec 21610SA Controllers Only
In the device ID format C:ID:L :
■C represents Channel.
■ID represents Port ID. (For mapping, see below.)
■L represents LUN, which is always zero.
Your Serial ATA adapter maps Port IDs as follows:
■Controller ports 0 through 7 are mapped to IDs 0 through 7 on
Channel 0
■Controller ports 8 through 15 are mapped to IDs 0 through 7 on
Channel 1
For example, port 5 is 0:5:0; port 12 is 1:4:0.
All Controllers
The following terms are used in discussing the CLI:
■Array, container—A logical disk created from available space
and made up of one or more partitions on one or more physical
disks.