Whamcloud - gitweb
LU-8367 osp: enable replay for precreation request
[fs/lustre-release.git] / lustre / doc / lfs-mirror-split.1
index d5259a9..9dd5daa 100644 (file)
@@ -3,8 +3,9 @@
 lfs mirror split \- split a specified mirror from an existing mirrored file
 .SH SYNOPSIS
 .B lfs mirror split
-{\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\fB\-I\fR
-<\fIcomp_id\fR> |\fB\-\-pool\fR <\fIpool\fR>}
+{\fB\-\-mirror\-id\fR <\fImirror_id\fR> | \fB\-\-component\-id\fR|\
+\fB\-\-comp\-id\fR|\fB\-I\fR
+<\fIcomp_id\fR> | \fB\-\-pool\fR <\fIpool\fR>}
 [\fB\-\-destroy\fR|\fB\-d\fR]
 [\fB\-f\fR <\fInew_file\fR>]
 <\fImirrored_file\fR>
@@ -39,10 +40,20 @@ The pool storing a component contained within a mirror.
 .TP
 .BR \-\-destroy\fR|\fB\-d\fR
 This option indicates the split mirror will be destroyed.
+.br
+This option is mandatory on encrypted files when the encryption key is not
+available. Otherwise operation results in
+.B
+-ENOKEY.
 .TP
 .BR \-f\fR\ <\fInew_file\fR>
 This option indicates the layout of the split mirror will be stored into
 <\fInew_file\fR>.
+.br
+This option cannot be used on encrypted files when the encryption key is not
+available. It will result in
+.B
+-ENOKEY.
 .SH EXAMPLES
 .TP
 .B lfs mirror split --mirror-id 1 /mnt/lustre/file1
@@ -56,6 +67,10 @@ Split a mirror with ID 2 out of /mnt/lustre/file1 and destroy it.
 Split a mirror with ID 3 out of /mnt/lustre/file1 and store it into
 /mnt/lustre/file2.
 .TP
+.B lfs mirror split --comp-id 65537 -d /mnt/lustre/file1
+Split a mirror containing the component with ID 65537 out of /mnt/lustre/file1
+and destroy it.
+.TP
 .B lfs mirror split --pool lustre-nvme -d /mnt/lustre/file1
 Split a mirror on pool lustre-nvme out of /mnt/lustre/file1 and destroy it.
 .SH AUTHOR
@@ -64,6 +79,7 @@ The \fBlfs mirror split\fR command is part of the Lustre filesystem.
 .BR lfs (1),
 .BR lfs-setstripe (1),
 .BR lfs-mirror-create (1),
+.BR lfs-mirror-delete (1),
 .BR lfs-mirror-extend (1),
 .BR lfs-mirror-resync (1),
 .BR lfs-mirror-verify (1)