1 .\" Copyright (c) 2008, 2009 Yahoo!, Inc.
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
12 .\" 3. The names of the authors may not be used to endorse or promote
13 .\" products derived from this software without specific prior written
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .Nd Utility for managing LSI MegaRAID SAS controllers
58 .Op Ar start Op Ar stop
82 .Cm drive progress Ar drive
85 .Cm drive clear Ar drive Brq "start | stop"
88 .Cm start rebuild Ar drive
91 .Cm abort rebuild Ar drive
94 .Cm locate Ar drive Brq "on | off"
97 .Cm cache Ar volume Op Ar setting Op Ar value
100 .Cm name Ar volume Ar name
103 .Cm volume progress Ar volume
111 .Op Fl s Ar stripe_size
112 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
113 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
119 .Cm add Ar drive Op Ar volume
131 .Cm patrol Ar command Op Ar interval Op Ar start
138 utility can be used to display or modify various parameters on LSI
139 MegaRAID SAS RAID controllers.
142 consists of zero or more global options followed by a command.
143 Commands may support additional optional or required arguments after the
146 Currently one global option is supported:
147 .Bl -tag -width indent
150 specifies the unit of the controller to work with.
151 If no unit is specified,
155 Volumes may be specified in two forms.
157 a volume may be identified by its target ID.
159 on the volume may be specified by the corresponding
165 Drives may be specified in two forms.
167 a drive may be identified by its device ID.
168 The device ID for configured drives can be found in
171 a drive may be identified by its location as
181 is the slot for each drive as displayed in
186 utility supports several different groups of commands.
187 The first group of commands provide information about the controller,
188 the volumes it manages, and the drives it controls.
189 The second group of commands are used to manage the physical drives
190 attached to the controller.
191 The third group of commands are used to manage the logical volumes
192 managed by the controller.
193 The fourth group of commands are used to manage the drive configuration for
195 The fifth group of commands are used to manage controller-wide operations.
197 The informational commands include:
198 .Bl -tag -width indent
200 Displays the version of
203 Displays information about the RAID controller such as the model number.
205 Displays information about the battery from the battery backup unit.
207 Displays the volume and drive configuration for the controller.
208 Each array is listed along with the physical drives the array is built from.
209 Each volume is listed along with the arrays that the volume spans.
210 If any hot spare drives are configured, then they are listed as well.
212 Lists all of the physical drives attached to the controller.
213 .It Xo Cm show events
218 .Op Ar start Op Ar stop
220 Display entries from the controller's event log.
221 The controller maintains a circular buffer of events.
222 Each event is tagged with a class and locale.
226 parameter limits the output to entries at the specified class or higher.
229 The available classes from lowest priority to highest are:
230 .Bl -tag -width -indent
234 Periodic progress updates for long-running operations such as background
235 initializations, array rebuilds, or patrol reads.
237 Informational messages such as drive insertions and volume creations.
239 Indicates that some component may be close to failing.
241 A component has failed, but no data is lost.
242 For example, a volume becoming degraded due to a drive failure.
244 A component has failed resulting in data loss.
246 The controller itself has died.
251 parameter limits the output to entries for the specified part of the controller.
252 The default locale is
254 The available locales are
268 parameter is a debugging aid that specifies the number of events to fetch from
269 the controller for each low-level request.
270 The default is 15 events.
272 By default, matching event log entries from the previous shutdown up to the
273 present are displayed. This range can be adjusted via the
278 Each of these parameters can either be specified as a log entry number or as
279 one of the following aliases:
280 .Bl -tag -width -indent
282 The newest entry in the event log.
284 The oldest entry in the event log.
286 The first entry since the event log was cleared.
288 The entry in the event log corresponding to the last time the controller was
291 The entry in the event log corresponding to the most recent boot.
294 Lists all of the firmware images present on the controller.
296 Display the various sequence numbers associated with the event log.
298 Display the status of the controller's patrol read operation.
300 Lists all of the logical volumes managed by the controller.
303 The physical drive management commands include:
304 .Bl -tag -width indent
310 must be an online drive that is part of an array.
314 as an unconfigured good drive.
316 must not be part of an existing array.
317 .It Cm rebuild Ar drive
320 that is still part of an array as a good drive suitable for a rebuild.
321 The firmware should kick off an array rebuild on its own if a failed drive
322 is marked as a rebuild drive.
323 .It Cm drive progress Ar drive
324 Report the current progress and estimated completion time of drive operations
325 such as rebuilds or patrol reads.
326 .It Cm drive clear Ar drive Brq "start | stop"
327 Start or stop the writing of all 0x00 characters to a drive.
328 .It Cm start rebuild Ar drive
329 Manually start a rebuild on
331 .It Cm abort rebuild Ar drive
332 Abort an in-progress rebuild operation on
334 It can be resumed with the
337 .It Cm locate Ar drive Brq "on | off"
338 Change the state of the external LED associated with
342 The logical volume management commands include:
343 .Bl -tag -width indent
344 .It Cm cache Ar volume Op Ar setting Op Ar value
347 argument is supplied, then the current cache policy for
356 argument can be one of the following values:
357 .Bl -tag -width indent
359 Enable caching for both read and write I/O operations.
361 Disable caching for both read and write I/O operations.
363 Enable caching only for read I/O operations.
365 Enable caching only for write I/O operations.
367 Use write-back policy for cached writes.
369 Use write-through policy for cached writes.
370 .It Cm read-ahead Op Ar value
371 Set the read ahead policy for cached reads.
374 argument can be set to either
379 .It Cm write-cache Op Ar value
380 Control the write caches on the physical drives backing
384 argument can be set to either
390 In general this setting should be left disabled to avoid data loss when the
391 physical drives lose power.
392 The battery backup of the RAID controller does not save data in the write
393 caches of the physical drives.
395 .It Cm name Ar volume Ar name
400 .It Cm volume progress Ar volume
401 Report the current progress and estimated completion time of volume operations
402 such as consistency checks and initializations.
405 The configuration commands include:
406 .Bl -tag -width indent
408 Delete the entire configuration including all volumes, arrays, and spares.
409 .It Xo Cm create Ar type
411 .Op Fl s Ar stripe_size
412 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
413 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
418 specifies the type of volume to create.
419 Currently supported types include:
420 .Bl -tag -width indent
422 Creates a RAID0 volume for each drive specified.
423 Each drive must be specified as a separate argument.
425 Creates one RAID0 volume spanning the drives listed in the single drive list.
427 Creates one RAID1 volume spanning the drives listed in the single drive list.
429 Creates one RAID5 volume spanning the drives listed in the single drive list.
431 Creates one RAID6 volume spanning the drives listed in the single drive list.
433 Creates one RAID10 volume spanning multiple RAID1 arrays.
434 The drives for each RAID1 array are specified as a single drive list.
436 Creates one RAID50 volume spanning multiple RAID5 arrays.
437 The drives for each RAID5 array are specified as a single drive list.
439 Creates one RAID60 volume spanning multiple RAID6 arrays.
440 The drives for each RAID6 array are specified as a single drive list.
442 Creates a single volume by concatenating all of the drives in the single drive
447 Not all volume types are supported by all controllers.
451 flag is specified after
453 then more verbose output will be enabled.
454 Currently this just provides notification as drives are added to arrays and
455 arrays to volumes when building the configuration.
460 parameter allows the stripe size of the array to be set.
461 By default a stripe size of 64K is used.
462 Valid values are 512 through 1M, though the MFI firmware may reject some
464 .It Cm delete Ar volume
467 .It Cm add Ar drive Op Ar volume
472 must be in the unconfigured good state.
476 then the hot spare will be dedicated to arrays backing that volume.
479 will be used as a global hot spare backing all arrays for this controller.
482 must be as large as the smallest drive in all of the arrays it is going to
484 .It Cm remove Ar drive
488 It will be placed in the unconfigured good state.
491 The controller management commands include:
492 .Bl -tag -width indent
493 .It Cm patrol Ar command Op Ar interval Op Ar start
494 Set the patrol read operation mode.
497 argument can be one of the following values:
498 .Bl -tag -width indent
500 Disable patrol reads.
502 Enable periodic patrol reads initiated by the firmware.
505 argument specifies the interval in seconds between patrol reads.
506 If patrol reads should be run continuously,
509 should consist of the word
513 argument specifies a non-negative, relative start time for the next patrol read.
514 If an interval or start time is not specified,
515 then the existing setting will be used.
517 Enable manual patrol reads that are only initiated by the user.
520 Start a patrol read operation.
522 Stop a currently running patrol read operation.
524 Updates the flash on the controller with the firmware stored in
526 A reboot is required for the new firmware to take effect.
529 Configure the cache for volume mfid0 to cache only writes:
531 .Dl Nm Cm cache mfid0 writes
532 .Dl Nm Cm cache mfid0 write-back
534 Create a RAID5 array spanning the first four disks in the second enclosure:
536 .Dl Nm Cm create raid5 e1:s0,e1:s1,e1:s2,e1:s4
538 Configure the first three disks on a controller as JBOD:
540 .Dl Nm Cm create jbod 0 1 2
542 Create a RAID10 volume that spans two arrays each of which contains two disks
543 from two different enclosures:
545 .Dl Nm Cm create raid10 e1:s0,e1:s1 e2:s0,e2:s1
547 Add drive with the device ID of 4 as a global hot spare:
551 Add the drive in slot 2 in the main chassis as a hot spare for volume mfid0:
553 .Dl Nm Cm add s2 mfid0
555 Configure the adapter to run periodic patrol reads once a week with the first
556 patrol read starting in 5 minutes:
558 .Dl Nm Cm patrol auto 604800 300
565 utility first appeared in