1 .\" Copyright (c) 2010 Alexander Motin <mav@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd "control utility for software RAID devices"
83 utility is used to manage software RAID configurations, supported by the
85 GEOM RAID class uses on-disk metadata to provide access to software-RAID
86 volumes defined by different RAID BIOSes.
87 Depending on RAID BIOS type and it's metadata format, different subsets of
88 configurations and features are supported.
89 To allow booting from RAID volume, the metadata format should match the
90 RAID BIOS type and its capabilities.
91 To guarantee that these match, it is recommended to create volumes via the
92 RAID BIOS interface, while experienced users are free to do it using this
97 indicates an action to be performed:
98 .Bl -tag -width ".Cm destroy"
100 Create an array with single volume.
103 argument specifies the on-disk metadata format to use for this array,
107 argument specifies the label of the created volume.
110 argument specifies the RAID level of the created volume, such as:
111 "RAID0", "RAID1", etc.
112 The subsequent list enumerates providers to use as array components.
113 The special name "NONE" can be used to reserve space for absent disks.
114 The order of components can be important, depending on specific RAID level
117 Additional options include:
118 .Bl -tag -width ".Fl s Ar strip"
120 Enforce specified configuration creation if it is officially unsupported,
121 but technically can be created.
125 bytes on each component for this volume.
126 Should be used if several volumes per array are planned, or if smaller
127 components going to be inserted later.
128 Defaults to size of the smallest component.
130 Specifies strip size in bytes.
134 Create another volume on the existing array.
137 argument is the name of the existing array, reported by label command.
138 The rest of arguments are the same as for the label command.
140 Delete volume(s) from the existing array.
141 When the last volume is deleted, the array is also deleted and its metadata
145 argument is the name of existing array.
150 arguments allow specifying volume for deletion.
152 Additional options include:
153 .Bl -tag -width ".Fl f"
155 Delete volume(s) even if it is still open.
158 Insert specified provider(s) into specified array instead of the first missing
159 or failed components.
160 If there are no such components, mark disk(s) as spare.
162 Remove the specified provider(s) from the specified array and erase metadata.
163 If there are spare disks present, the removed disk(s) will be replaced by
166 Mark the given disks(s) as failed, removing from active use unless absolutely
167 necessary due to exhausted redundancy.
168 If there are spare disks present - failed disk(s) will be replaced with one
171 Stop the given array.
172 The metadata will not be erased.
174 Additional options include:
175 .Bl -tag -width ".Fl f"
177 Stop the given array even if some of its volumes are opened.
193 Additional options include:
194 .Bl -tag -width ".Fl v"
198 .Sh SUPPORTED METADATA FORMATS
199 The GEOM RAID class follows a modular design, allowing different metadata
201 Support is currently implemented for the following formats:
202 .Bl -tag -width "Intel"
204 The format used by Intel RAID BIOS.
205 Supports up to two volumes per array.
206 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
207 RAID5 (3+ disks), RAID10 (4 disks).
208 Configurations not supported by Intel RAID BIOS, but enforceable on your own
209 risk: RAID1 (3+ disks), RAID1E (3+ disks), RAID10 (6+ disks).
211 The format used by JMicron RAID BIOS.
212 Supports one volume per array.
213 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
214 RAID10 (4 disks), CONCAT (2+ disks).
215 Configurations not supported by JMicron RAID BIOS, but enforceable on your own
216 risk: RAID1 (3+ disks), RAID1E (3+ disks), RAID10 (6+ disks), RAID5 (3+ disks).
218 The format used by NVIDIA MediaShield RAID BIOS.
219 Supports one volume per array.
220 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
221 RAID5 (3+ disks), RAID10 (4+ disks), SINGLE (1 disk), CONCAT (2+ disks).
222 Configurations not supported by NVIDIA MediaShield RAID BIOS, but enforceable
223 on your own risk: RAID1 (3+ disks).
225 The format used by Promise and AMD/ATI RAID BIOSes and FreeBSD ataraid(4)
227 Supports multiple volumes per array.
228 Each disk can be split to be used by up to two arbitrary volumes.
229 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
230 RAID5 (3+ disks), RAID10 (4 disks), SINGLE (1 disk), CONCAT (2+ disks).
231 Configurations not supported by RAID BIOSes, but enforceable on your
232 own risk: RAID1 (3+ disks), RAID10 (6+ disks).
234 The format used by SiliconImage RAID BIOS.
235 Supports one volume per array.
236 Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
237 RAID5 (3+ disks), RAID10 (4 disks), SINGLE (1 disk), CONCAT (2+ disks).
238 Configurations not supported by SiliconImage RAID BIOS, but enforceable on your
239 own risk: RAID1 (3+ disks), RAID10 (6+ disks).
241 .Sh SUPPORTED RAID LEVELS
242 The GEOM RAID class follows a modular design, allowing different RAID levels
244 Support for the following RAID levels is currently implemented: RAID0, RAID1,
245 RAID1E, RAID10, SINGLE, CONCAT.
246 .Sh RAID LEVEL MIGRATION
247 The GEOM RAID class has no support for RAID level migration, allowed by some
249 If you started migration using BIOS or in some other way, make sure to
251 Do not run GEOM RAID class on migrating volumes under pain of possible data
254 Exit status is 0 on success, and non-zero if the command fails.
265 .An Alexander Motin Aq mav@FreeBSD.org
266 .An M. Warner Losh Aq imp@FreeBSD.org