xref: /netbsd/usr.sbin/mlxctl/mlxctl.8 (revision c4a72b64)
1.\"	$NetBSD: mlxctl.8,v 1.5 2002/08/26 17:05:43 ad Exp $
2.\"
3.\" Copyright (c) 2001 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Andrew Doran.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.\" Copyright (c) 2000 Michael Smith
38.\" All rights reserved.
39.\"
40.\" Redistribution and use in source and binary forms, with or without
41.\" modification, are permitted provided that the following conditions
42.\" are met:
43.\" 1. Redistributions of source code must retain the above copyright
44.\"    notice, this list of conditions and the following disclaimer.
45.\" 2. The name of the author may not be used to endorse or promote products
46.\"    derived from this software without specific prior written permission
47.\"
48.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
49.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
50.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
51.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
52.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
53.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
54.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
55.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
56.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
57.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
58.\"
59.\" from FreeBSD: mlxcontrol.8,v 1.6 2000/11/20 20:10:07 ru Exp
60.\"
61.Dd April 10, 2000
62.Dt MLXCTL 8
63.Os
64.Sh NAME
65.Nm mlxctl
66.Nd Mylex DAC960 family management utility
67.Sh SYNOPSIS
68.Nm mlxctl
69.Op Fl f Ar dev
70.Op Fl v
71.Op Fl a
72status
73.Op Ar drive
74.Op Ar ...
75.Nm mlxctl
76.Op Fl f Ar dev
77.Op Fl a
78detach
79.Op Ar drive
80.Op Ar ...
81.Nm mlxctl
82.Op Fl f Ar dev
83.Op Fl a
84check
85.Op Ar drive
86.Op Ar ...
87.Nm mlxctl
88.Op Fl f Ar dev
89rebuild
90.Ar channel:target
91.Nm mlxctl
92.Op Fl f Ar dev
93cstatus
94.Nm mlxctl
95.Op Fl f Ar dev
96rescan
97.Nm mlxctl
98.Op Fl f Ar dev
99config
100.Sh DESCRIPTION
101The
102.Nm
103utility performs status monitoring and management functions for Mylex DAC960
104RAID controllers and attached devices.
105.Pp
106The following options are available:
107.Bl -tag -width xxxxxxx
108.It Fl a
109Apply the action to all drives attached to the controller.
110.It Fl f Ar dev
111Specify the control device to use.  The default is
112.Pa /dev/mlx0 .
113.It Fl v
114Incresed verbosity.
115.El
116.Pp
117The following commands are available:
118.Bl -tag -width rebuild
119.It cstatus
120Display the controller's current status.
121.It status
122Display the status of the specified drives.
123This command returns
1240 if all drives tested are online,
1251 if one or more drives are critical and
1262 if one or more are offline.
127.It rescan
128Re-scan the logical drive table, and attach or detach devices from the system
129as necessary.
130.It detach
131Detach the specified drives.  Drives must be unmounted and unopened for this
132command to succeed.
133.It check
134Initiate a consistency check and repair pass on a drive that provides
135redundancy (eg. RAID1 or RAID5).  This command returns immediately.  The
136.Ar status
137command can be used to monitor the progress of the check.
138.It rebuild
139Rebuild onto the specified physical drive.  Note that there can be only one
140running rebuild operation per controller at any given time.
141This command returns immediately.  The
142.Ar cstatus
143command can be used to monitor the progress of the rebuild.
144.It config
145Write the current system drive configuration to stdout.
146.El
147.Sh EXAMPLES
148Display the status of drive ld3 attached to the controller mlx1:
149.sp
150.D1 Li "mlxctl -f /dev/mlx1 -v status ld3"
151.Sh SEE ALSO
152.Xr ld 4 ,
153.Xr mlx 4
154.Sh HISTORY
155The
156.Nm
157command first appeared in
158.Nx 1.5.3 .
159.Sh AUTHORS
160The
161.Nm
162command was written by Micheal Smith
163.Aq msmith@freebsd.org ,
164and appeared in
165.Fx
166under the guise of
167.Ic mlxcontrol .
168It was modified for
169.Nx
170by Andrew Doran
171.Aq ad@netbsd.org .
172.Sh BUGS
173Modifying drive configuration is not yet supported.
174.Pp
175Some commands do not work with older firmware revisions.
176.Pp
177Error log extraction is not yet supported.
178