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
91 .Cm drive progress Ar drive
94 .Cm drive clear Ar drive Brq "start | stop"
97 .Cm start rebuild Ar drive
100 .Cm abort rebuild Ar drive
103 .Cm locate Ar drive Brq "on | off"
106 .Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
109 .Cm name Ar volume Ar name
112 .Cm volume progress Ar volume
120 .Op Fl s Ar stripe_size
121 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
122 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
128 .Cm add Ar drive Op Ar volume
140 .Cm patrol Ar command Op Ar interval Op Ar start
149 .Cm bbu Ar setting Ar value
153 utility can be used to display or modify various parameters on LSI
154 MegaRAID SAS RAID controllers.
157 consists of zero or more global options followed by a command.
158 Commands may support additional optional or required arguments after the
161 Currently one global option is supported:
162 .Bl -tag -width indent
165 specifies the unit of the controller to work with.
166 If no unit is specified,
170 Various commands accept either or both of the two options:
171 .Bl -tag -width indent
173 Print numeric device IDs as drive identifier.
175 Useful in combination with
177 to print both, numeric device IDs and enclosure:slot information.
179 Print drive identifiers in enclosure:slot form.
180 See next paragraph on format details in context of input rather than
184 Drives may be specified in two forms.
186 a drive may be identified by its device ID.
187 The device ID for configured drives can be found in
190 a drive may be identified by its location as
200 is the slot for each drive as displayed in
203 Volumes may be specified in two forms.
205 a volume may be identified by its target ID.
207 on the volume may be specified by the corresponding
215 utility supports several different groups of commands.
216 The first group of commands provide information about the controller,
217 the volumes it manages, and the drives it controls.
218 The second group of commands are used to manage the physical drives
219 attached to the controller.
220 The third group of commands are used to manage the logical volumes
221 managed by the controller.
222 The fourth group of commands are used to manage the drive configuration for
224 The fifth group of commands are used to manage controller-wide operations.
226 The informational commands include:
227 .Bl -tag -width indent
229 Displays the version of
232 Displays information about the RAID controller such as the model number.
234 Displays information about the battery from the battery backup unit.
236 Displays the volume and drive configuration for the controller.
237 Each array is listed along with the physical drives the array is built from.
238 Each volume is listed along with the arrays that the volume spans.
239 If any hot spare drives are configured, then they are listed as well.
241 Lists all of the physical drives attached to the controller.
242 .It Xo Cm show events
247 .Op Ar start Op Ar stop
249 Display entries from the controller's event log.
250 The controller maintains a circular buffer of events.
251 Each event is tagged with a class and locale.
255 parameter limits the output to entries at the specified class or higher.
258 The available classes from lowest priority to highest are:
259 .Bl -tag -width -indent
263 Periodic progress updates for long-running operations such as background
264 initializations, array rebuilds, or patrol reads.
266 Informational messages such as drive insertions and volume creations.
268 Indicates that some component may be close to failing.
270 A component has failed, but no data is lost.
271 For example, a volume becoming degraded due to a drive failure.
273 A component has failed resulting in data loss.
275 The controller itself has died.
280 parameter limits the output to entries for the specified part of the controller.
281 The default locale is
283 The available locales are
297 parameter is a debugging aid that specifies the number of events to fetch from
298 the controller for each low-level request.
299 The default is 15 events.
301 By default, matching event log entries from the previous shutdown up to the
302 present are displayed. This range can be adjusted via the
307 Each of these parameters can either be specified as a log entry number or as
308 one of the following aliases:
309 .Bl -tag -width -indent
311 The newest entry in the event log.
313 The oldest entry in the event log.
315 The first entry since the event log was cleared.
317 The entry in the event log corresponding to the last time the controller was
320 The entry in the event log corresponding to the most recent boot.
323 Lists all of the firmware images present on the controller.
325 Display the various sequence numbers associated with the event log.
327 Display the status of the controller's patrol read operation.
329 Report the current progress and estimated completion time for active
330 operations on all volumes and drives.
332 Lists all of the logical volumes managed by the controller.
335 The physical drive management commands include:
336 .Bl -tag -width indent
342 must be an online drive that is part of an array.
346 as an unconfigured good drive.
348 must not be part of an existing array.
349 .It Cm rebuild Ar drive
352 that is still part of an array as a good drive suitable for a rebuild.
353 The firmware should kick off an array rebuild on its own if a failed drive
354 is marked as a rebuild drive.
355 .It Cm drive progress Ar drive
356 Report the current progress and estimated completion time of drive operations
357 such as rebuilds or patrol reads.
358 .It Cm drive clear Ar drive Brq "start | stop"
359 Start or stop the writing of all 0x00 characters to a drive.
360 .It Cm start rebuild Ar drive
361 Manually start a rebuild on
363 .It Cm abort rebuild Ar drive
364 Abort an in-progress rebuild operation on
366 It can be resumed with the
369 .It Cm locate Ar drive Brq "on | off"
370 Change the state of the external LED associated with
374 The logical volume management commands include:
375 .Bl -tag -width indent
376 .It Cm cache Ar volume Op Ar setting Oo Ar value Oc Op ...
379 arguments are supplied, then the current cache policy for
388 arguments may be given.
389 Some settings take an additional
391 argument as noted below.
392 The valid settings are:
393 .Bl -tag -width indent
395 Enable caching for both read and write I/O operations.
397 Disable caching for both read and write I/O operations.
399 Enable caching only for read I/O operations.
401 Enable caching only for write I/O operations.
403 Use write-back policy for cached writes.
405 Use write-through policy for cached writes.
406 .It Cm read-ahead Ar value
407 Set the read ahead policy for cached reads.
410 argument can be set to either
415 .It Cm bad-bbu-write-cache Ar value
416 Control the behavior of I/O write caching if the battery is dead or
420 argument can be set to either
424 In general this setting should be left disabled to avoid data loss when
425 the system loses power.
426 .It Cm write-cache Ar value
427 Control the write caches on the physical drives backing
431 argument can be set to either
437 In general this setting should be left disabled to avoid data loss when the
438 physical drives lose power.
439 The battery backup of the RAID controller does not save data in the write
440 caches of the physical drives.
442 .It Cm name Ar volume Ar name
447 .It Cm volume progress Ar volume
448 Report the current progress and estimated completion time of volume operations
449 such as consistency checks and initializations.
452 The configuration commands include:
453 .Bl -tag -width indent
455 Delete the entire configuration including all volumes, arrays, and spares.
456 .It Xo Cm create Ar type
458 .Op Fl s Ar stripe_size
459 .Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
460 .Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
465 specifies the type of volume to create.
466 Currently supported types include:
467 .Bl -tag -width indent
469 Creates a RAID0 volume for each drive specified.
470 Each drive must be specified as a separate argument.
472 Creates one RAID0 volume spanning the drives listed in the single drive list.
474 Creates one RAID1 volume spanning the drives listed in the single drive list.
476 Creates one RAID5 volume spanning the drives listed in the single drive list.
478 Creates one RAID6 volume spanning the drives listed in the single drive list.
480 Creates one RAID10 volume spanning multiple RAID1 arrays.
481 The drives for each RAID1 array are specified as a single drive list.
483 Creates one RAID50 volume spanning multiple RAID5 arrays.
484 The drives for each RAID5 array are specified as a single drive list.
486 Creates one RAID60 volume spanning multiple RAID6 arrays.
487 The drives for each RAID6 array are specified as a single drive list.
489 Creates a single volume by concatenating all of the drives in the single drive
494 Not all volume types are supported by all controllers.
498 flag is specified after
500 then more verbose output will be enabled.
501 Currently this just provides notification as drives are added to arrays and
502 arrays to volumes when building the configuration.
507 parameter allows the stripe size of the array to be set.
508 By default a stripe size of 64K is used.
509 Valid values are 512 through 1M, though the MFI firmware may reject some
511 .It Cm delete Ar volume
514 .It Cm add Ar drive Op Ar volume
519 must be in the unconfigured good state.
523 then the hot spare will be dedicated to arrays backing that volume.
526 will be used as a global hot spare backing all arrays for this controller.
529 must be as large as the smallest drive in all of the arrays it is going to
531 .It Cm remove Ar drive
535 It will be placed in the unconfigured good state.
538 The controller management commands include:
539 .Bl -tag -width indent
540 .It Cm patrol Ar command Op Ar interval Op Ar start
541 Set the patrol read operation mode.
544 argument can be one of the following values:
545 .Bl -tag -width indent
547 Disable patrol reads.
549 Enable periodic patrol reads initiated by the firmware.
552 argument specifies the interval in seconds between patrol reads.
553 If patrol reads should be run continuously,
556 should consist of the word
560 argument specifies a non-negative, relative start time for the next patrol read.
561 If an interval or start time is not specified,
562 then the existing setting will be used.
564 Enable manual patrol reads that are only initiated by the user.
567 Start a patrol read operation.
569 Stop a currently running patrol read operation.
571 Updates the flash on the controller with the firmware stored in
573 A reboot is required for the new firmware to take effect.
575 Start a battery relearn.
576 .It Cm bbu Ar setting Ar value
577 Update battery backup unit (BBU) properties related to battery relearning.
578 The following settings are configurable:
579 .Bl -tag -width indent
581 Add a delay to the next scheduled battery relearn event. This setting is
582 given in hours and must lie in the range of 0 to 255.
583 .It Cm autolearn-mode
584 Enable or disable automatic periodic battery relearning.
585 The setting may be set to
589 to respectively enable or disable the relearn cycle.
590 Alternatively, a mode of 0, 1 or 2 may be given.
591 Mode 0 enables periodic relearning, mode 1 disables it, and mode 2 disables
592 it and logs a warning to the event log when it detects that a battery relearn
595 Set the BBU's mode of operation. This setting is not supported by all BBUs.
596 Where it is supported, the possible values are the integers between 1 and 5
598 Modes 1, 2 and 3 enable a transparent learn cycle, whereas modes 4 and 5 do not.
599 The BBU's data retention time is greater when transparent learning is not used.
603 Configure the cache for volume mfid0 to cache only writes:
605 .Dl Nm Cm cache mfid0 writes
606 .Dl Nm Cm cache mfid0 write-back
608 Create a RAID5 array spanning the first four disks in the second enclosure:
610 .Dl Nm Cm create raid5 e1:s0,e1:s1,e1:s2,e1:s4
612 Configure the first three disks on a controller as JBOD:
614 .Dl Nm Cm create jbod 0 1 2
616 Create a RAID10 volume that spans two arrays each of which contains two disks
617 from two different enclosures:
619 .Dl Nm Cm create raid10 e1:s0,e1:s1 e2:s0,e2:s1
621 Add drive with the device ID of 4 as a global hot spare:
625 Add the drive in slot 2 in the main chassis as a hot spare for volume mfid0:
627 .Dl Nm Cm add s2 mfid0
629 Configure the adapter to run periodic patrol reads once a week with the first
630 patrol read starting in 5 minutes:
632 .Dl Nm Cm patrol auto 604800 300
639 utility first appeared in
projects / FreeBSD / stable / 8.git / blob