xref: /freebsd/usr.sbin/mlxcontrol/mlxcontrol.8 (revision 4ffc1d3dadf6c6ffcdb47cc3dddc19b5a93ca9f1) 
1b6a7bef2SMike Smith.\"
2b6a7bef2SMike Smith.\" Copyright (c) 2000 Michael Smith
3b6a7bef2SMike Smith.\" All rights reserved.
4b6a7bef2SMike Smith.\"
5b6a7bef2SMike Smith.\" Redistribution and use in source and binary forms, with or without
6b6a7bef2SMike Smith.\" modification, are permitted provided that the following conditions
7b6a7bef2SMike Smith.\" are met:
8b6a7bef2SMike Smith.\" 1. Redistributions of source code must retain the above copyright
9b6a7bef2SMike Smith.\"    notice, this list of conditions and the following disclaimer.
10b6a7bef2SMike Smith.\" 2. The name of the author may not be used to endorse or promote products
11b6a7bef2SMike Smith.\"    derived from this software without specific prior written permission
12b6a7bef2SMike Smith.\"
13b6a7bef2SMike Smith.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14b6a7bef2SMike Smith.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
15b6a7bef2SMike Smith.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
16b6a7bef2SMike Smith.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
17b6a7bef2SMike Smith.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18b6a7bef2SMike Smith.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
19b6a7bef2SMike Smith.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
20b6a7bef2SMike Smith.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21b6a7bef2SMike Smith.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
22b6a7bef2SMike Smith.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23b6a7bef2SMike Smith.\"
24b6a7bef2SMike Smith.\" $FreeBSD$
25b6a7bef2SMike Smith.\"
26b6a7bef2SMike Smith.Dd April 10, 2000
27b6a7bef2SMike Smith.Dt MLXCONTROL 8
28b6a7bef2SMike Smith.Os
29b6a7bef2SMike Smith.Sh NAME
30b6a7bef2SMike Smith.Nm mlxcontrol
31b6a7bef2SMike Smith.Nd Mylex DAC-family RAID management utility
32b6a7bef2SMike Smith.Sh SYNOPSIS
33b6a7bef2SMike Smith.Nm mlxcontrol
34b6a7bef2SMike Smith.Aq command
35b6a7bef2SMike Smith.Op args
36b6a7bef2SMike Smith.Nm mlxcontrol
37b6a7bef2SMike Smithstatus
38b6a7bef2SMike Smith.Op Fl qv
39b6a7bef2SMike Smith.Op Ar drive
40b6a7bef2SMike Smith.Nm mlxcontrol
41b6a7bef2SMike Smithrescan
42b6a7bef2SMike Smith.Ar controller
43b6a7bef2SMike Smith.Op Ar controller ...
44b6a7bef2SMike Smith.Nm mlxcontrol
45b6a7bef2SMike Smithdetach
46b6a7bef2SMike Smith.Ar drive
47b6a7bef2SMike Smith.Op Ar drive ...
48b6a7bef2SMike Smith.Nm mlxcontrol
49b6a7bef2SMike Smithdetach
50b6a7bef2SMike Smith.Fl a
51b6a7bef2SMike Smith.Nm mlxcontrol
52b6a7bef2SMike Smithcheck
53b6a7bef2SMike Smith.Ar drive
54b6a7bef2SMike Smith.Nm mlxcontrol
55b6a7bef2SMike Smithconfig
56b6a7bef2SMike Smith.Ar controller
57b6a7bef2SMike Smith.Nm mlxcontrol
58b6a7bef2SMike Smithhelp
59b6a7bef2SMike Smith.Ar command
60b6a7bef2SMike Smith.Sh DESCRIPTION
61b6a7bef2SMike SmithThe
62b6a7bef2SMike Smith.Nm
63ddf48d5fSSheldon Hearnutility provides status monitoring and management functions
64ddf48d5fSSheldon Hearnfor devices attached
65b6a7bef2SMike Smithto the
66b6a7bef2SMike Smith.Xr mlx 4
67b6a7bef2SMike Smithdriver.
68b6a7bef2SMike Smith.Pp
69ddf48d5fSSheldon HearnController names are of the form "mlxN"
70ddf48d5fSSheldon Hearnwhere N is the unit number of the controller.
71ddf48d5fSSheldon HearnDrive names are of the form "mlxdN"
72ddf48d5fSSheldon Hearnwhere N is the unit number of the drive.
73ddf48d5fSSheldon HearnDo not specify the path to a device node.
74b6a7bef2SMike Smith.Pp
751cfb436aSBill Swingle.Bl -tag -width rebuild
76b6a7bef2SMike Smith.It status
77ddf48d5fSSheldon HearnPrint the status of controllers and system drives.
78ddf48d5fSSheldon HearnIf one or more drives are specified,
79ddf48d5fSSheldon Hearnonly print information about these drives,
80ddf48d5fSSheldon Hearnotherwise print information
81ddf48d5fSSheldon Hearnabout all controllers and drives in the system.
82ddf48d5fSSheldon HearnWith the
83b6a7bef2SMike Smith.Fl v
84b6a7bef2SMike Smithflag, display much more verbose information.
85b6a7bef2SMike SmithWith the
86b6a7bef2SMike Smith.Fl q
87ddf48d5fSSheldon Hearnflag, do not print any output.
88ddf48d5fSSheldon HearnThis command returns
89ddf48d5fSSheldon Hearn0 if all drives tested are online,
90ddf48d5fSSheldon Hearn1 if one or more drives are critical and
91ddf48d5fSSheldon Hearn2 if one or more are offline.
92b6a7bef2SMike Smith.It rescan
93ddf48d5fSSheldon HearnRescan one or more controllers for non-attached system drives
94ddf48d5fSSheldon Hearn(eg. drives that have been
95ddf48d5fSSheldon Hearndetached or created subsequent to driver initialisation).
96ddf48d5fSSheldon HearnIf the
97b6a7bef2SMike Smith.Fl a
98b6a7bef2SMike Smithflag is supplied, rescan all controllers in the system.
99b6a7bef2SMike Smith.It detach
100ddf48d5fSSheldon HearnDetach one or more system drives.
101ddf48d5fSSheldon HearnDrives must be unmounted
102ddf48d5fSSheldon Hearnand not opened by any other utility for this command to succeed.
103ddf48d5fSSheldon HearnIf the
104b6a7bef2SMike Smith.Fl a
105b6a7bef2SMike Smithflag is supplied, detach all system drives from the nominated controller.
106b6a7bef2SMike Smith.It check
107ddf48d5fSSheldon HearnInitiate a consistency check and repair pass on a redundant system drive
108ddf48d5fSSheldon Hearn(eg. RAID1 or RAID5).
109ddf48d5fSSheldon HearnThe controller will scan the system drive and repair any inconsistencies.
110ddf48d5fSSheldon HearnThis command returns immediately;
111ddf48d5fSSheldon Hearnuse the
112b6a7bef2SMike Smith.Ar status
113b6a7bef2SMike Smithcommand to monitor the progress of the check.
1141cfb436aSBill Swingle.It rebuild
1151cfb436aSBill SwingleRequires two arguments,
1161cfb436aSBill Swingle.Ar controller
1171cfb436aSBill Swingleand
1181cfb436aSBill Swingle.Ar physdrive
1191cfb436aSBill Swingleas specified in the
1201cfb436aSBill Swingleoutput of the
1211cfb436aSBill Swingle.Ar status
1224ffc1d3dSSheldon Hearncommand.
1234ffc1d3dSSheldon HearnAll system drives using space on the physical drive
1241cfb436aSBill Swingle.Ar physdrive
1251cfb436aSBill Swingleare rebuilt, reconstructing all data on the drive.
1264ffc1d3dSSheldon HearnNote that each controller can only perform one rebuild at a time.
1274ffc1d3dSSheldon HearnThis command returns immediately; use the
1281cfb436aSBill Swingle.Ar status
1291cfb436aSBill Swinglecommand to monitor the progress of the rebuild.
130b6a7bef2SMike Smith.It config
131ddf48d5fSSheldon HearnPrint the current configuration from the nominated controller.
132ddf48d5fSSheldon HearnThis command will be updated
133ddf48d5fSSheldon Hearnto allow addition/deletion of system drives from a configuration
134ddf48d5fSSheldon Hearnin a future release.
135b6a7bef2SMike Smith.It help
136b6a7bef2SMike SmithPrint usage information for
137b6a7bef2SMike Smith.Ar command .
1381cfb436aSBill Swingle.El
139b6a7bef2SMike Smith.Sh BUGS
140b6a7bef2SMike SmithThe
141b6a7bef2SMike Smith.Ar config
142b6a7bef2SMike Smithcommand does not yet support modifying system drive configuration.
143b6a7bef2SMike Smith.Pp
144b6a7bef2SMike SmithError log extraction is not yet supported.
145b6a7bef2SMike Smith.Sh AUTHORS
146b6a7bef2SMike SmithThe mlxcontrol utility was written by
147b6a7bef2SMike Smith.An Michael Smith
148b6a7bef2SMike Smith.Aq msmith@FreeBSD.org .
149