usr.sbin/mlxcontrol/mlxcontrol.8

   1 .\"
   2 .\" Copyright (c) 2000 Michael Smith
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. The name of the author may not be used to endorse or promote products
  11 .\"    derived from this software without specific prior written permission
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .Dd April 10, 2000
  25 .Dt MLXCONTROL 8
  26 .Os
  27 .Sh NAME
  28 .Nm mlxcontrol
  29 .Nd Mylex DAC-family RAID management utility
  30 .Sh SYNOPSIS
  31 .Nm
  32 .Aq command
  33 .Op args
  34 .Nm
  35 status
  36 .Op Fl qv
  37 .Op Ar drive
  38 .Nm
  39 rescan
  40 .Ar controller
  41 .Op Ar controller ...
  42 .Nm
  43 detach
  44 .Ar drive
  45 .Op Ar drive ...
  46 .Nm
  47 detach
  48 .Fl a
  49 .Nm
  50 check
  51 .Ar drive
  52 .Nm
  53 config
  54 .Ar controller
  55 .Nm
  56 help
  57 .Ar command
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 utility provides status monitoring and management functions
  62 for devices attached
  63 to the
  64 .Xr mlx 4
  65 driver.
  66 .Pp
  67 Controller names are of the form "mlxN"
  68 where N is the unit number of the controller.
  69 Drive names are of the form "mlxdN"
  70 where N is the unit number of the drive.
  71 Do not specify the path to a device node.
  72 .Bl -tag -width rebuild
  73 .It status
  74 Print the status of controllers and system drives.
  75 If one or more drives are specified,
  76 only print information about these drives,
  77 otherwise print information
  78 about all controllers and drives in the system.
  79 With the
  80 .Fl v
  81 flag, display much more verbose information.
  82 With the
  83 .Fl q
  84 flag, do not print any output.
  85 This command returns
  86 0 if all drives tested are online,
  87 1 if one or more drives are critical and
  88 2 if one or more are offline.
  89 .It rescan
  90 Rescan one or more controllers for non-attached system drives
  91 (e.g.\& drives that have been
  92 detached or created subsequent to driver initialisation).
  93 If the
  94 .Fl a
  95 flag is supplied, rescan all controllers in the system.
  96 .It detach
  97 Detach one or more system drives.
  98 Drives must be unmounted
  99 and not opened by any other utility for this command to succeed.
 100 If the
 101 .Fl a
 102 flag is supplied, detach all system drives from the nominated controller.
 103 .It check
 104 Initiate a consistency check and repair pass on a redundant system drive
 105 (e.g.\& RAID1 or RAID5).
 106 The controller will scan the system drive and repair any inconsistencies.
 107 This command returns immediately;
 108 use the
 109 .Ar status
 110 command to monitor the progress of the check.
 111 .It rebuild
 112 Requires two arguments,
 113 .Ar controller
 114 and
 115 .Ar physdrive
 116 as specified in the
 117 output of the
 118 .Ar status
 119 command.
 120 All system drives using space on the physical drive
 121 .Ar physdrive
 122 are rebuilt, reconstructing all data on the drive.
 123 Note that each controller can only perform one rebuild at a time.
 124 This command returns immediately; use the
 125 .Ar status
 126 command to monitor the progress of the rebuild.
 127 .It config
 128 Print the current configuration from the nominated controller.
 129 This command will be updated
 130 to allow addition/deletion of system drives from a configuration
 131 in a future release.
 132 .It help
 133 Print usage information for
 134 .Ar command .
 135 .El
 136 .Sh AUTHORS
 137 The
 138 .Nm
 139 utility was written by
 140 .An Michael Smith Aq Mt msmith@FreeBSD.org .
 141 .Sh BUGS
 142 The
 143 .Ar config
 144 command does not yet support modifying system drive configuration.
 145 .Pp
 146 Error log extraction is not yet supported.