lustre/doc/lfs-mirror-split.1

   1 .TH LFS-MIRROR-SPLIT 1 2017-07-25 "Lustre" "Lustre Utilities"
   2 .SH NAME
   3 lfs mirror split \- split a specified mirror from an existing mirrored file
   4 .SH SYNOPSIS
   5 .B lfs mirror split
   6 {\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\
   7 \fB\-\-comp\-id\fR|\fB\-I\fR
   8 <\fIcomp_id\fR> | \fB\-\-pool\fR <\fIpool\fR>}
   9 [\fB\-\-destroy\fR|\fB\-d\fR]
  10 [\fB\-f\fR <\fInew_file\fR>]
  11 <\fImirrored_file\fR>
  12 .SH DESCRIPTION
  13 This command splits a mirror with mirror ID <\fImirror_id\fR> or containing
  14 a component with <\fIcomp_id\fR> or containing a component on <\fIpool\fR>
  15 out of a mirrored file specified by the path name \fImirrored_file\fR.
  16 By default, the layout of the split mirror will be stored into a new file named
  17 <\fImirrored_file\fR>.mirror~<\fImirror_id\fR>. If \fB\-\-destroy\fR|\fB\-d\fR
  18 option is specified, and the split mirror is not the last non-stale mirror,
  19 then it will be destroyed.
  20 If \fB\-f\fR <\fInew_file\fR> option is specified, then the layout of the split
  21 mirror will be stored into the named file.
  22 .br
  23 If \fImirrored_file\fR has only one mirror existing after split, it will be
  24 converted to a regular non-mirrored file.
  25 .br
  26 If the original \fImirrored_file\fR is not a mirrored file, then the command
  27 will return an error.
  28 .SH OPTIONS
  29 .TP
  30 .BR \-\-mirror\-id\fR\ <\fImirror_id\fR>
  31 The numerical unique identifier for a mirror. The mirror ID is unique within a
  32 mirrored file and is automatically assigned at file creation or extension time.
  33 It can be fetched by \fBlfs getstripe\fR command (see \fBlfs(1)\fR).
  34 .TP
  35 .BR \-\-comp\-id\fR\ <\fIcomp_id\fR>
  36 The numerical unique identifier for a component contained within a mirror.
  37 .TP
  38 .BR \-\-pool\fR\ <\fIpool\fR>
  39 The pool storing a component contained within a mirror.
  40 .TP
  41 .BR \-\-destroy\fR|\fB\-d\fR
  42 This option indicates the split mirror will be destroyed.
  43 .br
  44 This option is mandatory on encrypted files when the encryption key is not
  45 available. Otherwise operation results in
  46 .B
  47 -ENOKEY.
  48 .TP
  49 .BR \-f\fR\ <\fInew_file\fR>
  50 This option indicates the layout of the split mirror will be stored into
  51 <\fInew_file\fR>.
  52 .br
  53 This option cannot be used on encrypted files when the encryption key is not
  54 available. It will result in
  55 .B
  56 -ENOKEY.
  57 .SH EXAMPLES
  58 .TP
  59 .B lfs mirror split --mirror-id 1 /mnt/lustre/file1
  60 Split a mirror with ID 1 out of /mnt/lustre/file1 and store it into
  61 /mnt/lustre/file1.mirror~1.
  62 .TP
  63 .B lfs mirror split --mirror-id 2 -d /mnt/lustre/file1
  64 Split a mirror with ID 2 out of /mnt/lustre/file1 and destroy it.
  65 .TP
  66 .B lfs mirror split --mirror-id 3 -f /mnt/lustre/file2 /mnt/lustre/file1
  67 Split a mirror with ID 3 out of /mnt/lustre/file1 and store it into
  68 /mnt/lustre/file2.
  69 .TP
  70 .B lfs mirror split --comp-id 65537 -d /mnt/lustre/file1
  71 Split a mirror containing the component with ID 65537 out of /mnt/lustre/file1
  72 and destroy it.
  73 .TP
  74 .B lfs mirror split --pool lustre-nvme -d /mnt/lustre/file1
  75 Split a mirror on pool lustre-nvme out of /mnt/lustre/file1 and destroy it.
  76 .SH AUTHOR
  77 The \fBlfs mirror split\fR command is part of the Lustre filesystem.
  78 .SH SEE ALSO
  79 .BR lfs (1),
  80 .BR lfs-setstripe (1),
  81 .BR lfs-mirror-create (1),
  82 .BR lfs-mirror-delete (1),
  83 .BR lfs-mirror-extend (1),
  84 .BR lfs-mirror-resync (1),
  85 .BR lfs-mirror-verify (1)