xref: /freebsd/usr.sbin/mlxcontrol/mlxcontrol.8 (revision 1cfb436ae6614dcd7ad460ea058b3da147577379)
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$
25.\"
26.Dd April 10, 2000
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 mlxcontrol
34.Aq command
35.Op args
36.Nm mlxcontrol
37status
38.Op Fl qv
39.Op Ar drive
40.Nm mlxcontrol
41rescan
42.Ar controller
43.Op Ar controller ...
44.Nm mlxcontrol
45detach
46.Ar drive
47.Op Ar drive ...
48.Nm mlxcontrol
49detach
50.Fl a
51.Nm mlxcontrol
52check
53.Ar drive
54.Nm mlxcontrol
55config
56.Ar controller
57.Nm mlxcontrol
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.Pp
75.Bl -tag -width rebuild
76.It status
77Print the status of controllers and system drives.
78If one or more drives are specified,
79only print information about these drives,
80otherwise print information
81about all controllers and drives in the system.
82With the
83.Fl v
84flag, display much more verbose information.
85With the
86.Fl q
87flag, do not print any output.
88This command returns
890 if all drives tested are online,
901 if one or more drives are critical and
912 if one or more are offline.
92.It rescan
93Rescan one or more controllers for non-attached system drives
94(eg. drives that have been
95detached or created subsequent to driver initialisation).
96If the
97.Fl a
98flag is supplied, rescan all controllers in the system.
99.It detach
100Detach one or more system drives.
101Drives must be unmounted
102and not opened by any other utility for this command to succeed.
103If the
104.Fl a
105flag is supplied, detach all system drives from the nominated controller.
106.It check
107Initiate a consistency check and repair pass on a redundant system drive
108(eg. RAID1 or RAID5).
109The controller will scan the system drive and repair any inconsistencies.
110This command returns immediately;
111use the
112.Ar status
113command to monitor the progress of the check.
114.It rebuild
115Requires two arguments,
116.Ar controller
117and
118.Ar physdrive
119as specified in the
120output of the
121.Ar status
122command. All 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.  This
126command 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 BUGS
139The
140.Ar config
141command does not yet support modifying system drive configuration.
142.Pp
143Error log extraction is not yet supported.
144.Sh AUTHORS
145The mlxcontrol utility was written by
146.An Michael Smith
147.Aq msmith@FreeBSD.org .
148