xref: /freebsd/usr.sbin/mlxcontrol/mlxcontrol.8 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.Dd April 10, 2000
25b6a7bef2SMike Smith.Dt MLXCONTROL 8
26b6a7bef2SMike Smith.Os
27b6a7bef2SMike Smith.Sh NAME
28b6a7bef2SMike Smith.Nm mlxcontrol
29b6a7bef2SMike Smith.Nd Mylex DAC-family RAID management utility
30b6a7bef2SMike Smith.Sh SYNOPSIS
31e97407b4SRuslan Ermilov.Nm
32b6a7bef2SMike Smith.Aq command
33b6a7bef2SMike Smith.Op args
34e97407b4SRuslan Ermilov.Nm
35b6a7bef2SMike Smithstatus
36b6a7bef2SMike Smith.Op Fl qv
37b6a7bef2SMike Smith.Op Ar drive
38e97407b4SRuslan Ermilov.Nm
39b6a7bef2SMike Smithrescan
40b6a7bef2SMike Smith.Ar controller
41b6a7bef2SMike Smith.Op Ar controller ...
42e97407b4SRuslan Ermilov.Nm
43b6a7bef2SMike Smithdetach
44b6a7bef2SMike Smith.Ar drive
45b6a7bef2SMike Smith.Op Ar drive ...
46e97407b4SRuslan Ermilov.Nm
47b6a7bef2SMike Smithdetach
48b6a7bef2SMike Smith.Fl a
49e97407b4SRuslan Ermilov.Nm
50b6a7bef2SMike Smithcheck
51b6a7bef2SMike Smith.Ar drive
52e97407b4SRuslan Ermilov.Nm
53b6a7bef2SMike Smithconfig
54b6a7bef2SMike Smith.Ar controller
55e97407b4SRuslan Ermilov.Nm
56b6a7bef2SMike Smithhelp
57b6a7bef2SMike Smith.Ar command
58b6a7bef2SMike Smith.Sh DESCRIPTION
59b6a7bef2SMike SmithThe
60b6a7bef2SMike Smith.Nm
61ddf48d5fSSheldon Hearnutility provides status monitoring and management functions
62ddf48d5fSSheldon Hearnfor devices attached
63b6a7bef2SMike Smithto the
64b6a7bef2SMike Smith.Xr mlx 4
65b6a7bef2SMike Smithdriver.
66b6a7bef2SMike Smith.Pp
67ddf48d5fSSheldon HearnController names are of the form "mlxN"
68ddf48d5fSSheldon Hearnwhere N is the unit number of the controller.
69ddf48d5fSSheldon HearnDrive names are of the form "mlxdN"
70ddf48d5fSSheldon Hearnwhere N is the unit number of the drive.
71ddf48d5fSSheldon HearnDo not specify the path to a device node.
721cfb436aSBill Swingle.Bl -tag -width rebuild
73b6a7bef2SMike Smith.It status
74ddf48d5fSSheldon HearnPrint the status of controllers and system drives.
75ddf48d5fSSheldon HearnIf one or more drives are specified,
76ddf48d5fSSheldon Hearnonly print information about these drives,
77ddf48d5fSSheldon Hearnotherwise print information
78ddf48d5fSSheldon Hearnabout all controllers and drives in the system.
79ddf48d5fSSheldon HearnWith the
80b6a7bef2SMike Smith.Fl v
81b6a7bef2SMike Smithflag, display much more verbose information.
82b6a7bef2SMike SmithWith the
83b6a7bef2SMike Smith.Fl q
84ddf48d5fSSheldon Hearnflag, do not print any output.
85ddf48d5fSSheldon HearnThis command returns
86ddf48d5fSSheldon Hearn0 if all drives tested are online,
87ddf48d5fSSheldon Hearn1 if one or more drives are critical and
88ddf48d5fSSheldon Hearn2 if one or more are offline.
89b6a7bef2SMike Smith.It rescan
90ddf48d5fSSheldon HearnRescan one or more controllers for non-attached system drives
9107bfccd7SRuslan Ermilov(e.g.\& drives that have been
92ddf48d5fSSheldon Hearndetached or created subsequent to driver initialisation).
93ddf48d5fSSheldon HearnIf the
94b6a7bef2SMike Smith.Fl a
95b6a7bef2SMike Smithflag is supplied, rescan all controllers in the system.
96b6a7bef2SMike Smith.It detach
97ddf48d5fSSheldon HearnDetach one or more system drives.
98ddf48d5fSSheldon HearnDrives must be unmounted
99ddf48d5fSSheldon Hearnand not opened by any other utility for this command to succeed.
100ddf48d5fSSheldon HearnIf the
101b6a7bef2SMike Smith.Fl a
102b6a7bef2SMike Smithflag is supplied, detach all system drives from the nominated controller.
103b6a7bef2SMike Smith.It check
104ddf48d5fSSheldon HearnInitiate a consistency check and repair pass on a redundant system drive
10507bfccd7SRuslan Ermilov(e.g.\& RAID1 or RAID5).
106ddf48d5fSSheldon HearnThe controller will scan the system drive and repair any inconsistencies.
107ddf48d5fSSheldon HearnThis command returns immediately;
108ddf48d5fSSheldon Hearnuse the
109b6a7bef2SMike Smith.Ar status
110b6a7bef2SMike Smithcommand to monitor the progress of the check.
1111cfb436aSBill Swingle.It rebuild
1121cfb436aSBill SwingleRequires two arguments,
1131cfb436aSBill Swingle.Ar controller
1141cfb436aSBill Swingleand
1151cfb436aSBill Swingle.Ar physdrive
1161cfb436aSBill Swingleas specified in the
1171cfb436aSBill Swingleoutput of the
1181cfb436aSBill Swingle.Ar status
1194ffc1d3dSSheldon Hearncommand.
1204ffc1d3dSSheldon HearnAll system drives using space on the physical drive
1211cfb436aSBill Swingle.Ar physdrive
1221cfb436aSBill Swingleare rebuilt, reconstructing all data on the drive.
1234ffc1d3dSSheldon HearnNote that each controller can only perform one rebuild at a time.
1244ffc1d3dSSheldon HearnThis command returns immediately; use the
1251cfb436aSBill Swingle.Ar status
1261cfb436aSBill Swinglecommand to monitor the progress of the rebuild.
127b6a7bef2SMike Smith.It config
128ddf48d5fSSheldon HearnPrint the current configuration from the nominated controller.
129ddf48d5fSSheldon HearnThis command will be updated
130ddf48d5fSSheldon Hearnto allow addition/deletion of system drives from a configuration
131ddf48d5fSSheldon Hearnin a future release.
132b6a7bef2SMike Smith.It help
133b6a7bef2SMike SmithPrint usage information for
134b6a7bef2SMike Smith.Ar command .
1351cfb436aSBill Swingle.El
13659a3c79dSRuslan Ermilov.Sh AUTHORS
137*01c2b8acSBaptiste DaroussinThe
138*01c2b8acSBaptiste Daroussin.Nm
139*01c2b8acSBaptiste Daroussinutility was written by
140*01c2b8acSBaptiste Daroussin.An Michael Smith Aq Mt msmith@FreeBSD.org .
141b6a7bef2SMike Smith.Sh BUGS
142b6a7bef2SMike SmithThe
143b6a7bef2SMike Smith.Ar config
144b6a7bef2SMike Smithcommand does not yet support modifying system drive configuration.
145b6a7bef2SMike Smith.Pp
146b6a7bef2SMike SmithError log extraction is not yet supported.
147