home | help
GRAID(8)		     System Manager's Manual			GRAID(8)

NAME
     graid -- control utility for software RAID devices

SYNOPSIS
     graid label [-f] [-S size] [-s strip] format label level prov ...
     graid add [-f] [-S size] [-s strip] name label level
     graid delete [-f] name [label | num]
     graid insert name prov ...
     graid remove name prov ...
     graid fail name prov ...
     graid stop [-fv] name ...
     graid list
     graid status
     graid load
     graid unload

DESCRIPTION
     The graid utility is used to manage software RAID configurations, supported
     by  the  GEOM RAID class.	GEOM RAID class uses on-disk metadata to provide
     access to software-RAID volumes defined by different RAID BIOSes.	 Depend-
     ing  on  RAID BIOS type and it's metadata format, different subsets of con-
     figurations and features are supported.  To allow booting from RAID volume,
     the metadata format should match the RAID BIOS type and  its  capabilities.
     To  guarantee that these match, it is recommended to create volumes via the
     RAID BIOS interface, while experienced users are free to do it  using  this
     utility.

     The first argument to graid indicates an action to be performed:

     label    Create an array with single volume.  The format argument specifies
	      the  on-disk  metadata  format to use for this array, such as "In-
	      tel".  The label argument specifies the label of the created  vol-
	      ume.   The  level argument specifies the RAID level of the created
	      volume, such as: "RAID0", "RAID1", etc.  The subsequent list  enu-
	      merates  providers  to  use as array components.	The special name
	      "NONE" can be used to reserve space for absent disks.   The  order
	      of  components  can be important, depending on specific RAID level
	      and metadata format.

	      Additional options include:

	      -f	Enforce specified configuration creation if it is  offi-
			cially unsupported, but technically can be created.

	      -S size	Use  size  bytes  on  each  component  for  this volume.
			Should be used if several volumes per array are planned,
			or if smaller components going	to  be	inserted  later.
			Defaults to size of the smallest component.

	      -s strip	Specifies strip size in bytes.	Defaults to 131072.

     add      Create another volume on the existing array.  The name argument is
	      the  name  of  the existing array, reported by label command.  The
	      rest of arguments are the same as for the label command.

     delete   Delete volume(s) from the existing array.  When the last volume is
	      deleted, the array is also deleted and its metadata  erased.   The
	      name  argument  is  the name of existing array.  Optional label or
	      num arguments allow specifying volume for deletion.

	      Additional options include:

	      -f  Delete volume(s) even if it is still open.

     insert   Insert specified provider(s) into specified array instead  of  the
	      first  missing  or failed components.  If there are no such compo-
	      nents, mark disk(s) as spare.

     remove   Remove the specified provider(s)	from  the  specified  array  and
	      erase  metadata.	 If  there  are spare disks present, the removed
	      disk(s) will be replaced by spares.

     fail     Mark the given disks(s) as failed, removing from active use unless
	      absolutely necessary due to exhausted redundancy.   If  there  are
	      spare  disks present - failed disk(s) will be replaced with one of
	      them.

     stop     Stop the given array.  The metadata will not be erased.

	      Additional options include:

	      -f  Stop the given array even if some of its volumes are opened.

     list     See geom(8).

     status   See geom(8).

     load     See geom(8).

     unload   See geom(8).

     Additional options include:

     -v  Be more verbose.

SUPPORTED METADATA FORMATS
     The GEOM RAID class follows a modular design, allowing  different	metadata
     formats  to  be  used.   Support is currently implemented for the following
     formats:

     Intel  The format used by Intel RAID BIOS.  Supports up to two volumes  per
	    array.   Supports configurations: RAID0 (2+ disks), RAID1 (2 disks),
	    RAID5 (3+ disks), RAID10 (4 disks).  Configurations not supported by
	    Intel RAID BIOS, but enforceable on your own risk: RAID1 (3+ disks),
	    RAID1E (3+ disks), RAID10 (6+ disks).

     JMicron
	    The format used by JMicron RAID BIOS.  Supports one volume	per  ar-
	    ray.   Supports  configurations:  RAID0 (2+ disks), RAID1 (2 disks),
	    RAID10 (4 disks), CONCAT (2+ disks).  Configurations  not  supported
	    by	JMicron  RAID  BIOS, but enforceable on your own risk: RAID1 (3+
	    disks), RAID1E (3+ disks), RAID10 (6+ disks), RAID5 (3+ disks).

     NVIDIA
	    The format used by NVIDIA MediaShield RAID BIOS.  Supports one  vol-
	    ume  per array.  Supports configurations: RAID0 (2+ disks), RAID1 (2
	    disks), RAID5 (3+ disks), RAID10 (4+ disks), SINGLE (1 disk), CONCAT
	    (2+ disks).  Configurations not supported by NVIDIA MediaShield RAID
	    BIOS, but enforceable on your own risk: RAID1 (3+ disks).

     Promise
	    The format used by Promise	and  AMD/ATI  RAID  BIOSes  and  FreeBSD
	    ataraid(4)	driver.  Supports multiple volumes per array.  Each disk
	    can be split to be used by up to two  arbitrary  volumes.	Supports
	    configurations: RAID0 (2+ disks), RAID1 (2 disks), RAID5 (3+ disks),
	    RAID10  (4	disks),  SINGLE (1 disk), CONCAT (2+ disks).  Configura-
	    tions not supported by RAID BIOSes,  but  enforceable  on  your  own
	    risk: RAID1 (3+ disks), RAID10 (6+ disks).

     SiI    The  format used by SiliconImage RAID BIOS.  Supports one volume per
	    array.  Supports configurations: RAID0 (2+ disks), RAID1 (2  disks),
	    RAID5  (3+	disks),  RAID10  (4  disks), SINGLE (1 disk), CONCAT (2+
	    disks).  Configurations not supported by SiliconImage RAID BIOS, but
	    enforceable on your own risk: RAID1 (3+ disks), RAID10 (6+ disks).

SUPPORTED RAID LEVELS
     The GEOM RAID class follows a modular design, allowing different RAID  lev-
     els  to be used.  Support for the following RAID levels is currently imple-
     mented: RAID0, RAID1, RAID1E, RAID10, SINGLE, CONCAT.

RAID LEVEL MIGRATION
     The GEOM RAID class has no support for RAID  level  migration,  allowed  by
     some  metadata  formats.	If  you  started migration using BIOS or in some
     other way, make sure to complete it there.  Do not run GEOM RAID  class  on
     migrating volumes under pain of possible data corruption!

2TiB BARRIERS
     Promise metadata format does not support disks above 2TiB.  NVIDIA metadata
     format does not support volumes above 2TiB.

EXIT STATUS
     Exit status is 0 on success, and non-zero if the command fails.

SEE ALSO
     geom(4), geom(8), vinum(8)

HISTORY
     The graid utility appeared in FreeBSD 9.0.

AUTHORS
     Alexander Motin <mav@FreeBSD.org>
     M. Warner Losh <imp@FreeBSD.org>

FreeBSD 8.3			October 26, 2011			GRAID(8)

home | help