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.\" $FreeBSD: src/usr.sbin/mlxcontrol/mlxcontrol.8,v 1.10 2010/10/08 12:40:16 uqs Exp $ 25.\" 26.Dd November 20, 2010 27.Dt MLXCONTROL 8 28.Os 29.Sh NAME 30.Nm mlxcontrol 31.Nd Mylex DAC-family RAID management utility 32.Sh SYNOPSIS 33.Nm 34.Aq command 35.Op args 36.Nm 37status 38.Op Fl qv 39.Op Ar drive 40.Nm 41rescan 42.Ar controller 43.Op Ar controller ... 44.Nm 45detach 46.Ar drive 47.Op Ar drive ... 48.Nm 49detach 50.Fl a 51.Nm 52check 53.Ar drive 54.Nm 55config 56.Ar controller 57.Nm 58help 59.Ar command 60.Sh DESCRIPTION 61The 62.Nm 63utility provides status monitoring and management functions 64for devices attached 65to the 66.Xr mlx 4 67driver. 68.Pp 69Controller names are of the form "mlxN" 70where N is the unit number of the controller. 71Drive names are of the form "mlxdN" 72where N is the unit number of the drive. 73Do not specify the path to a device node. 74.Bl -tag -width rebuild 75.It status 76Print the status of controllers and system drives. 77If one or more drives are specified, 78only print information about these drives, 79otherwise print information 80about all controllers and drives in the system. 81With the 82.Fl v 83flag, display much more verbose information. 84With the 85.Fl q 86flag, do not print any output. 87This command returns 880 if all drives tested are online, 891 if one or more drives are critical and 902 if one or more are offline. 91.It rescan 92Rescan one or more controllers for non-attached system drives 93(e.g.\& drives that have been 94detached or created subsequent to driver initialisation). 95If the 96.Fl a 97flag is supplied, rescan all controllers in the system. 98.It detach 99Detach one or more system drives. 100Drives must be unmounted 101and not opened by any other utility for this command to succeed. 102If the 103.Fl a 104flag is supplied, detach all system drives from the nominated controller. 105.It check 106Initiate a consistency check and repair pass on a redundant system drive 107(e.g.\& RAID1 or RAID5). 108The controller will scan the system drive and repair any inconsistencies. 109This command returns immediately; 110use the 111.Ar status 112command to monitor the progress of the check. 113.It rebuild 114Requires two arguments, 115.Ar controller 116and 117.Ar physdrive 118as specified in the 119output of the 120.Ar status 121command. 122All system drives using space on the physical drive 123.Ar physdrive 124are rebuilt, reconstructing all data on the drive. 125Note that each controller can only perform one rebuild at a time. 126This command returns immediately; use the 127.Ar status 128command to monitor the progress of the rebuild. 129.It config 130Print the current configuration from the nominated controller. 131This command will be updated 132to allow addition/deletion of system drives from a configuration 133in a future release. 134.It help 135Print usage information for 136.Ar command . 137.El 138.Sh AUTHORS 139The 140.Nm 141utility was written by 142.An Michael Smith Aq Mt msmith@FreeBSD.org . 143.Sh BUGS 144The 145.Ar config 146command does not yet support modifying system drive configuration. 147.Pp 148Error log extraction is not yet supported. 149