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