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