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
60 .Op Ar start Op Ar stop
66 .Cm show foreign Op Ar volume
97 .Cm drive progress Ar drive
100 .Cm drive clear Ar drive Brq "start | stop"
103 .Cm start rebuild Ar drive
106 .Cm abort rebuild Ar drive
109 .Cm locate Ar drive Brq "on | off"
112 .Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
115 .Cm name Ar volume Ar name
118 .Cm volume progress Ar volume
126 .Op Fl s Ar stripe_size
127 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
128 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
134 .Cm add Ar drive Op Ar volume
146 .Cm patrol Ar command Op Ar interval Op Ar start
152 .Cm foreign clear Op Ar config
155 .Cm foreign diag Op Ar config
158 .Cm foreign preview Op Ar config
161 .Cm foreign import Op Ar config
170 .Cm bbu Ar setting Ar value
174 utility can be used to display or modify various parameters on LSI
175 MegaRAID SAS RAID controllers.
178 consists of zero or more global options followed by a command.
179 Commands may support additional optional or required arguments after the
182 Currently one global option is supported:
183 .Bl -tag -width indent
186 specifies the unit of the controller to work with.
187 If no unit is specified,
191 Various commands accept either or both of the two options:
192 .Bl -tag -width indent
194 Print numeric device IDs as drive identifier.
196 Useful in combination with
198 to print both, numeric device IDs and enclosure:slot information.
200 Print drive identifiers in enclosure:slot form.
201 See next paragraph on format details in context of input rather than
205 Drives may be specified in two forms.
207 a drive may be identified by its device ID.
208 The device ID for configured drives can be found in
211 a drive may be identified by its location as
221 is the slot for each drive as displayed in
224 Volumes may be specified in two forms.
226 a volume may be identified by its target ID.
228 on the volume may be specified by the corresponding
236 utility supports several different groups of commands.
237 The first group of commands provide information about the controller,
238 the volumes it manages, and the drives it controls.
239 The second group of commands are used to manage the physical drives
240 attached to the controller.
241 The third group of commands are used to manage the logical volumes
242 managed by the controller.
243 The fourth group of commands are used to manage the drive configuration for
245 The fifth group of commands are used to manage controller-wide operations.
247 The informational commands include:
248 .Bl -tag -width indent
250 Displays the version of
253 Displays information about the RAID controller such as the model number.
255 Displays information about the battery from the battery backup unit.
257 Displays the volume and drive configuration for the controller.
258 Each array is listed along with the physical drives the array is built from.
259 Each volume is listed along with the arrays that the volume spans.
260 If any hot spare drives are configured, then they are listed as well.
262 Lists all of the physical drives attached to the controller.
263 .It Xo Cm show events
268 .Op Ar start Op Ar stop
270 Display entries from the controller's event log.
271 The controller maintains a circular buffer of events.
272 Each event is tagged with a class and locale.
276 parameter limits the output to entries at the specified class or higher.
279 The available classes from lowest priority to highest are:
280 .Bl -tag -width -indent
284 Periodic progress updates for long-running operations such as background
285 initializations, array rebuilds, or patrol reads.
287 Informational messages such as drive insertions and volume creations.
289 Indicates that some component may be close to failing.
291 A component has failed, but no data is lost.
292 For example, a volume becoming degraded due to a drive failure.
294 A component has failed resulting in data loss.
296 The controller itself has died.
301 parameter limits the output to entries for the specified part of the controller.
302 The default locale is
304 The available locales are
318 parameter is a debugging aid that specifies the number of events to fetch from
319 the controller for each low-level request.
320 The default is 15 events.
322 By default, matching event log entries from the previous shutdown up to the
323 present are displayed. This range can be adjusted via the
328 Each of these parameters can either be specified as a log entry number or as
329 one of the following aliases:
330 .Bl -tag -width -indent
332 The newest entry in the event log.
334 The oldest entry in the event log.
336 The first entry since the event log was cleared.
338 The entry in the event log corresponding to the last time the controller was
341 The entry in the event log corresponding to the most recent boot.
344 Lists all of the firmware images present on the controller.
346 Displays detected foreign configurations on disks for importation or removal.
348 Display the various sequence numbers associated with the event log.
350 Display the status of the controller's patrol read operation.
352 Report the current progress and estimated completion time for active
353 operations on all volumes and drives.
355 Lists all of the logical volumes managed by the controller.
358 The physical drive management commands include:
359 .Bl -tag -width indent
365 must be an online drive that is part of an array.
369 as an unconfigured good drive.
371 must not be part of an existing array.
372 .It Cm rebuild Ar drive
375 that is still part of an array as a good drive suitable for a rebuild.
376 The firmware should kick off an array rebuild on its own if a failed drive
377 is marked as a rebuild drive.
378 .It Cm syspd Ar drive
379 Present the drive to the host operating system as a disk SYSPD block device in
380 the format /dev/mfisyspdX. Clear this flag with
383 .It Cm drive progress Ar drive
384 Report the current progress and estimated completion time of drive operations
385 such as rebuilds or patrol reads.
386 .It Cm drive clear Ar drive Brq "start | stop"
387 Start or stop the writing of all 0x00 characters to a drive.
388 .It Cm start rebuild Ar drive
389 Manually start a rebuild on
391 .It Cm abort rebuild Ar drive
392 Abort an in-progress rebuild operation on
394 It can be resumed with the
397 .It Cm locate Ar drive Brq "on | off"
398 Change the state of the external LED associated with
402 The logical volume management commands include:
403 .Bl -tag -width indent
404 .It Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
407 arguments are supplied, then the current cache policy for
416 arguments may be given.
417 Some settings take an additional
419 argument as noted below.
420 The valid settings are:
421 .Bl -tag -width indent
423 Enable caching for both read and write I/O operations.
425 Disable caching for both read and write I/O operations.
427 Enable caching only for read I/O operations.
429 Enable caching only for write I/O operations.
431 Use write-back policy for cached writes.
433 Use write-through policy for cached writes.
434 .It Cm read-ahead Ar value
435 Set the read ahead policy for cached reads.
438 argument can be set to either
443 .It Cm bad-bbu-write-cache Ar value
444 Control the behavior of I/O write caching if the battery is dead or
448 argument can be set to either
452 In general this setting should be left disabled to avoid data loss when
453 the system loses power.
454 .It Cm write-cache Ar value
455 Control the write caches on the physical drives backing
459 argument can be set to either
465 In general this setting should be left disabled to avoid data loss when the
466 physical drives lose power.
467 The battery backup of the RAID controller does not save data in the write
468 caches of the physical drives.
470 .It Cm name Ar volume Ar name
475 .It Cm volume progress Ar volume
476 Report the current progress and estimated completion time of volume operations
477 such as consistency checks and initializations.
480 The configuration commands include:
481 .Bl -tag -width indent
483 Delete the entire configuration including all volumes, arrays, and spares.
484 .It Xo Cm create Ar type
486 .Op Fl s Ar stripe_size
487 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
488 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
493 specifies the type of volume to create.
494 Currently supported types include:
495 .Bl -tag -width indent
497 Creates a RAID0 volume for each drive specified.
498 Each drive must be specified as a separate argument.
500 Creates one RAID0 volume spanning the drives listed in the single drive list.
502 Creates one RAID1 volume spanning the drives listed in the single drive list.
504 Creates one RAID5 volume spanning the drives listed in the single drive list.
506 Creates one RAID6 volume spanning the drives listed in the single drive list.
508 Creates one RAID10 volume spanning multiple RAID1 arrays.
509 The drives for each RAID1 array are specified as a single drive list.
511 Creates one RAID50 volume spanning multiple RAID5 arrays.
512 The drives for each RAID5 array are specified as a single drive list.
514 Creates one RAID60 volume spanning multiple RAID6 arrays.
515 The drives for each RAID6 array are specified as a single drive list.
517 Creates a single volume by concatenating all of the drives in the single drive
522 Not all volume types are supported by all controllers.
526 flag is specified after
528 then more verbose output will be enabled.
529 Currently this just provides notification as drives are added to arrays and
530 arrays to volumes when building the configuration.
535 parameter allows the stripe size of the array to be set.
536 By default a stripe size of 64K is used.
537 Valid values are 512 through 1M, though the MFI firmware may reject some
539 .It Cm delete Ar volume
542 .It Cm add Ar drive Op Ar volume
547 must be in the unconfigured good state.
551 then the hot spare will be dedicated to arrays backing that volume.
554 will be used as a global hot spare backing all arrays for this controller.
557 must be as large as the smallest drive in all of the arrays it is going to
559 .It Cm remove Ar drive
563 It will be placed in the unconfigured good state.
566 The controller management commands include:
567 .Bl -tag -width indent
568 .It Cm patrol Ar command Op Ar interval Op Ar start
569 Set the patrol read operation mode.
572 argument can be one of the following values:
573 .Bl -tag -width indent
575 Disable patrol reads.
577 Enable periodic patrol reads initiated by the firmware.
580 argument specifies the interval in seconds between patrol reads.
581 If patrol reads should be run continuously,
584 should consist of the word
588 argument specifies a non-negative, relative start time for the next patrol read.
589 If an interval or start time is not specified,
590 then the existing setting will be used.
592 Enable manual patrol reads that are only initiated by the user.
595 Start a patrol read operation.
597 Stop a currently running patrol read operation.
599 Scan for foreign configurations and display the number found. The
601 argument for the commands below takes the form of a number from 0 to the total
602 configurations found.
603 .It Cm foreign clear Op config
604 Clear the specifed foreign
608 argument is provided.
609 .It Cm foreign diag Op config
610 Display a diagnostic display of the specifed foreign
614 argument is provided.
615 .It Cm foreign preview Op config
616 Preview the specifed foreign
618 after import or all if no
620 argument is provided.
621 .It Cm foreign import Op config
622 Import the specifed foreign
626 argument is provided.
628 Updates the flash on the controller with the firmware stored in
630 A reboot is required for the new firmware to take effect.
632 Start a battery relearn.
633 Note that this seems to always result in the battery being completely drained,
634 regardless of the BBU mode.
635 In particular, the controller write cache will be disabled during the relearn
636 even if transparent learning mode is enabled.
637 .It Cm bbu Ar setting Ar value
638 Update battery backup unit (BBU) properties related to battery relearning.
639 The following settings are configurable:
640 .Bl -tag -width indent
642 Add a delay to the next scheduled battery relearn event. This setting is
643 given in hours and must lie in the range of 0 to 255.
644 .It Cm autolearn-mode
645 Enable or disable automatic periodic battery relearning.
646 The setting may be set to
650 to respectively enable or disable the relearn cycle.
651 Alternatively, a mode of 0, 1 or 2 may be given.
652 Mode 0 enables periodic relearning, mode 1 disables it, and mode 2 disables
653 it and logs a warning to the event log when it detects that a battery relearn
656 Set the BBU's mode of operation. This setting is not supported by all BBUs.
657 Where it is supported, the possible values are the integers between 1 and 5
659 Modes 1, 2 and 3 enable a transparent learn cycle, whereas modes 4 and 5 do not.
660 The BBU's data retention time is greater when transparent learning is not used.
664 Configure the cache for volume mfid0 to cache only writes:
666 .Dl Nm Cm cache mfid0 writes
667 .Dl Nm Cm cache mfid0 write-back
669 Create a RAID5 array spanning the first four disks in the second enclosure:
671 .Dl Nm Cm create raid5 e1:s0,e1:s1,e1:s2,e1:s4
673 Configure the first three disks on a controller as JBOD:
675 .Dl Nm Cm create jbod 0 1 2
677 Create a RAID10 volume that spans two arrays each of which contains two disks
678 from two different enclosures:
680 .Dl Nm Cm create raid10 e1:s0,e1:s1 e2:s0,e2:s1
682 Add drive with the device ID of 4 as a global hot spare:
686 Add the drive in slot 2 in the main chassis as a hot spare for volume mfid0:
688 .Dl Nm Cm add s2 mfid0
690 Reconfigure a disk as a SYSPD block device with no RAID
694 Configure the adapter to run periodic patrol reads once a week with the first
695 patrol read starting in 5 minutes:
697 .Dl Nm Cm patrol auto 604800 300
699 Display the second detected foreign configuration:
701 .Dl Nm Cm show foreign 1
707 utility first appeared in