gstripe.8 revision 133205
Copyright (c) 2004 Pawel Jakub Dawidek <pjd@FreeBSD.org>
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. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``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 AUTHORS OR CONTRIBUTORS 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: head/sbin/geom/class/stripe/gstripe.8 133205 2004-08-06 10:19:34Z pjd $

.Dd May 21, 2004 .Dt GSTRIPE 8 .Os .Sh NAME .Nm gstripe .Nd "control utility for striped devices" .Sh SYNOPSIS .Nm .Cm create .Op Fl v .Op Fl s Ar stripesize .Ar name .Ar dev1 .Ar dev2 .Op Ar dev3 Op Ar ... .Nm .Cm destroy .Op Fl fv .Ar name .Op Ar name2 Op Ar ... .Nm .Cm label .Op Fl v .Op Fl s Ar stripesize .Ar name .Ar dev1 .Ar dev2 .Op Ar dev3 Op Ar ... .Nm .Cm stop .Op Fl fv .Ar name .Op Ar name2 Op Ar ... .Nm .Cm clear .Op Fl v .Ar dev1 .Op Ar dev2 Op Ar ... .Nm .Cm dump .Ar dev1 .Op Ar dev2 Op Ar ... .Nm .Cm list .Op Ar name Op Ar ... .Nm .Cm load .Op Fl v .Nm .Cm unload .Op Fl v .Sh DESCRIPTION The .Nm utility is used for setting up stripe on two or more disks. The striped device can be configured using two different methods: .Dq manual or .Dq automatic . When using the .Dq manual method, no metadata are stored on the devices, so the striped device has to be configured by hand every time it is needed. The .Dq automatic method uses on-disk metadata to detect devices. Once devices are labeled, they will be automatically detected and configured.

p The first argument to .Nm indicates an action to be performed: l -tag -width ".Cm destroy" t Cm create Set up a striped device from the given devices with specified .Ar name . This is the .Dq manual method. The kernel module

a geom_stripe.ko will be loaded if it is not loaded already. t Cm label Set up a striped device from the given devices with the specified .Ar name . This is the .Dq automatic method, where metadata are stored in every device's last sector. The kernel module

a geom_stripe.ko will be loaded if it is not loaded already. t Cm stop Turn off existing striped device by its .Ar name . This command does not touch on-disk metadata! t Cm destroy Same as .Cm stop . t Cm clear Clear metadata on the given devices. t Cm dump Dump metadata stored on the given devices. t Cm list List all or the given currently configured devices. t Cm load Load

a geom_stripe.ko kernel module. t Cm unload Unload

a geom_stripe.ko kernel module. .El

p Additional options: l -tag -width ".Fl s Ar stripesize" t Fl f Force the removal of the specified striped device. t Fl s Ar stripesize Specifies size of stripe block. t Fl v Be more verbose. .El .Sh SYSCTL VARIABLES The following .Xr sysctl 8 variables can be used to control the behavior of the .Nm STRIPE GEOM class. The default value is shown next to each variable. l -tag -width indent t Va kern.geom.stripe.debug : No 0 Debug level of the .Nm STRIPE GEOM class. This can be set to a number between 0 and 3, both included. If set to 0 minimal debug information is printed, and if set to 3 the maximum amount of debug information in printed. t Va kern.geom.stripe.fast : No 1 If set to a non-zero value enable .Dq "fast mode" instead of the normal .Dq "economic mode" . Compared to .Dq "economic mode" .Dq "fast mode" uses more memory, but it is much faster for smaller stripe sizes. If enough memory cannot be allocated .Nm STRIPE will fall back to .Dq "economic mode" . t Va kern.geom.stripe.maxmem : No 1310720 Maximum amount of memory that can be consumed by .Dq "fast mode" (in bytes). This .Xr sysctl 8 variable is read-only and can only be set as a tunable in .Xr loader.conf 5 . t Va kern.geom.stripe.fast_failed How many times .Dq "fast mode" failed because of insufficient amount of memory. If this value is big, you should considern increasing .Va kern.geom.stripe.maxmem value. .El .Sh EXAMPLES The following example shows how to set up striped device from four disks for automatic configuration, create a file system on it, and mount it: d -literal -offset indent gstripe label -v -s 4096 data /dev/da0 /dev/da1 /dev/da2 /dev/da3 newfs /dev/stripe/data mount /dev/stripe/data /mnt [...] umount /mnt gstripe stop data gstripe unload .Ed .Sh DIAGNOSTICS Exit status is 0 on success, and 1 if the command fails. .Sh SEE ALSO .Xr geom 4 , .Xr loader.conf 5 , .Xr geom 8 , .Xr mount 8 , .Xr newfs 8 , .Xr sysctl 8 , .Xr umount 8 , .Xr vinum 8 .Sh HISTORY The .Nm utility appeared in .Fx 5.3 . .Sh AUTHORS .An Pawel Jakub Dawidek Aq pjd@FreeBSD.org