[dragonfly.git] / usr.sbin / mlxcontrol / mlxcontrol.8

.\"
.\" Copyright (c) 2000 Michael Smith
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD: src/usr.sbin/mlxcontrol/mlxcontrol.8,v 1.10 2010/10/08 12:40:16 uqs Exp $
.\"
.Dd November 20, 2010
.Dt MLXCONTROL 8
.Os
.Sh NAME
.Nm mlxcontrol
.Nd Mylex DAC-family RAID management utility
.Sh SYNOPSIS
.Nm
.Aq command
.Op args
.Nm
status
.Op Fl qv
.Op Ar drive
.Nm
rescan
.Ar controller
.Op Ar controller ...
.Nm
detach
.Ar drive
.Op Ar drive ...
.Nm
detach
.Fl a
.Nm
check
.Ar drive
.Nm
config
.Ar controller
.Nm
help
.Ar command
.Sh DESCRIPTION
The
.Nm
utility provides status monitoring and management functions
for devices attached
to the
.Xr mlx 4
driver.
.Pp
Controller names are of the form "mlxN"
where N is the unit number of the controller.
Drive names are of the form "mlxdN"
where N is the unit number of the drive.
Do not specify the path to a device node.
.Bl -tag -width rebuild
.It status
Print the status of controllers and system drives.
If one or more drives are specified,
only print information about these drives,
otherwise print information
about all controllers and drives in the system.
With the
.Fl v
flag, display much more verbose information.
With the
.Fl q
flag, do not print any output.
This command returns
0 if all drives tested are online,
1 if one or more drives are critical and
2 if one or more are offline.
.It rescan
Rescan one or more controllers for non-attached system drives
(e.g.\& drives that have been
detached or created subsequent to driver initialisation).
If the
.Fl a
flag is supplied, rescan all controllers in the system.
.It detach
Detach one or more system drives.
Drives must be unmounted
and not opened by any other utility for this command to succeed.
If the
.Fl a
flag is supplied, detach all system drives from the nominated controller.
.It check
Initiate a consistency check and repair pass on a redundant system drive
(e.g.\& RAID1 or RAID5).
The controller will scan the system drive and repair any inconsistencies.
This command returns immediately;
use the
.Ar status
command to monitor the progress of the check.
.It rebuild
Requires two arguments,
.Ar controller
and
.Ar physdrive
as specified in the
output of the
.Ar status
command.
All system drives using space on the physical drive
.Ar physdrive
are rebuilt, reconstructing all data on the drive.
Note that each controller can only perform one rebuild at a time.
This command returns immediately; use the
.Ar status
command to monitor the progress of the rebuild.
.It config
Print the current configuration from the nominated controller.
This command will be updated
to allow addition/deletion of system drives from a configuration
in a future release.
.It help
Print usage information for
.Ar command .
.El
.Sh AUTHORS
The
.Nm
utility was written by
.An Michael Smith
.Aq msmith@FreeBSD.org .
.Sh BUGS
The
.Ar config
command does not yet support modifying system drive configuration.
.Pp
Error log extraction is not yet supported.
Commit	Line	Data
984263bc MD	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	.\"
c6aff4f7	24	.\" $FreeBSD: src/usr.sbin/mlxcontrol/mlxcontrol.8,v 1.10 2010/10/08 12:40:16 uqs Exp $
984263bc	25	.\"
c6aff4f7	26	.Dd November 20, 2010
984263bc MD	27	.Dt MLXCONTROL 8
	28	.Os
	29	.Sh NAME
	30	.Nm mlxcontrol
	31	.Nd Mylex DAC-family RAID management utility
	32	.Sh SYNOPSIS
	33	.Nm
	34	.Aq command
	35	.Op args
	36	.Nm
	37	status
	38	.Op Fl qv
	39	.Op Ar drive
	40	.Nm
	41	rescan
	42	.Ar controller
	43	.Op Ar controller ...
	44	.Nm
	45	detach
	46	.Ar drive
	47	.Op Ar drive ...
	48	.Nm
	49	detach
	50	.Fl a
	51	.Nm
	52	check
	53	.Ar drive
	54	.Nm
	55	config
	56	.Ar controller
	57	.Nm
	58	help
	59	.Ar command
	60	.Sh DESCRIPTION
	61	The
	62	.Nm
	63	utility provides status monitoring and management functions
	64	for devices attached
	65	to the
	66	.Xr mlx 4
	67	driver.
	68	.Pp
	69	Controller names are of the form "mlxN"
	70	where N is the unit number of the controller.
	71	Drive names are of the form "mlxdN"
	72	where N is the unit number of the drive.
	73	Do not specify the path to a device node.
c6aff4f7	74	.Bl -tag -width rebuild
984263bc MD	75	.It status
	76	Print the status of controllers and system drives.
	77	If one or more drives are specified,
	78	only print information about these drives,
	79	otherwise print information
	80	about all controllers and drives in the system.
	81	With the
	82	.Fl v
	83	flag, display much more verbose information.
	84	With the
	85	.Fl q
	86	flag, do not print any output.
	87	This command returns
	88	0 if all drives tested are online,
	89	1 if one or more drives are critical and
	90	2 if one or more are offline.
	91	.It rescan
	92	Rescan one or more controllers for non-attached system drives
c6aff4f7	93	(e.g.\& drives that have been
984263bc MD	94	detached or created subsequent to driver initialisation).
	95	If the
	96	.Fl a
	97	flag is supplied, rescan all controllers in the system.
	98	.It detach
	99	Detach one or more system drives.
	100	Drives must be unmounted
	101	and not opened by any other utility for this command to succeed.
	102	If the
	103	.Fl a
	104	flag is supplied, detach all system drives from the nominated controller.
	105	.It check
	106	Initiate a consistency check and repair pass on a redundant system drive
c6aff4f7	107	(e.g.\& RAID1 or RAID5).
984263bc MD	108	The controller will scan the system drive and repair any inconsistencies.
	109	This command returns immediately;
	110	use the
	111	.Ar status
	112	command to monitor the progress of the check.
c6aff4f7 SW	113	.It rebuild
	114	Requires two arguments,
	115	.Ar controller
	116	and
	117	.Ar physdrive
	118	as specified in the
	119	output of the
	120	.Ar status
	121	command.
	122	All system drives using space on the physical drive
	123	.Ar physdrive
	124	are rebuilt, reconstructing all data on the drive.
	125	Note that each controller can only perform one rebuild at a time.
	126	This command returns immediately; use the
	127	.Ar status
	128	command to monitor the progress of the rebuild.
984263bc MD	129	.It config
	130	Print the current configuration from the nominated controller.
	131	This command will be updated
	132	to allow addition/deletion of system drives from a configuration
	133	in a future release.
	134	.It help
	135	Print usage information for
	136	.Ar command .
	137	.El
49781055	138	.Sh AUTHORS
28feafc7 SW	139	The
	140	.Nm
	141	utility was written by
49781055 SW	142	.An Michael Smith
49781055 SW	143	.Aq msmith@FreeBSD.org .
984263bc MD	144	.Sh BUGS
	145	The
	146	.Ar config
	147	command does not yet support modifying system drive configuration.
	148	.Pp
	149	Error log extraction is not yet supported.