.\" Copyright 1999-2000 Distributed Processing Technology.
.\" Copyright 2000 Adaptec Incorporated.
.\" All Rights Reserved
.TH raidutil 8 "Aug 2000" " "
.SH NAME
raidutil \-  RAID Management Configuration Utility
.SH SYNOPSIS
\fBraidutil\fR  \fB-c\fR device OS relative
.br
\fB\ \ \ \ \ \ \ \ \fR  \fB-d\fR device hardware relative
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-a\fR action (task) control ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-e\fR View event log ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-f\fR Force state ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-g\fR drive group ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-h\fR create hot spare ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-l\fR RAID level ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-r\fR background task rate ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-s\fR logical drive capacity ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-w\fR write caching ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-z\fR stripe size ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-A\fR alarm status and control ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-C\fR load/save configuration ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-D\fR delete logical drive ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-H\fR delete hot spare ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-F\fR update controller firmware ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-I\fR display inquiry information ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-L\fR display list of devices ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-P\fR paginate output ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-X\fR reset NVRAM configuration ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-Z\fR clear all array information from devices ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-q\fR suppress message output during execution ]
.br
\fB\ \ \ \ \ \ \ \ \fR  [ \fB-?\fR display usage information ]
.sp
.SH DESCRIPTION
.sp
Use raidutil to perform initial configuration of a disk
array when installing the disk array on a system. The
parameters -g, -l, -n, -s and -z are used together for
logical drive creation. These parameters MUST precede
the -g parameter. See the following explanations. You
can also use it to change the array configuration if
required and perform other controller and array
maintenance functions. It allows you to create and
delete logical drives and hot spare drives, or display
device information from a command line or script.
.sp
raidutil can also update the firmware on the adapter
card. It will automatically recognize whether the
supplied image is new controller firmware, BIOS, SMOR
or NVRAM default image and place the image in the
appropriate flash memory location.
.sp
This utility performs operations as soon as it has
enough information from the command line to do so. It
will not parse the entire command line before
performing an operation. It performs operations in
series as long as there are actions on the command line
for it to carry out, up to the first failure it
encounters. If raidutil does not have all of the
necessary information when it decides to perform an
action, it will return an error. Furthermore, it is
possible for raidutil to partially succeed. That is, it
was able to perform the first <n> actions, then
encountered something it could not do. In this case, it
will exit with an appropriate error message. Each major
operation taken by raidutil will result in a one-line
pass/fail indicator displayed on the screen (unless in
"quiet" mode [-q]).
.sp
In general, you can perform multiple operations on one
command line. However, make sure you are aware of the
groupings and restrictions described in the following
sections to ensure that the functions are carried out
correctly.
.SH OPTIONS
.TP 2
-A
When no parameters follow the switch, the alarm status and
enable flags are displayed.
.sp
[-A on]      Forces the audible alarm to sound.
.br
[-A off]     Silences the audible alarm when it is on.
.br
[-A enable]  Allow the alarm to be heard when a failure occurs.
.br
[-A disable] Prevents the alarm from sounding for any reason.
.TP 2
-c
Specify the device name, as assigned by your operating system,
of the RAID controller to configure (this is a required
parameter).
.sp
-c c1   to specify controller 1
.TP 2
-C
This switch has two options:
.sp
load
.br
which will load the specified configuration file.
.sp
save
.br
which saves the current configuration to the file name
specified.
.sp
A file name must follow the load or save parameter. This is
a .DSM file, which can also be loaded or saved using Storage
Manager.
.TP 2
-d
Specify the device name, in Adaptec format, of the RAID
controller to configure (this is a required parameter).
Controllers are assigned IDs starting with 0 based on the PCI
slot location from lowest to highest.
.TP 2
-D
Delete a logical drive and return the capacity to unassigned
space.
.sp
raidutil -c c1 -D all
.sp
all logical drives are deleted.
.sp
raidutil -c c1 -D 1,2
.sp
The logical drives with IDs 1 and 2 on controller 1 are deleted.
.TP 2
-e
This switch lets you display or delete the entries in the
controller event log using the following parameters:
.sp
[-e soft]     Display all log data (Level 1)
.br
[-e recov]    Display only recoverable hard errors (Level 2)
.br
[-e nonrecov] Display only nonrecoverable hard errors (Level 3)
.br
[-e status]   Display only status changes (Level 4)
.br
[-e delete]   Delete all log entries for the controller.
.br
d#            The target controller ID for this command.
.sp
Examples:
.sp
raidutil -e soft -d0
.br
displays all log entries for controller 0.
.sp
raidutil -e delete d1
.br
Deletes all event log entries on controller 1.
.TP 2
-f
Forces an array to an Optimal status or Failed status.
.sp
raidutil -f optimal d1b1t0d0
.br
will force the device at address d1b1t0d0 to an Optimal status.
.sp
raidutil -f fail d1b1t0d0
.br
will force the device at address d1b1t0d0 to a Failed status.
.TP 2
-F
Updates the controller firmware. Specify a file name
that contains the new flash firmware image. If no file
name is provided, stdin is assumed. The utility will
automatically determine the flash image type and ensure
that the image is written to the appropriate flash
memory region.
.sp
NOTE: After flashing a new NVRAM default image, perform
a reset NVRAM configuration command (-X) to transfer
the new default image to NVRAM space on the adapter.
.TP 2
-g
Specify drive group (for  example, -g c1t1d0,c2t1d0,c3t1d0)
for logical drive creation. In the standard address form:
cXtXdXsX to specify logical controller ID (cX), physical
target ID (tX), Drive LUN (dX) and slice or partition (sX).
.sp
To create a RAID 10 configuration specify groups in pairs
as follows:
.sp
raidutil -c c1 -l 1 -g c1t1d0,c1t2d0,c1t3d0,c1t4d0
.sp
To create a RAID 50 configuration specify groups in pairs
as follows using the + character to indicate the parity group:
.sp
raidutil -c c1 -l 5 -g c1t1d0,c1t2d0,c1t3d0,c1t4d0+c1t9d0,c1t10d0,c1t11d0
.sp
See associated parameters -l, -n, -s, -z. If used,
these parameters  MUST precede the -g parameter.
You must use commas to separate drive identifiers.
The list of drives in a drive group cannot contain
any spaces.
.sp
RAID 0 can be 1 to 64 drives
.br
RAID 1 can be 2 to 64 drives (must be multiples of two.)
.br
RAID 5 can be 3 to 64 drives
.br
RAID 10 can be 4 to 64 drives (must groups of two drives each.)
.br
RAID 50 can be 6 to 64 drives
.TP 2
-h
Create one or more hot spare drives. In the standard
address form:  cXtXdXsX to specify logical controller
ID (cX), physical target ID (tX), Drive LUN (dX) and
slice or partition (sX). Use commas to separate device
addresses.
.sp
raidutil -c c1 -h c1t0d0,c2t0d0
.sp
creates hot spares using drive ID 0 on bus 0 and
drive ID 0 on bus 1.
.sp
NOTE: Each bus on the adapter card forms a new controller
identifier. Use the [-L controllers] and [-L physical]
results to confirm device locations and addresses.
.TP 2
-H
Delete a hot spare drive where the first number is the
channel and the second number is the SCSI ID of each
drive. Use commas to separate drive identifiers.
.sp
raidutil -c c1 -H c1t0d0,c2t0d0
.sp
removes hot spare assignment from the drives at ID 0 on bus
0 and ID 0 on bus 1 of controller 1.
.sp
With no device ID [-H all] all hot spare drives are
deleted.
.TP 2
-I
Display device inquiry information. If no parameters
follow this switch, it displays only the controller
information such as, firmware revision, BIOS version,
and serial number. If a physical device address is
used, the information for that device is displayed.
.TP 2
-l
Specify RAID level (0, 1 or 5). If the -l parameter is
omitted, RAID 5 is the default. See associated
parameters -n, -s, -z. These parameters MUST precede
the -g parameter.
.TP 2
-L
Display list of devices. If a controller is not specified,
each information for controller is listed along with all
attached devices.
.sp
The following formats can be used:
.sp
[-L battery]     displays information about the battery module
.sp
[-L controller]  lists controller information
.sp
[-L cache]       displays the device caching mode.
.sp
[-L inquiry]     displays the device capabilities as reported
to the controller.
.sp
[-L logical]     lists logical drives (arrays) by number
.sp
[-L physical]    lists all devices attached to a controller
.sp
[-L raid]        returns a list of logical drives (arrays)
.br
[-L array]       and constituent physical drives
.sp
[-L redirect]    displays a list of any redirected devices
.sp
[-L spare]       lists hot spare drive
.sp
[-L speed]       displays a list of the bus speed for all
connected devices
.sp
[-L version]     displays the version numbers for controller
firmware, SMOR, BIOS, and NVRAM.
.sp
[-L all]         to return all of the above listings.
.TP 2
-n
Specify the logical drive number (LUN) to be created.
You MUST specify the logical drive number when creating
a logical drive or the logical drive will not be
created. If you are creating multiple logical drives on
the same drive group, there must be commas between the
logical drive numbers (e.g. -n 1,2).
.sp
See associated parameters -l, -s, -z. These
parameters MUST precede the -g parameter.
.TP 2
-P
Limits output to 22 lines, then prompts to press Enter to
continue. Pressing Enter prints another 22 lines. Use this
switch before -L to prevent lengthy output from scrolling off
the screen.
.TP 2
-q
Suppress display of messages during raidutil execution.
This is useful when running raidutil from a script.
.sp
NOTE: If this option is to suppress all output, it
must be the first parameter on the command line.
.TP 2
-r
This switch sets a task priority for the device or logical
drive. The parameter can be 0 - 9; with 0 being the slowest
and 9 being the fastest. You can also specify the rate as
follows:
.sp
.ti +3
-r slow    = 1
.br
.ti +3
-r medslow = 3
.br
.ti +3
-r med     = 5
.br
.ti +3
-r medfast = 7
.br
.ti +3
-r fast    = 9
.sp
The device address is required. Specify logical drives by
their device addresses. You can set the rate for all logical
drives on a controller by using the device address of the
controller.
.TP 2
-s
Specify logical drive capacity (in megabytes). For
example, -s 1000 would create a 1 gigabyte logical
drive. If this switch is omitted or if the capacity
specified exceeds the available capacity, the maximum
available capacity is used. See associated parameters
-l, -n, -z. These parameters MUST precede the -g
parameter.
.TP 2
-w
Options are on and off. The default (on) uses write-back
caching. [-w off] enables write-through operation. Specify
drives using the device address.
.TP 2
-X
Reset NVRAM configuration. This option resets the
controller configuration to its default settings.
.TP 2
-z
Specify stripe size (in kilobytes) for RAID 0 or 5. The
stripe size is the number of contiguous blocks written
to a single drive before writing to the next drive in
the logical drive. See associated parameters -l, -n,
-s. These parameters MUST precede the -g parameter.
.sp
If this parameter is omitted, the default stripe size
is used. Valid values are 8, 16, 32, 64 and 128.
.TP 2
-Z
Clear RAID table information from devices. The device
can be specified as a controller, array or target. You
can also specify groups of these devices. Separate
multiple device specifications with commas.
.sp
raidutil -Z c2
.sp
clears all RAID tables for controller 2.
.sp
raidutil -Z c1t2d0,c1t3d0,c1t4d0
.sp
clears RAID tables on the specified target drives (2,3,4)
.TP 2
-?
Display usage information. This option displays a
summary of the command line switches.
.SH "EXIT CODES"
0 - Error-free termination
.sp
1 - Error termination (message log will contain the error message)
.SH NOTES
Invoking raidutil with no arguments or with an unrecognized
parameter will cause usage information to be displayed (the
same result as using -?).
.sp
If you are going to delete a hot spare (-H) or a logical
drive (-D), always perform that operation as the first
parameter on the command line (after the -c or -q).
.sp
If you are doing multiple logical drive creations on the
same command line, make sure that you have commas between
the drives specified with the -g parameter.
.SH EXAMPLE
The command line entry:
.sp
raidutil -c c1 -D all -n 0 -l 5 -s 1000 -z 32 -g c1t1d0,c2t1d0,c3t1d0
.sp
would perform the following actions on the device:
.TP 4
(1)
delete all existing logical drives
.TP 4
(2)
create a new logical drive (number 0) using RAID 5, with
a capacity of 1 GB, a 32 KB stripe size, and consisting
of the 3 drives indicated after the -g parameter.
.TP 0
The command target device name takes the form
[cXtXdXsX]; you must specify at least the controller
number (cX).
.SH "SEE ALSO"