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
94 .Cm drive progress Ar drive
97 .Cm drive clear Ar drive Brq "start | stop"
100 .Cm start rebuild Ar drive
103 .Cm abort rebuild Ar drive
106 .Cm locate Ar drive Brq "on | off"
109 .Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
112 .Cm name Ar volume Ar name
115 .Cm volume progress Ar volume
123 .Op Fl s Ar stripe_size
124 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
125 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
131 .Cm add Ar drive Op Ar volume
143 .Cm patrol Ar command Op Ar interval Op Ar start
152 .Cm bbu Ar setting Ar value
156 utility can be used to display or modify various parameters on LSI
157 MegaRAID SAS RAID controllers.
160 consists of zero or more global options followed by a command.
161 Commands may support additional optional or required arguments after the
164 Currently one global option is supported:
165 .Bl -tag -width indent
168 specifies the unit of the controller to work with.
169 If no unit is specified,
173 Various commands accept either or both of the two options:
174 .Bl -tag -width indent
176 Print numeric device IDs as drive identifier.
178 Useful in combination with
180 to print both, numeric device IDs and enclosure:slot information.
182 Print drive identifiers in enclosure:slot form.
183 See next paragraph on format details in context of input rather than
187 Drives may be specified in two forms.
189 a drive may be identified by its device ID.
190 The device ID for configured drives can be found in
193 a drive may be identified by its location as
203 is the slot for each drive as displayed in
206 Volumes may be specified in two forms.
208 a volume may be identified by its target ID.
210 on the volume may be specified by the corresponding
218 utility supports several different groups of commands.
219 The first group of commands provide information about the controller,
220 the volumes it manages, and the drives it controls.
221 The second group of commands are used to manage the physical drives
222 attached to the controller.
223 The third group of commands are used to manage the logical volumes
224 managed by the controller.
225 The fourth group of commands are used to manage the drive configuration for
227 The fifth group of commands are used to manage controller-wide operations.
229 The informational commands include:
230 .Bl -tag -width indent
232 Displays the version of
235 Displays information about the RAID controller such as the model number.
237 Displays information about the battery from the battery backup unit.
239 Displays the volume and drive configuration for the controller.
240 Each array is listed along with the physical drives the array is built from.
241 Each volume is listed along with the arrays that the volume spans.
242 If any hot spare drives are configured, then they are listed as well.
244 Lists all of the physical drives attached to the controller.
245 .It Xo Cm show events
250 .Op Ar start Op Ar stop
252 Display entries from the controller's event log.
253 The controller maintains a circular buffer of events.
254 Each event is tagged with a class and locale.
258 parameter limits the output to entries at the specified class or higher.
261 The available classes from lowest priority to highest are:
262 .Bl -tag -width -indent
266 Periodic progress updates for long-running operations such as background
267 initializations, array rebuilds, or patrol reads.
269 Informational messages such as drive insertions and volume creations.
271 Indicates that some component may be close to failing.
273 A component has failed, but no data is lost.
274 For example, a volume becoming degraded due to a drive failure.
276 A component has failed resulting in data loss.
278 The controller itself has died.
283 parameter limits the output to entries for the specified part of the controller.
284 The default locale is
286 The available locales are
300 parameter is a debugging aid that specifies the number of events to fetch from
301 the controller for each low-level request.
302 The default is 15 events.
304 By default, matching event log entries from the previous shutdown up to the
305 present are displayed. This range can be adjusted via the
310 Each of these parameters can either be specified as a log entry number or as
311 one of the following aliases:
312 .Bl -tag -width -indent
314 The newest entry in the event log.
316 The oldest entry in the event log.
318 The first entry since the event log was cleared.
320 The entry in the event log corresponding to the last time the controller was
323 The entry in the event log corresponding to the most recent boot.
326 Lists all of the firmware images present on the controller.
328 Display the various sequence numbers associated with the event log.
330 Display the status of the controller's patrol read operation.
332 Report the current progress and estimated completion time for active
333 operations on all volumes and drives.
335 Lists all of the logical volumes managed by the controller.
338 The physical drive management commands include:
339 .Bl -tag -width indent
345 must be an online drive that is part of an array.
349 as an unconfigured good drive.
351 must not be part of an existing array.
352 .It Cm rebuild Ar drive
355 that is still part of an array as a good drive suitable for a rebuild.
356 The firmware should kick off an array rebuild on its own if a failed drive
357 is marked as a rebuild drive.
358 .It Cm syspd Ar drive
359 Present the drive to the host operating system as a disk SYSPD block device in
360 the format /dev/mfisyspdX. Clear this flag with
363 .It Cm drive progress Ar drive
364 Report the current progress and estimated completion time of drive operations
365 such as rebuilds or patrol reads.
366 .It Cm drive clear Ar drive Brq "start | stop"
367 Start or stop the writing of all 0x00 characters to a drive.
368 .It Cm start rebuild Ar drive
369 Manually start a rebuild on
371 .It Cm abort rebuild Ar drive
372 Abort an in-progress rebuild operation on
374 It can be resumed with the
377 .It Cm locate Ar drive Brq "on | off"
378 Change the state of the external LED associated with
382 The logical volume management commands include:
383 .Bl -tag -width indent
384 .It Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
387 arguments are supplied, then the current cache policy for
396 arguments may be given.
397 Some settings take an additional
399 argument as noted below.
400 The valid settings are:
401 .Bl -tag -width indent
403 Enable caching for both read and write I/O operations.
405 Disable caching for both read and write I/O operations.
407 Enable caching only for read I/O operations.
409 Enable caching only for write I/O operations.
411 Use write-back policy for cached writes.
413 Use write-through policy for cached writes.
414 .It Cm read-ahead Ar value
415 Set the read ahead policy for cached reads.
418 argument can be set to either
423 .It Cm bad-bbu-write-cache Ar value
424 Control the behavior of I/O write caching if the battery is dead or
428 argument can be set to either
432 In general this setting should be left disabled to avoid data loss when
433 the system loses power.
434 .It Cm write-cache Ar value
435 Control the write caches on the physical drives backing
439 argument can be set to either
445 In general this setting should be left disabled to avoid data loss when the
446 physical drives lose power.
447 The battery backup of the RAID controller does not save data in the write
448 caches of the physical drives.
450 .It Cm name Ar volume Ar name
455 .It Cm volume progress Ar volume
456 Report the current progress and estimated completion time of volume operations
457 such as consistency checks and initializations.
460 The configuration commands include:
461 .Bl -tag -width indent
463 Delete the entire configuration including all volumes, arrays, and spares.
464 .It Xo Cm create Ar type
466 .Op Fl s Ar stripe_size
467 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
468 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
473 specifies the type of volume to create.
474 Currently supported types include:
475 .Bl -tag -width indent
477 Creates a RAID0 volume for each drive specified.
478 Each drive must be specified as a separate argument.
480 Creates one RAID0 volume spanning the drives listed in the single drive list.
482 Creates one RAID1 volume spanning the drives listed in the single drive list.
484 Creates one RAID5 volume spanning the drives listed in the single drive list.
486 Creates one RAID6 volume spanning the drives listed in the single drive list.
488 Creates one RAID10 volume spanning multiple RAID1 arrays.
489 The drives for each RAID1 array are specified as a single drive list.
491 Creates one RAID50 volume spanning multiple RAID5 arrays.
492 The drives for each RAID5 array are specified as a single drive list.
494 Creates one RAID60 volume spanning multiple RAID6 arrays.
495 The drives for each RAID6 array are specified as a single drive list.
497 Creates a single volume by concatenating all of the drives in the single drive
502 Not all volume types are supported by all controllers.
506 flag is specified after
508 then more verbose output will be enabled.
509 Currently this just provides notification as drives are added to arrays and
510 arrays to volumes when building the configuration.
515 parameter allows the stripe size of the array to be set.
516 By default a stripe size of 64K is used.
517 Valid values are 512 through 1M, though the MFI firmware may reject some
519 .It Cm delete Ar volume
522 .It Cm add Ar drive Op Ar volume
527 must be in the unconfigured good state.
531 then the hot spare will be dedicated to arrays backing that volume.
534 will be used as a global hot spare backing all arrays for this controller.
537 must be as large as the smallest drive in all of the arrays it is going to
539 .It Cm remove Ar drive
543 It will be placed in the unconfigured good state.
546 The controller management commands include:
547 .Bl -tag -width indent
548 .It Cm patrol Ar command Op Ar interval Op Ar start
549 Set the patrol read operation mode.
552 argument can be one of the following values:
553 .Bl -tag -width indent
555 Disable patrol reads.
557 Enable periodic patrol reads initiated by the firmware.
560 argument specifies the interval in seconds between patrol reads.
561 If patrol reads should be run continuously,
564 should consist of the word
568 argument specifies a non-negative, relative start time for the next patrol read.
569 If an interval or start time is not specified,
570 then the existing setting will be used.
572 Enable manual patrol reads that are only initiated by the user.
575 Start a patrol read operation.
577 Stop a currently running patrol read operation.
579 Updates the flash on the controller with the firmware stored in
581 A reboot is required for the new firmware to take effect.
583 Start a battery relearn.
584 Note that this seems to always result in the battery being completely drained,
585 regardless of the BBU mode.
586 In particular, the controller write cache will be disabled during the relearn
587 even if transparent learning mode is enabled.
588 .It Cm bbu Ar setting Ar value
589 Update battery backup unit (BBU) properties related to battery relearning.
590 The following settings are configurable:
591 .Bl -tag -width indent
593 Add a delay to the next scheduled battery relearn event. This setting is
594 given in hours and must lie in the range of 0 to 255.
595 .It Cm autolearn-mode
596 Enable or disable automatic periodic battery relearning.
597 The setting may be set to
601 to respectively enable or disable the relearn cycle.
602 Alternatively, a mode of 0, 1 or 2 may be given.
603 Mode 0 enables periodic relearning, mode 1 disables it, and mode 2 disables
604 it and logs a warning to the event log when it detects that a battery relearn
607 Set the BBU's mode of operation. This setting is not supported by all BBUs.
608 Where it is supported, the possible values are the integers between 1 and 5
610 Modes 1, 2 and 3 enable a transparent learn cycle, whereas modes 4 and 5 do not.
611 The BBU's data retention time is greater when transparent learning is not used.
615 Configure the cache for volume mfid0 to cache only writes:
617 .Dl Nm Cm cache mfid0 writes
618 .Dl Nm Cm cache mfid0 write-back
620 Create a RAID5 array spanning the first four disks in the second enclosure:
622 .Dl Nm Cm create raid5 e1:s0,e1:s1,e1:s2,e1:s4
624 Configure the first three disks on a controller as JBOD:
626 .Dl Nm Cm create jbod 0 1 2
628 Create a RAID10 volume that spans two arrays each of which contains two disks
629 from two different enclosures:
631 .Dl Nm Cm create raid10 e1:s0,e1:s1 e2:s0,e2:s1
633 Add drive with the device ID of 4 as a global hot spare:
637 Add the drive in slot 2 in the main chassis as a hot spare for volume mfid0:
639 .Dl Nm Cm add s2 mfid0
641 Reconfigure a disk as a SYSPD block device with no RAID
645 Configure the adapter to run periodic patrol reads once a week with the first
646 patrol read starting in 5 minutes:
648 .Dl Nm Cm patrol auto 604800 300
655 utility first appeared in
projects / FreeBSD / stable / 8.git / blob