aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJohn Baldwin <jhb@FreeBSD.org>2009-10-28 21:11:13 +0000
committerJohn Baldwin <jhb@FreeBSD.org>2009-10-28 21:11:13 +0000
commit190f5f216b70aa8d2edb1340208b38811d8639ef (patch)
tree58fd52e93b25c8f755b2f78d49adc2466982f90c
parent1e5dd507808c1c5dbfae862cb5b2776659d93598 (diff)
downloadsrc-190f5f216b70aa8d2edb1340208b38811d8639ef.tar.gz
src-190f5f216b70aa8d2edb1340208b38811d8639ef.zip
MFC: Remove spurious README and an old version of the manpage.
Approved by: re (kib)
Notes
Notes: svn path=/releng/8.0/; revision=198557
-rw-r--r--usr.sbin/mfiutil/README104
-rw-r--r--usr.sbin/mfiutil/mfiutil.1574
2 files changed, 0 insertions, 678 deletions
diff --git a/usr.sbin/mfiutil/README b/usr.sbin/mfiutil/README
deleted file mode 100644
index 15e16bb0cddc..000000000000
--- a/usr.sbin/mfiutil/README
+++ /dev/null
@@ -1,104 +0,0 @@
-# $FreeBSD$
-
-This package includes a mfiutil command for administering mfi(4) controllers
-on FreeBSD.
-
-Version 1.0.13
- * Cleaned up warnings in preparation for integration with FreeBSD
-
-Version 1.0.12
- * Add 'drive clear' command to wipe drives with all 0x00 characters
-
-Version 1.0.11
- * Display serial number for drives
- * Display location info for drives with 'show config'
-
-Version 1.0.10
- * Display min and max stripe size supported by adapters.
- * Added support for examining the controller event log.
-
-Version 1.0.9
- * Display stripe size for volumes.
- * Added support for setting the stripe size for new volumes.
- * Fix a regression in 1.0.8 that broke creation of RAID-5 and RAID-50
- arrays.
-
-Version 1.0.8
- * Added support for RAID-60 arrays.
- * Added 'flash' command to support firmware flashing.
-
-Version 1.0.7
- * Renamed 'clear config' to 'clear, 'create volume' to 'create',
- 'delete volume' to 'delete', 'create spare' to 'add', and
- 'delete spare' to 'remove'. The old names still work.
- * Added support for RAID-6 arrays.
-
-Version 1.0.6
- * Added 'show patrol', 'patrol', 'start patrol', and 'stop patrol'
- commands to manage patrol reads.
-
-Version 1.0.5
- * Added 'create volume' and 'delete volume' commands to manage volumes.
- * Added 'clear config' command to clear entire configuration.
- * Added more detailed error reporting based on firmware status codes.
- * Renamed 'progress' command to 'drive progress'.
- * Added 'volume progress' command to display progress of volume-level
- activites such as background inits.
- * Fixed 'create spare' to properly add global spares.
-
-Version 1.0.4
- * Added 'create spare' and 'delete spare' commands to manage hot spares.
- * Added 'good' command to mark unconfigured bad drives as good.
- * Display more information about hot spares in 'show config'
- * Allow physical drives to be specified via Exx:Syy similar to megacli
- * Display onboard memory size in 'show adapter'
-
-Version 1.0.3
- * Added 'cache' command to manage cache settings for volumes.
- * Added 'name' command to name volumes.
- * Added manpage.
-
-Version 1.0.2
- * Added 'show adapter' and 'show battery' commands.
- * Added RAID level of volumes to 'show config' and 'show volumes'.
- * Added drive model info to 'show config' and 'show drives'.
- * Added package firmware version to 'show firmware'.
- * Added read and write cache status to 'show volumes'.
- * Map volume IDs to mfidX device names on newer kernels.
-
-Version 1.0.1
- * Added 'show firmware' command
-
-Version 1.0.0
- * Initial release
-
-usage: mfiutil [-u unit] <command> ...
-
-Commands include:
- version
- show adapter - display controller information
- show battery - display battery information
- show config - display RAID configuration
- show drives - list physical drives
- show firmware - list firmware images
- show volumes - list logical volumes
- show patrol - display patrol read status
- fail <drive> - fail a physical drive
- good <drive> - mark a bad physical drive as good
- rebuild <drive> - mark failed drive ready for rebuild
- drive progress <drive> - display status of active operations
- start rebuild <drive>
- abort rebuild <drive>
- locate <drive> <on|off> - toggle drive LED
- cache <volume> [command [setting]]
- name <volume> <name>
- volume progress <volume> - display status of active operations
- clear - clear volume configuration
- create <type> [-v] <drive>[,<drive>[,...]] [<drive>[,<drive>[,...]]
- delete <volume>
- add <drive> [volume] - add a hot spare
- remove <drive> - remove a hot spare
- patrol <disable|auto|manual> [interval [start]]
- start patrol - start a patrol read
- stop patrol - stop a patrol read
- flash <firmware>
diff --git a/usr.sbin/mfiutil/mfiutil.1 b/usr.sbin/mfiutil/mfiutil.1
deleted file mode 100644
index d7860ab06dd4..000000000000
--- a/usr.sbin/mfiutil/mfiutil.1
+++ /dev/null
@@ -1,574 +0,0 @@
-.\" Copyright (c) 2008, 2009 Yahoo!, Inc.
-.\" All rights reserved.
-.\"
-.\" Redistribution and use in source and binary forms, with or without
-.\" modification, are permitted provided that the following conditions
-.\" are met:
-.\" 1. Redistributions of source code must retain the above copyright
-.\" notice, this list of conditions and the following disclaimer.
-.\" 2. Redistributions in binary form must reproduce the above copyright
-.\" notice, this list of conditions and the following disclaimer in the
-.\" documentation and/or other materials provided with the distribution.
-.\" 3. The names of the authors may not be used to endorse or promote
-.\" products derived from this software without specific prior written
-.\" permission.
-.\"
-.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
-.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
-.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
-.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
-.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
-.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
-.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
-.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
-.\" SUCH DAMAGE.
-.\"
-.\" $FreeBSD$
-.\"
-.Dd June 17, 2008
-.Dt MFIUTIL 1
-.Os
-.Sh NAME
-.Nm mfiutil
-.Nd Utility for managing LSI MegaRAID SAS controllers
-.Sh SYNOPSIS
-.Nm
-.Cm version
-.Nm
-.Op Fl u Ar unit
-.Cm show adapter
-.Nm
-.Op Fl u Ar unit
-.Cm show battery
-.Nm
-.Op Fl u Ar unit
-.Cm show config
-.Nm
-.Op Fl u Ar unit
-.Cm show drives
-.Nm
-.Op Fl u Ar unit
-.Cm show events
-.Op Fl c Ar class
-.Op Fl l Ar locale
-.Op Fl n Ar count
-.Op Fl v
-.Op Ar start Op Ar stop
-.Nm
-.Op Fl u Ar unit
-.Cm show firmware
-.Nm
-.Op Fl u Ar unit
-.Cm show logstate
-.Nm
-.Op Fl u Ar unit
-.Cm show patrol
-.Nm
-.Op Fl u Ar unit
-.Cm show volumes
-.Nm
-.Op Fl u Ar unit
-.Cm fail Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm good Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm rebuild Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm drive progress Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm drive clear Ar drive Brq "start | stop"
-.Nm
-.Op Fl u Ar unit
-.Cm start rebuild Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm abort rebuild Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm locate Ar drive Brq "on | off"
-.Nm
-.Op Fl u Ar unit
-.Cm cache Ar volume Op Ar setting Op Ar value
-.Nm
-.Op Fl u Ar unit
-.Cm name Ar volume Ar name
-.Nm
-.Op Fl u Ar unit
-.Cm volume progress Ar volume
-.Nm
-.Op Fl u Ar unit
-.Cm clear
-.Nm
-.Op Fl u Ar unit
-.Cm create Ar type
-.Op Fl v
-.Op Fl s Ar stripe_size
-.Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
-.Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
-.Nm
-.Op Fl u Ar unit
-.Cm delete Ar volume
-.Nm
-.Op Fl u Ar unit
-.Cm add Ar drive Op Ar volume
-.Nm
-.Op Fl u Ar unit
-.Cm remove Ar drive
-.Nm
-.Op Fl u Ar unit
-.Cm start patrol
-.Nm
-.Op Fl u Ar unit
-.Cm stop patrol
-.Nm
-.Op Fl u Ar unit
-.Cm patrol Ar command Op Ar interval Op Ar start
-.Nm
-.Op Fl u Ar unit
-.Cm flash Ar file
-.Sh DESCRIPTION
-The
-.Nm
-utility can be used to display or modify various parameters on LSI
-MegaRAID SAS RAID controllers.
-Each invocation of
-.Nm
-consists of zero or more global options followed by a command.
-Commands may support additional optional or required arguments after the
-command.
-.Pp
-Currently one global option is supported:
-.Bl -tag -width indent
-.It Fl u Ar unit
-.Ar unit
-specifies the unit of the controller to work with.
-If no unit is specified,
-then unit 0 is used.
-.El
-.Pp
-Volumes may be specified in two forms.
-First,
-a volume may be identified by its target ID.
-Second,
-on the volume may be specified by the corresponding
-.Em mfidX
-device,
-such as
-.Em mfid0 .
-Note that this second method only works on OS versions
-.Dv 6.2-YAHOO-20070510
-and later.
-.Pp
-Drives may be specified in two forms.
-First,
-a drive may be identified by its device ID.
-The device ID for configured drives can be found in
-.Cm show config .
-Second,
-a drive may be identified by its location as
-.Sm off
-.Op E Ar xx Ns \&:
-.Li S Ns Ar yy
-.Sm on
-where
-.Ar xx
-is the enclosure
-and
-.Ar yy
-is the slot for each drive as displayed in
-.Cm show drives .
-.Pp
-The
-.Nm
-utility supports several different groups of commands.
-The first group of commands provide information about the controller,
-the volumes it manages, and the drives it controls.
-The second group of commands are used to manage the physical drives
-attached to the controller.
-The third group of commands are used to manage the logical volumes
-managed by the controller.
-The fourth group of commands are used to manage the drive configuration for
-the controller.
-The fifth group of commands are used to manage controller-wide operations.
-.Pp
-The informational commands include:
-.Bl -tag -width indent
-.It Cm version
-Displays the version of
-.Nm .
-.It Cm show adapter
-Displays information about the RAID controller such as the model number.
-.It Cm show battery
-Displays information about the battery from the battery backup unit.
-.It Cm show config
-Displays the volume and drive configuration for the controller.
-Each array is listed along with the physical drives the array is built from.
-Each volume is listed along with the arrays that the volume spans.
-If any hot spare drives are configured, then they are listed as well.
-.It Cm show drives
-Lists all of the physical drives attached to the controller.
-.It Xo Cm show events
-.Op Fl c Ar class
-.Op Fl l Ar locale
-.Op Fl n Ar count
-.Op Fl v
-.Op Ar start Op Ar stop
-.Xc
-Display entries from the controller's event log.
-The controller maintains a circular buffer of events.
-Each event is tagged with a class and locale.
-.Pp
-The
-.Ar class
-parameter limits the output to entries at the specified class or higher.
-The default class is
-.Dq warn .
-The available classes from lowest priority to highest are:
-.Bl -tag -width -indent
-.It Cm debug
-Debug messages.
-.It Cm progress
-Periodic progress updates for long-running operations such as background
-initializations, array rebuilds, or patrol reads.
-.It Cm info
-Informational messages such as drive insertions and volume creations.
-.It Cm warn
-Indicates that some component may be close to failing.
-.It Cm crit
-A component has failed, but no data is lost.
-For example, a volume becoming degraded due to a drive failure.
-.It Cm fatal
-A component has failed resulting in data loss.
-.It Cm dead
-The controller itself has died.
-.El
-.Pp
-The
-.Ar locale
-parameter limits the output to entries for the specified part of the controller.
-The default locale is
-.Dq all .
-The available locales are
-.Dq volume ,
-.Dq drive ,
-.Dq enclousure ,
-.Dq battery ,
-.Dq sas ,
-.Dq controller ,
-.Dq config ,
-.Dq cluster ,
-and
-.Dq all .
-.Pp
-The
-.Ar count
-parameter is a debugging aid that specifies the number of events to fetch from
-the controller for each low-level request.
-The default is 15 events.
-.Pp
-By default, matching event log entries from the previous shutdown up to the
-present are displayed. This range can be adjusted via the
-.Ar start
-and
-.Ar stop
-parameters.
-Each of these parameters can either be specified as a log entry number or as
-one of the following aliases:
-.Bl -tag -width -indent
-.It Cm newest
-The newest entry in the event log.
-.It Cm oldest
-The oldest entry in the event log.
-.It Cm clear
-The first entry since the event log was cleared.
-.It Cm shutdown
-The entry in the event log corresponding to the last time the controller was
-cleanly shut down.
-.It Cm boot
-The entry in the event log corresponding to the most recent boot.
-.El
-.It Cm show firmware
-Lists all of the firmware images present on the controller.
-.It Cm show logstate
-Display the various sequence numbers associated with the event log.
-.It Cm show patrol
-Display the status of the controller's patrol read operation.
-.It Cm show volumes
-Lists all of the logical volumes managed by the controller.
-.El
-.Pp
-The physical drive management commands include:
-.Bl -tag -width indent
-.It Cm fail Ar drive
-Mark
-.Ar drive
-as failed.
-.Ar Drive
-must be an online drive that is part of an array.
-.It Cm good Ar drive
-Mark
-.Ar drive
-as an unconfigured good drive.
-.Ar Drive
-must not be part of an existing array.
-.It Cm rebuild Ar drive
-Mark a failed
-.Ar drive
-that is still part of an array as a good drive suitable for a rebuild.
-The firmware should kick off an array rebuild on its own if a failed drive
-is marked as a rebuild drive.
-.It Cm drive progress Ar drive
-Report the current progress and estimated completion time of drive operations
-such as rebuilds or patrol reads.
-.It Cm drive clear Ar drive Brq "start | stop"
-Start or stop the writing of all 0x00 characters to a drive.
-.It Cm start rebuild Ar drive
-Manually start a rebuild on
-.Ar drive .
-.It Cm abort rebuild Ar drive
-Abort an in-progress rebuild operation on
-.Ar drive .
-It can be resumed with the
-.Cm start rebuild
-command.
-.It Cm locate Ar drive Brq "on | off"
-Change the state of the external LED associated with
-.Ar drive .
-.El
-.Pp
-The logical volume management commands include:
-.Bl -tag -width indent
-.It Cm cache Ar volume Op Ar setting Op Ar value
-If no
-.Ar setting
-argument is supplied, then the current cache policy for
-.Ar volume
-is displayed;
-otherwise,
-the cache policy for
-.Ar volume
-is modified.
-The optional
-.Ar setting
-argument can be one of the following values:
-.Bl -tag -width indent
-.It Cm enable
-Enable caching for both read and write I/O operations.
-.It Cm disable
-Disable caching for both read and write I/O operations.
-.It Cm reads
-Enable caching only for read I/O operations.
-.It Cm writes
-Enable caching only for write I/O operations.
-.It Cm write-back
-Use write-back policy for cached writes.
-.It Cm write-through
-Use write-through policy for cached writes.
-.It Cm read-ahead Op Ar value
-Set the read ahead policy for cached reads.
-The
-.Ar value
-argument can be set to either
-.Dq none ,
-.Dq adaptive ,
-or
-.Dq always .
-.It Cm write-cache Op Ar value
-Control the write caches on the physical drives backing
-.Ar volume .
-The
-.Ar value
-argument can be set to either
-.Dq disable ,
-.Dq enable ,
-or
-.Dq default .
-.Pp
-In general this setting should be left disabled to avoid data loss when the
-physical drives lose power.
-The battery backup of the RAID controller does not save data in the write
-caches of the physical drives.
-.El
-.It Cm name Ar volume Ar name
-Sets the name of
-.Ar volume
-to
-.Ar name .
-.It Cm volume progress Ar volume
-Report the current progress and estimated completion time of volume operations
-such as consistency checks and initializations.
-.El
-.Pp
-The configuration commands include:
-.Bl -tag -width indent
-.It Cm clear
-Delete the entire configuration including all volumes, arrays, and spares.
-.It Xo Cm create Ar type
-.Op Fl v
-.Op Fl s Ar stripe_size
-.Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
-.Op Ar drive Ns Op \&, Ns Ar drive Ns Op ",..."
-.Xc
-Create a new volume.
-The
-.Ar type
-specifies the type of volume to create.
-Currently supported types include:
-.Bl -tag -width indent
-.It Cm jbod
-Creates a RAID0 volume for each drive specified.
-Each drive must be specified as a separate argument.
-.It Cm raid0
-Creates one RAID0 volume spanning the drives listed in the single drive list.
-.It Cm raid1
-Creates one RAID1 volume spanning the drives listed in the single drive list.
-.It Cm raid5
-Creates one RAID5 volume spanning the drives listed in the single drive list.
-.It Cm raid6
-Creates one RAID6 volume spanning the drives listed in the single drive list.
-.It Cm raid10
-Creates one RAID10 volume spanning multiple RAID1 arrays.
-The drives for each RAID1 array are specified as a single drive list.
-.It Cm raid50
-Creates one RAID50 volume spanning multiple RAID5 arrays.
-The drives for each RAID5 array are specified as a single drive list.
-.It Cm raid60
-Creates one RAID60 volume spanning multiple RAID6 arrays.
-The drives for each RAID6 array are specified as a single drive list.
-.It Cm concat
-Creates a single volume by concatenating all of the drives in the single drive
-list.
-.El
-.Pp
-.Sy Note:
-Not all volume types are supported by all controllers.
-.Pp
-If the
-.Fl v
-flag is specified after
-.Ar type ,
-then more verbose output will be enabled.
-Currently this just provides notification as drives are added to arrays and
-arrays to volumes when building the configuration.
-.Pp
-The
-.Fl s
-.Ar stripe_size
-parameter allows the stripe size of the array to be set.
-By default a stripe size of 64K is used.
-Valid values are 512 through 1M, though the MFI firmware may reject some
-values.
-.It Cm delete Ar volume
-Delete the volume
-.Ar volume .
-.It Cm add Ar drive Op Ar volume
-Mark
-.Ar drive
-as a hot spare.
-.Ar Drive
-must be in the unconfigured good state.
-If
-.Ar volume
-is specified,
-then the hot spare will be dedicated to arrays backing that volume.
-Otherwise,
-.Ar drive
-will be used as a global hot spare backing all arrays for this controller.
-Note that
-.Ar drive
-must be as large as the smallest drive in all of the arrays it is going to
-back.
-.It Cm remove Ar drive
-Remove the hot spare
-.Ar drive
-from service.
-It will be placed in the unconfigured good state.
-.El
-.Pp
-The controller management commands include:
-.Bl -tag -width indent
-.It Cm patrol Ar command Op Ar interval Op Ar start
-Set the patrol read operation mode.
-The
-.Ar command
-argument can be one of the following values:
-.Bl -tag -width indent
-.It Cm disable
-Disable patrol reads.
-.It Cm auto
-Enable periodic patrol reads initiated by the firmware.
-The optional
-.Ar interval
-argument specifies the interval in seconds between patrol reads.
-If patrol reads should be run continously,
-then
-.Ar interval
-should consist of the word
-.Dq continuously .
-The optional
-.Ar start
-argument specifies a non-negative, relative start time for the next patrol read.
-If an interval or start time is not specified,
-then the existing setting will be used.
-.It Cm manual
-Enable manual patrol reads that are only initiated by the user.
-.El
-.It Cm start patrol
-Start a patrol read operation.
-.It Cm stop patrol
-Stop a currently running patrol read operation.
-.It Cm flash Ar file
-Updates the flash on the controller with the firmware stored in
-.Ar file .
-A reboot is required for the new firmware to take effect.
-.El
-.Sh EXAMPLES
-Configure the cache for volume mfid0 to cache only writes:
-.Pp
-.Dl Nm Cm cache mfid0 writes
-.Dl Nm Cm cache mfid0 write-back
-.Pp
-Create a RAID5 array spanning the first four disks in the second enclosure:
-.Pp
-.Dl Nm Cm create raid5 e1:s0,e1:s1,e1:s2,e1:s4
-.Pp
-Configure the first three disks on a controller as JBOD:
-.Pp
-.Dl Nm Cm create jbod 0 1 2
-.Pp
-Create a RAID10 volume that spans two arrays each of which contains two disks
-from two different enclosures:
-.Pp
-.Dl Nm Cm create raid10 e1:s0,e1:s1 e2:s0,e2:s1
-.Pp
-Add drive with the device ID of 4 as a global hot spare:
-.Pp
-.Dl Nm Cm add 4
-.Pp
-Add the drive in slot 2 in the main chassis as a hot spare for volume mfid0:
-.Pp
-.Dl Nm Cm add s2 mfid0
-.Pp
-Configure the adapter to run periodic patrol reads once a week with the first
-patrol read starting in 5 minutes:
-.Pp
-.Dl Nm Cm patrol auto 604800 300
-.Pp
-.Sh SEE ALSO
-.Xr mfi 4
-.Sh BUGS
-On 64-bit OS versions
-.Dv 6.2-YAHOO-20070514
-and earlier,
-the
-.Xr mfi 4
-driver does not properly report firmware errors to 32-bit versions of
-.Nm .
-As a result,
-some commands may fail even though they do not report any errors.