Seth Woolley's Man Viewer

Manual for mdadm - man mdadm

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

MDADM(8)                                                              MDADM(8)



NAME
       mdadm(5,8) - manage MD devices aka Linux Software Raid.


SYNOPSIS
       mdadm(5,8) [mode] <raiddevice> [options] <component-devices>


DESCRIPTION
       RAID  devices  are  virtual(5,8) devices created from two or more real block
       devices. This allows multiple devices (typically disk drives or  parti-
       tions  there-of) to be combined into a single device to hold (for exam-
       ple) a single filesystem.  Some RAID levels include redundancy  and  so
       can survive some degree of device failure.

       Linux  Software  RAID  devices are implemented through the md (Multiple
       Devices) device driver.

       Currently, Linux supports LINEAR md devices,  RAID0  (striping),  RAID1
       (mirroring), RAID4, RAID5, RAID6, MULTIPATH, and FAULTY.

       MULTIPATH  is  not a Software RAID mechanism, but does involve multiple
       devices.  For MULTIPATH each device is a path to  one  common  physical
       storage device.

       FAULTY is also not true RAID, and it only involves one device.  It pro-
       vides a layer over a true device that can be used to inject faults.



MODES
       mdadm(5,8) has 7 major modes of operation:

       Assemble
              Assemble the parts of a previously created array into an  active
              array.  Components  can  be  explicitly given or can be searched
              for.  mdadm(5,8) checks that the  components  do  form  a  bona  fide
              array,  and can, on request, fiddle superblock information so as
              to assemble a faulty array.


       Build  Build an array that doesn't have  per-device  superblocks.   For
              these  sorts  of arrays, mdadm(5,8) cannot differentiate between ini-
              tial creation and subsequent assembly of an array.  It also can-
              not  perform  any  checks  that  appropriate  devices  have been
              requested.  Because of this, the Build mode should only be  used
              together with a complete understanding of what you are doing.


       Create Create a new array with per-device superblocks.


       Manage This is for doing things to specific components of an array such
              as adding new spares and removing faulty devices.


       Misc   This mode allows operations on independent devices such as exam-
              ine  MD superblocks, erasing old superblocks and stopping active
              arrays.


       Follow or Monitor
              Monitor one or more md devices and act  on  any  state  changes.
              This  is  only meaningful for raid1, 4, 5, 6 or multipath arrays
              as only these have interesting state.   raid0  or  linear  never
              have  missing,  spare,  or failed drives, so there is nothing to
              monitor.


       Grow   Grow (or shrink) an array, or otherwise reshape it in(1,8) some  way.
              Currently supported growth options including changing the active
              size of componenet devices in(1,8) RAID level  1/4/5/6  and  changing
              the number of active devices in(1,8) RAID1.


OPTIONS
       Available options are:


       -A, --assemble
              Assemble a pre-existing array.


       -B, --build
              Build a legacy array without superblocks.


       -C, --create
              Create a new array.


       -Q, --query
              Examine  a device to see (1) if(3,n) it is an md device and (2) if(3,n) it
              is a component of an md array.  Information about what  is  dis-
              covered is presented.


       -D, --detail
              Print detail of one or more md devices.


       -E, --examine
              Print content of md superblock on device(s).


       -F, --follow, --monitor
              Select Monitor mode.


       -G, --grow
              Change the size or shape of an active array.


       -h, --help
              Display general help message or, after one of the above options,
              a mode specific help message.


       --help-options
              Display more detailed help about command line parsing  and  some
              commonly used options.


       -V, --version
              Print version(1,3,5) information for mdadm.


       -v, --verbose
              Be more verbose about what is happening.  This can be used twice
              to be extra-verbose.  The extra verbosity currently only affects
              --detail --scan and --examine --scan.


       -b, --brief
              Be  less(1,3)  verbose.   This  is  used with --detail and --examine.
              Using --brief with --verbose gives an intermediate level of ver-
              bosity.


       -f, --force
              Be  more  forceful  about  certain  operations.  See the various
              modes of the exact meaning of this option in(1,8) different contexts.


       -c, --config=
              Specify  the  config(1,5)  file.  Default is /etc/mdadm.conf.  If the
              config(1,5) file(1,n) given is partitions then nothing will be  read(2,n,1 builtins),  but
              mdadm(5,8)  will  act  as  though  the  config(1,5) file(1,n) contained exactly
              DEVICE partitions and will read(2,n,1 builtins) /proc(5,n)/partitions to find a  list
              of  devices  to  scan.  If the word none is given for the config(1,5)
              file(1,n), then mdadm(5,8) will act as though the config(1,5) file(1,n) were  empty.


       -s, --scan
              scan  config(1,5)  file(1,n)  or /proc(5,n)/mdstat for missing information.  In
              general, this option gives mdadm(5,8) permission to get  any  missing
              information,  like component devices, array devices, array iden-
              tities, and  alert  destination  from  the  configuration  file:
              /etc/mdadm.conf.  One exception is MISC mode when using --detail
              or --stop in(1,8) which case --scan says  to  get  a  list  of  array
              devices from /proc(5,n)/mdstat.


For create or build:
       -c, --chunk=
              Specify chunk size of kibibytes.  The default is 64.


       --rounding=
              Specify rounding factor(1,6) for linear array (==chunk size)


       -l, --level=
              Set  raid  level.  When used with --create, options are: linear,
              raid0, 0, stripe, raid1, 1, mirror, raid4, 4, raid5,  5,  raid6,
              6,  multipath,  mp, fautly.  Obviously some of these are synony-
              mous.

              When used with --build, only linear, stripe,  raid0,  0,  raid1,
              multipath, mp, and faulty are valid.


       -p, --parity=
              Set  raid5 parity algorithm. Options are: left-asymmetric, left-
              symmetric, right-asymmetric, right-symmetric, la,  ra,  ls,  rs.
              The default is left-symmetric.

              This  option  is  also  used to set(7,n,1 builtins) the failure mode for faulty.
              The options are: write-transient, wt, read-transient, rt, write-
              presistent,  wp,  read-persistent,  rp, write-all, read-fixable,
              rf, clear(1,3x,3x clrtobot), flush(8,n), none.

              Each mode can be followed by a number which is used as a  period
              between fault generation.  Without a number, the fault is gener-
              ated once on the first relevant request.   With  a  number,  the
              fault  will  be generated after that many request, and will con-
              tinue to be generated every time(1,2,n) the period elapses.

              Multiple failure modes can be current  simultaneously  by  using
              the "--grow" option to set(7,n,1 builtins) subsequent failure modes.

              "clear(1,3x,3x clrtobot)"  or  "none"  will remove any pending or periodic failure
              modes, and "flush(8,n)" will clear(1,3x,3x clrtobot) any persistant faults.

              To set(7,n,1 builtins)  the  parity  with  "--grow",  the  level  of  the  array
              ("faulty") must be specified before the fault mode is specified.


       --layout=
              same as --parity


       -n, --raid-devices=
              Specify the number of active devices in(1,8) the array.   This,  plus
              the number of spare devices (see below) must equal the number of
              component-devices (including "missing" devices) that are  listed
              on the command line for --create.  Setting a value of 1 is prob-
              ably a mistake and so requires that --force be specified  first.
              A  value  of 1 will then be allowed for linear, multipath, raid0
              and raid1.  It is never allowed for raid4 or raid5.
              This number can only be changed using --grow for  RAID1  arrays,
              and only on kernels which provide necessary support.


       -x, --spare-devices=
              Specify  the  number  of  spare  (eXtra)  devices in(1,8) the initial
              array.  Spares can also be added and removed later.  The  number
              of  component  devices listed on the command line must equal the
              number of raid devices plus the number of spare devices.



       -z, --size=
              Amount (in(1,8) Kibibytes)  of  space  to  use  from  each  drive  in(1,8)
              RAID1/4/5/6.   This  must  be  a multiple of the chunk size, and
              must leave about 128Kb of space at the end of the drive for  the
              RAID  superblock.   If  this is not specified (as it normally is
              not) the smallest drive (or partition) sets the size, though  if(3,n)
              there is a variance among the drives of greater than 1%, a warn-
              ing is issued.

              This value can be set(7,n,1 builtins) with --grow for RAID level 1/4/5/6. If the
              array  was created with a size smaller than the currently active
              drives, the extra space can be accessed using --grow.  The  size
              can  be given as max which means to choose the largest size that
              fits on all current drives.


       --assume-clean
              Tell mdadm(5,8) that the array pre-existed and is known to be  clean.
              This  is  only really useful for Building RAID1 array.  Only use
              this if(3,n) you really know what you are doing.  This  is  currently
              only supported for --build.


       -R, --run
              Insist  that mdadm(5,8) run the array, even if(3,n) some of the components
              appear to be active in(1,8) another array  or  filesystem.   Normally
              mdadm(5,8) will ask for confirmation before including such components
              in(1,8) an array.  This option causes that question to be suppressed.


       -f, --force
              Insist that mdadm(5,8) accept(2,8) the geometry and layout specified with-
              out question.  Normally mdadm(5,8) will  not  allow  creation  of  an
              array with only one device, and will try to create a raid5 array
              with one missing drive (as this makes the  initial  resync  work
              faster).  With --force, mdadm(5,8) will not try to be so clever.


       -a, --auto{=no,yes,md,mdp,part,p}{NN}
              Instruct  mdadm(5,8)  to  create  the device file(1,n) if(3,n) needed, possibly
              allocating an unused minor number.  "md" causes a non-partition-
              able array to be used.  "mdp", "part" or "p" causes a partition-
              able array (2.6 and later) to be used.  "yes" requires the named(5,8)
              md device to have a from this.  See DEVICE NAMES below.

              The  argument can also come immediately after "-a".  e.g. "-ap".

              If --scan is also given, then any auto(5,8)= entries  in(1,8)  the  config(1,5)
              file(1,n)  will over-ride the --auto instruction given on the command
              line.

              For partitionable arrays, mdadm(5,8) will create the device file(1,n)  for
              the  whole  array  and  for the first 4 partitions.  A different
              number of partitions can be specified at the end of this  option
              (e.g.   --auto=p7).   If  the device name ends with a digit, the
              partition names add a'p', and a number, e.g. "/dev/home1p3".  If
              there is no trailing digit, then the partition names just have a
              number added, e.g. "/dev/scratch3".

              If the md device name is in(1,8) a 'standard' format as described  in(1,8)
              DEVICE  NAMES,  then  it will be created, if(3,n) necessary, with the
              appropriate number based on that name.  If the  device  name  is
              not  in(1,8) one of these formats, then a unused minor number will be
              allocated.  The minor number will be considered unused if(3,n)  there
              is  no  active  array  for that number, and there is no entry in(1,8)
              /dev for that number and with a non-standard name.


For assemble:
       -u, --uuid=
              uuid of array to assemble. Devices which don't  have  this  uuid
              are excluded


       -m, --super-minor=
              Minor  number  of  device  that  array was created for.  Devices
              which don't have this minor number are excluded.  If you  create
              an  array  as  /dev/md1,  then  all superblocks will contain the
              minor number  1,  even  if(3,n)  the  array  is  later  assembled  as
              /dev/md2.

              Giving the literal word "dev" for --super-minor will cause mdadm(5,8)
              to use the minor number of the md device that  is  being  assem-
              bled.  e.g. when assembling /dev/md0, will look(1,8,3 Search::Dict) for super blocks
              with a minor number of 0.


       -f, --force
              Assemble the array even if(3,n) some superblocks appear out-of-date


       -R, --run
              Attempt to start the array even if(3,n) fewer drives were given  than
              are  needed  for  a  full  array. Normally if(3,n) not all drives are
              found and --scan is not used, then the array will  be  assembled
              but not started.  With --run an attempt will be made to start it
              anyway.


       -a, --auto{=no,yes,md,mdp,part}
              See this option under Create and Build options.


       -U, --update=
              Update the superblock on each device while assembling the array.
              The  argument  given  to  this flag can be one of sparc2.2, sum-
              maries, resync, or super-minor.

              The sparc2.2 option will  adjust the superblock of an array what
              was  created on a Sparc machine running a patched 2.2 Linux ker-
              nel.  This kernel got the alignment of part  of  the  superblock
              wrong.   You can use the --examine --sparc2.2 option to mdadm(5,8) to
              see what effect this would have.

              The super-minor option will update(7,n) the prefered minor  field  on
              each  superblock  to  match  the minor number of the array being
              assembled.  This is not needed on 2.6 and later kernels as  they
              make this adjustment automatically.

              The  resync option will cause the array to be marked dirty mean-
              ing that any redundancy in(1,8) the array  (e.g.  parity  for  raid5,
              copies  for  raid1)  may be incorrect.  This will cause the raid
              system to perform a "resync" pass to make sure that  all  redun-
              dant information is correct.

              The   summaries   option  will  correct  the  summaries  in(1,8)  the
              superblock. That  is  the  counts  of  total,  working,  active,
              failed, and spare devices.


For Manage mode:
       -a, --add
              hotadd listed devices.


       -r, --remove
              remove  listed  devices.   They  must  not be active.  i.e. they
              should be failed or spare devices.


       -f, --fail
              mark listed devices as faulty.


       --set-faulty
              same as --fail.


For Examine mode:
       --sparc2.2
              If an array was created on a 2.2 Linux kernel patched with  RAID
              support,  the  superblock will have been created incorrectly, or
              at least incompatibly with 2.4 and  later  kernels.   Using  the
              --sparc2.2  flag  with  --examine will fix the superblock before
              displaying it.  If this appears to do the right thing, then  the
              array   can   be   successfully   assembled   using   --assemble
              --update=sparc2.2.


For Misc mode:
       -R, --run
              start a partially built array.


       -S, --stop
              deactivate array, releasing all resources.


       -o, --readonly
              mark array as readonly.


       -w, --readwrite
              mark array as readwrite.


       --zero-superblock
              If the device contains a valid md superblock, the block is over-
              written with zeros.  With --force the block where the superblock
              would be is over-written even if(3,n) it doesn't appear to be  valid.


       -t, --test
              When  used  with  --detail,  the  exit(3,n,1 builtins) status of mdadm(5,8) is set(7,n,1 builtins) to
              reflect the status of the device.


For Monitor mode:
       -m, --mail
              Give a mail(1,8) address to send(2,n) alerts to.


       -p, --program, --alert
              Give a program to be run whenever an event is detected.


       -d, --delay
              Give a delay in(1,8) seconds.  mdadm(5,8) polls the  md  arrays  and  then
              waits this many seconds before polling again.  The default is 60
              seconds.


       -f, --daemonise
              Tell mdadm(5,8) to run as a background daemon if(3,n) it decides to  moni-
              tor  anything.  This causes it to fork and run in(1,8) the child, and
              to disconnect form the terminal.  The process id of the child is
              written  to  stdout.  This is useful with --scan which will only
              continue monitoring if(3,n) a mail(1,8) address or alert program is  found
              in(1,8) the config(1,5) file.


       -i, --pid-file
              When  mdadm(5,8) is running in(1,8) daemon mode, write(1,2) the pid of the dae-
              mon process to the specified file(1,n), instead  of  printing  it  on
              standard output.


       -1, --oneshot
              Check  arrays only once.  This will generate NewArray events and
              more significantly DegradedArray and SparesMissing events.  Run-
              ning
                      mdadm(5,8) --monitor --scan -1
              from  a  cron  script  will  ensure  regular notification of any
              degraded arrays.


       -t, --test
              Generate a TestMessage alert for every array found  at  startup.
              This  alert  gets(3,n)  mailed and passed to the alert program.  This
              can be used for testing that alert message do get  through  suc-
              cessfully.


ASSEMBLE MODE
       Usage: mdadm(5,8) --assemble md-device options-and-component-devices...

       Usage: mdadm(5,8) --assemble --scan md-devices-and-options...

       Usage: mdadm(5,8) --assemble --scan options...


       This  usage  assembles one or more raid arrays from pre-existing compo-
       nents.  For each array, mdadm(5,8) needs to know the md device, the identity
       of  the array, and a number of component-devices. These can be found in(1,8)
       a number of ways.

       In the first usage example (without the --scan) the first device  given
       is  the md device.  In the second usage example, all devices listed are
       treated as md devices and assembly is attempted.  In the  third  (where
       no devices are listed) all md devices that are listed in(1,8) the configura-
       tion file(1,n) are assembled.

       If precisely one device is listed, but --scan is not given, then  mdadm(5,8)
       acts  as  though --scan was given and identify information is extracted
       from the configuration file.

       The identity can be given with the --uuid  option,  with  the  --super-
       minor  option,  can be found  in(1,8) the config(1,5) file(1,n), or will be taken from
       the super block on the first component-device  listed  on  the  command
       line.

       Devices  can  be  given on the --assemble command line or in(1,8) the config(1,5)
       file. Only devices which have an md superblock which contains the right
       identity will be considered for any array.

       The  config(1,5)  file(1,n)  is  only  used  if(3,n) explicitly named(5,8) with --config or
       requested with (a  possibly  implicit)  --scan.   In  the  later  case,
       /etc/mdadm.conf is used.

       If  --scan is not given, then the config(1,5) file(1,n) will only be used to find
       the identity of md arrays.

       Normally the array will be started after it is assembled.   However  if(3,n)
       --scan is not given and insufficient drives were listed to start a com-
       plete (non-degraded) array, then the array is  not  started  (to  guard
       against  usage  errors).   To  insist that the array be started in(1,8) this
       case (as may work for RAID1, 4, 5 or 6), give the --run flag.

       If an auto(5,8) option is given, either on the command line (--auto)  or  in(1,8)
       the  configuration file(1,n) (e.g. auto(5,8)=part), then mdadm(5,8) will create the md
       device if(3,n) necessary or will re-create it if(3,n) it doesn't look(1,8,3 Search::Dict)  usable  as
       it is.

       This can be useful for handling partitioned devices (which don't have a
       stable device number - it can change after a  reboot)  and  when  using
       "udev"  to manage your /dev tree (udev cannot handle md devices because
       of the unusual device initialisation conventions).

       If the option to "auto(5,8)" is "mdp" or "part"  or  (on  the  command  line
       only)  "p",  then  mdadm(5,8)  will  create a partitionable array, using the
       first free one that is not inuse, and does not already have an entry in(1,8)
       /dev (apart from numeric /dev/md* entries).

       If the option to "auto(5,8)" is "yes" or "md" or (on the command line) noth-
       ing, then mdadm(5,8) will create a traditional, non-partitionable md  array.

       It  is  expected  that  the "auto(5,8)" functionality will be used to create
       device  entries  with  meaningful  names  such  as  "/dev/md/home"   or
       "/dev/md/root",  rather than names based on the numerical array number.

       When using this option to create  a  partitionable  array,  the  device
       files  for the first 4 partitions are also created. If a different num-
       ber is required it can be simply appended to  the  auto(5,8)  option.   e.g.
       "auto(5,8)=part8".   Partition names are created by appending a digit string(3,n)
       to the device name, with an intervening "p" if(3,n)  the  device  name  ends
       with a digit.

       The  --auto  option  is  also  available in(1,8) Build and Create modes.  As
       those modes do not use a config(1,5) file(1,n), the "auto(5,8)="  config(1,5)  option  does
       not apply to these modes.


BUILD MODE
       Usage:   mdadm(5,8)  --build  device  --chunk=X  --level=Y  --raid-devices=Z
                   devices


       This usage is similar to --create.  The difference is that  it  creates
       an array without a superblock. With these arrays there is no difference
       between initially creating the array and  subsequently  assembling  the
       array,  except  that hopefully there is useful data there in(1,8) the second
       case.

       The level may raid0, linear, multipath, or faulty, or one of their syn-
       onyms.  All  devices  must be listed and the array will be started once
       complete.


CREATE MODE
       Usage: mdadm(5,8) --create device --chunk=X --level=Y
                   --raid-devices=Z devices


       This usage will initialise a new md array, associate some devices  with
       it, and activate the array.

       If  the --auto option is given (as described in(1,8) more detail in(1,8) the sec-
       tion on Assemble mode), then the md device will be created with a suit-
       able device number if(3,n) necessary.

       As  devices  are  added,  they  are checked to see if(3,n) they contain raid
       superblocks or filesystems. They are also checked to see if(3,n)  the  vari-
       ance in(1,8) device size exceeds 1%.

       If  any  discrepancy is found, the array will not automatically be run,
       though the presence of a --run can override this caution.

       To create a "degraded" array in(1,8) which some devices are missing,  simply
       give  the  word  "missing"  in(1,8) place of a device name.  This will cause
       mdadm(5,8) to leave the corresponding slot in(1,8) the array empty.  For a  RAID4
       or  RAID5 array at most one slot can be "missing"; for a RAID6 array at
       most two slots.  For a RAID1 array, only one real device  needs  to  be
       given.  All of the others can be "missing".

       When creating a RAID5 array, mdadm(5,8) will automatically create a degraded
       array with an extra spare drive.  This is because  building  the  spare
       into a degraded array is in(1,8) general faster than resyncing the parity on
       a non-degraded, but not clean, array.  This feature can be  over-ridden
       with the --force option.


       The General Management options that are valid with --create are:

       --run  insist  on running the array even if(3,n) some devices look(1,8,3 Search::Dict) like they
              might be in(1,8) use.


       --readonly
              start the array readonly - not supported yet.


MANAGE MODE
       Usage: mdadm(5,8) device options... devices...


       This usage will allow individual devices in(1,8)  an  array  to  be  failed,
       removed  or  added.  It is possible to perform multiple operations with
       on command. For example:
         mdadm(5,8) /dev/md0 -f /dev/hda1 -r /dev/hda1 -a /dev/hda1
       will firstly mark /dev/hda1 as faulty in(1,8) /dev/md0 and will then  remove
       it  from the array and finally add it back in(1,8) as a spare.  However only
       one md array can be affected by a single command.


MISC MODE
       Usage: mdadm(5,8) options ...  devices ...


       MISC mode includes a number of distinct operations that operate on dis-
       tinct devices.  The operations are:

       --query
              The  device  is examined to see if(3,n) it is (1) an active md array,
              or (2) a component of an md array.  The  information  discovered
              is reported.


       --detail
              The  device should be an active md device.  mdadm(5,8) will display a
              detailed description of the array.  --brief or --scan will cause
              the output to be less(1,3) detailed and the format to be suitable for
              inclusion in(1,8) /etc/mdadm.conf.  The exit(3,n,1 builtins)  status  of  mdadm(5,8)  will
              normally  be  0  unless  mdadm(5,8)  failed to get useful information
              about the device(s).  However if(3,n) the  --test  option  is  given,
              then the exit(3,n,1 builtins) status will be:

              0      The array is functioning normally.

              1      The array has at least one failed device.

              2      The  array has multiple failed devices and hence is unus-
                     able (raid4 or raid5).

              4      There was an error(8,n) while trying to get information  about
                     the device.


       --examine
              The  device  should  be  a component of an md array.  mdadm(5,8) will
              read(2,n,1 builtins) the md superblock of the device and display  the  contents.
              If  --brief  is  given, or --scan then multiple devices that are
              components of the one array are grouped together and reported in(1,8)
              a single entry suitable for inclusion in(1,8) /etc/mdadm.conf.

              Having --scan without listing any devices will cause all devices
              listed in(1,8) the config(1,5) file(1,n) to be examined.


       --stop The devices should be active md arrays  which  will  be  deacti-
              vated, as long as they are not currently in(1,8) use.


       --run  This will fully activate a partially assembled md array.


       --readonly
              This  will  mark an active array as read-only, providing that it
              is not currently being used.


       --readwrite
              This will change a readonly array back to being read(2,n,1 builtins)/write.


       --scan For all operations except --examine, --scan will cause the oper-
              ation  to  be applied to all arrays listed in(1,8) /proc(5,n)/mdstat.  For
              --examine, --scan causes all devices listed in(1,8) the  config(1,5)  file(1,n)
              to be examined.



MONITOR MODE
       Usage: mdadm(5,8) --monitor options... devices...


       This  usage causes mdadm(5,8) to periodically poll a number of md arrays and
       to report on any events noticed.  mdadm(5,8) will never exit(3,n,1 builtins) once it decides
       that  there  are  arrays to be checked, so it should normally be run in(1,8)
       the background.

       As well as reporting events, mdadm(5,8) may move(3x,7,3x curs_move)  a  spare  drive  from  one
       array  to another if(3,n) they are in(1,8) the same spare-group and if(3,n) the desti-
       nation array has a failed drive but no spares.

       If any devices are listed on the command line, mdadm(5,8) will only  monitor
       those  devices.  Otherwise  all arrays listed in(1,8) the configuration file(1,n)
       will be monitored.  Further, if(3,n) --scan is  given,  then  any  other  md
       devices that appear in(1,8) /proc(5,n)/mdstat will also be monitored.

       The result of monitoring the arrays is the generation of events.  These
       events are passed to a separate  program  (if(3,n)  specified)  and  may  be
       mailed to a given E-mail address.

       When  passing  event to program, the program is run once for each event
       and is given 2 or 3 command-line arguements.  The first is the name  of
       the  event  (see below).  The second is the name of the md device which
       is affected, and the third is the name of a related device if(3,n) relevant,
       such as a component device that has failed.

       If  --scan is given, then a program or an E-mail address must be speci-
       fied on the command line or in(1,8) the config(1,5) file.  If neither are  avail-
       able,  then mdadm(5,8) will not monitor anything.  Without --scan mdadm(5,8) will
       continue monitoring as long as something was found to monitor.   If  no
       program or email is given, then each event is reported to stdout.

       The different events are:


           DeviceDisappeared
                  An  md  array  which previously was configured appears to no
                  longer be configured.

                  If mdadm(5,8) was told to monitor an array which is RAID0 or Lin-
                  ear,  then  it  will report DeviceDisappeared with the extra
                  information Wrong-Level.  This is because RAID0  and  Linear
                  do not support the device-failed, hot-spare and resync oper-
                  ations which are monitored.


           RebuildStarted
                  An md array started reconstruction.


           RebuildNN
                  Where NN is 20, 40, 60, or 80, this indicates  that  rebuild
                  has passed that many percentage of the total.


           RebuildFinished
                  An  md  array  that  was  rebuilding, isn't any more, either
                  because it finished normally or was aborted.


           Fail   An active component device of an array has  been  marked  as
                  faulty.


           FailSpare
                  A  spare component device which was being rebuilt to replace
                  a faulty device has failed.


           SpareActive
                  A spare component device which was being rebuilt to  replace
                  a  faulty  device  as been successfully rebuild and has been
                  made active.


           NewArray
                  A new md array has been detected in(1,8) the /proc(5,n)/mdstat file.


           DegradedArray
                  A newly noticed array appears to be degraded.  This  message
                  is  not  generated  when mdadm(5,8) notices a drive failure which
                  causes degradation, but only  when  mdadm(5,8)  notices  that  an
                  array is degraded when it first sees the array.


           MoveSpare
                  A spare drive has been moved from one array in(1,8) a spare-group
                  to another to allow a failed drive to be replaced.


           SparesMissing
                  If mdadm(5,8) has been told, via the config(1,5) file(1,n), that  an  array
                  should  have  a  certain  number of spare devices, and mdadm(5,8)
                  detects that it has fewer that this  number  when  it  first
                  sees the array, it will report a SparesMissing message.


           TestMessage
                  An  array  was  found  at  startup,  and the --test flag was
                  given.

       Only Fail , FailSpare , DegradedArray , and TestMessage cause Email  to
       be  sent.   All events cause the program to be run.  The program is run
       with two or three arguments, they  being  the  event  name,  the  array
       device and possibly a second device.

       Each event has an associated array device (e.g.  /dev/md1) and possibly
       a second device.  For  Fail,  FailSpare,  and  SpareActive  the  second
       device  is  the  relevant  component  device.  For MoveSpare the second
       device is the array that the spare was moved from.

       For mdadm(5,8) to move(3x,7,3x curs_move) spares from  one  array  to  another,  the  different
       arrays  need to be labelled with the same spare-group in(1,8) the configura-
       tion file.  The spare-group name can be any string. It is  only  neces-
       sary that different spare groups use different names.

       When  mdadm(5,8)  detects  that an array which is in(1,8) a spare group has fewer
       active devices than necessary for the complete array, and has no  spare
       devices,  it  will  look(1,8,3 Search::Dict) for another array in(1,8) the same spare group that
       has a full complement of working drive  and  a  spare.   It  will  then
       attempt  to  remove  the  spare from the second drive and add it to the
       first.  If the removal succeeds but the adding fails, then it is  added
       back to the original array.


GROW MODE
       The  GROW  mode  is  used  for  changing the size or shape of an active
       array.  For this to work, the kernel must support the necessary change.
       Various  types  of growth may be added during 2.6 development, possibly
       including restructuring a raid5 array to have more active devices.

       Currently the only support available is to change the "size"  attribute
       for  arrays  with  redundancy,  and  the  raid-disks attribute of RAID1
       arrays.

       Normally when an array is built the "size" it taken from  the  smallest
       of  the  drives.   If  all  the small drives in(1,8) an arrays are, one at a
       time(1,2,n), removed and replaced with larger drives, then you could  have  an
       array  of  large  drives with only a small amount used.  In this situa-
       tion, changing the "size" with "GROW" mode will allow the  extra  space
       to  start being used.  If the size is increased in(1,8) this way, a "resync"
       process will start to make sure the new parts of the array are synchro-
       nised.

       Note that when an array changes size, any filesystem that may be stored
       in(1,8) the array will  not  automatically  grow  to  use  the  space.   The
       filesystem will need to be explicitly told to use the extra space.

       A  RAID1  array  can  work  with  any  number of devices from 1 upwards
       (though 1 is not very useful).  There may be times which  you  want  to
       increase  or  decrease the number of active devices.  Note that this is
       different to hot-add or hot-remove which changes the number of inactive
       devices.

       When  reducing  the number of devices in(1,8) a RAID1 array, the slots which
       are to be removed from the array must already be vacant.  That is,  the
       devices that which were in(1,8) those slots must be failed and removed.

       When  the  number  of  devices  is  increased,  any hot spares that are
       present will be activated immediately.


EXAMPLES
         mdadm(5,8) --query /dev/name-of-device
       This will find out if(3,n) a given device is a raid array,  or  is  part  of
       one, and will provide brief information about the device.

         mdadm(5,8) --assemble --scan
       This  will assemble and start all arrays listed in(1,8) the standard confile
       file.  This command will typically go in(1,8) a system startup file.

         mdadm(5,8) --stop --scan
       This will shut down all array that can be shut down (i.e. are not  cur-
       rently in(1,8) use).  This will typically go in(1,8) a system shutdown(2,8) script.

         mdadm(5,8) --follow --scan --delay=120
       If  (and  only  if(3,n))  there  is an Email address or program given in(1,8) the
       standard config(1,5) file(1,n), then monitor the status of all arrays  listed  in(1,8)
       that file(1,n) by polling them ever 2 minutes.

         mdadm(5,8) --create /dev/md0 --level=1 --raid-devices=2 /dev/hd[ac]1
       Create /dev/md0 as a RAID1 array consisting of /dev/hda1 and /dev/hdc1.

         echo(1,3x,1 builtins) 'DEVICE /dev/hd*[0-9] /dev/sd*[0-9]' > mdadm.conf
         mdadm(5,8) --detail --scan >> mdadm.conf
       This will create a  prototype  config(1,5)  file(1,n)  that  describes  currently
       active  arrays that are known to be made from partitions of IDE or SCSI
       drives.  This file(1,n) should be reviewed before being used as it may  con-
       tain unwanted detail.

         echo(1,3x,1 builtins) 'DEVICE /dev/hd[a-z] /dev/sd*[a-z]' > mdadm.conf
          mdadm(5,8)  --examine  --scan --config=mdadm.conf >> mdadm.conf This will
       find what arrays could be assembled from existign IDE  and  SCSI  whole
       drives  (not  partitions)  and store the information is the format of a
       config(1,5) file.  This file(1,n) is very likely to contain unwanted detail, par-
       ticularly  the  devices=  entries.   It  should  be reviewed and edited
       before being used as an actual config(1,5) file.

         mdadm(5,8) --examine --brief --scan --config=partitions
         mdadm(5,8) -Ebsc partitions
       Create a list of devices by reading /proc(5,n)/partitions,  scan  these  for
       RAID superblocks, and printout a brief listing of all that was found.

         mdadm(5,8) -Ac partitions -m 0 /dev/md0
       Scan all partitions and devices listed in(1,8) /proc(5,n)/partitions and assemble
       /dev/md0 out of all such devices with a RAID superblock  with  a  minor
       number of 0.

         mdadm(5,8) --monitor --scan --daemonise > /var/run/mdadm(5,8)
       If  config(1,5)  file(1,n) contains a mail(1,8) address or alert program, run mdadm(5,8) in(1,8)
       the background in(1,8) monitor mode monitoring all md devices.   Also  write(1,2)
       pid of mdadm(5,8) daemon to /var/run/mdadm(5,8).

         mdadm(5,8) --create --help
       Providew help about the Create mode.

         mdadm(5,8) --config --help
       Provide help about the format of the config(1,5) file.

         mdadm(5,8) --help
       Provide general help.



FILES
   /proc(5,n)/mdstat
       If  you're using the /proc(5,n) filesystem, /proc(5,n)/mdstat lists all active md
       devices with information about them.  mdadm(5,8) uses this  to  find  arrays
       when  --scan is given in(1,8) Misc mode, and to monitor array reconstruction
       on Monitor mode.



   /etc/mdadm.conf
       The config(1,5) file(1,n) lists which devices may be scanned to see if(3,n) they  con-
       tain  MD  super  block,  and  gives identifying information (e.g. UUID)
       about known MD arrays.  See mdadm.conf(5) for more details.


DEVICE NAMES
       While entries in(1,8) the /dev directory can have any format you like, mdadm(5,8)
       has  an  understanding of 'standard' formats which it uses to guide its
       behaviour when creating device files via the --auto option.

       The standard names for non-partitioned arrays  (the  only  sort(1,3)  of  md
       array available in(1,8) 2.4 and earlier) either of

              /dev/mdNN
              /dev/md/NN

       where  NN is a number.  The standard names for partitionable arrays (as
       available from 2.6 onwards) is one of

              /dev/md/dNN
              /dev/md_dNN

       Partition numbers should be indicated by added  "pMM"  to  these,  thus
       "/dev/md/d1p2".


NOTE
       mdadm(5,8) was previously known as mdctl.

       mdadm(5,8)  is  completely separate from the raidtools package, and does not
       use the /etc/raidtab configuration file(1,n) at all.


SEE ALSO
       For information on the various levels of RAID, check out:


              http://ostenfeld.dk/~jakob/Software-RAID.HOWTO/

       The lastest version(1,3,5) of mdadm(5,8) should always be available from

              http://www.kernel.org/pub/linux/utils/raid/mdadm(5,8)/

       mdadm.conf(5), md(4).

       raidtab(5), raid0run(8), raidstop(8), mkraid(8).



v1.12.0                                                               MDADM(8)

References for this manual (incoming links)