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