Whamcloud - gitweb
34386f98a40a0c7e541fde4190e0a2de8a24ab76
[fs/lustre-release.git] / 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|\fB\-I\fR
7 <\fIcomp_id\fR> |\fB\-\-pool\fR <\fIpool\fR>}
8 [\fB\-\-destroy\fR|\fB\-d\fR]
9 [\fB\-f\fR <\fInew_file\fR>]
10 <\fImirrored_file\fR>
11 .SH DESCRIPTION
12 This command splits a mirror with mirror ID <\fImirror_id\fR> or containing
13 a component with <\fIcomp_id\fR> or containing a component on <\fIpool\fR>
14 out of a mirrored file specified by the path name \fImirrored_file\fR.
15 By default, the layout of the split mirror will be stored into a new file named
16 <\fImirrored_file\fR>.mirror~<\fImirror_id\fR>. If \fB\-\-destroy\fR|\fB\-d\fR
17 option is specified, then the split mirror will be destroyed.
18 If \fB\-f\fR <\fInew_file\fR> option is specified, then the layout of the split
19 mirror will be stored into the named file.
20 .br
21 If \fImirrored_file\fR has only one mirror existing after split, it will be
22 converted to a regular non-mirrored file.
23 .br
24 If the original \fImirrored_file\fR is not a mirrored file, then the command
25 will return an error.
26 .SH OPTIONS
27 .TP
28 .BR \-\-mirror\-id\fR\ <\fImirror_id\fR>
29 The numerical unique identifier for a mirror. The mirror ID is unique within a
30 mirrored file and is automatically assigned at file creation or extension time.
31 It can be fetched by \fBlfs getstripe\fR command (see \fBlfs(1)\fR).
32 .TP
33 .BR \-\-comp\-id\fR\ <\fIcomp_id\fR>
34 The numerical unique identifier for a component contained within a mirror.
35 .TP
36 .BR \-\-pool\fR\ <\fIpool\fR>
37 The pool storing a component contained within a mirror.
38 .TP
39 .BR \-\-destroy\fR|\fB\-d\fR
40 This option indicates the split mirror will be destroyed.
41 .TP
42 .BR \-f\fR\ <\fInew_file\fR>
43 This option indicates the layout of the split mirror will be stored into
44 <\fInew_file\fR>.
45 .SH EXAMPLES
46 .TP
47 .B lfs mirror split --mirror-id 1 /mnt/lustre/file1
48 Split a mirror with ID 1 out of /mnt/lustre/file1 and store it into
49 /mnt/lustre/file1.mirror~1.
50 .TP
51 .B lfs mirror split --mirror-id 2 -d /mnt/lustre/file1
52 Split a mirror with ID 2 out of /mnt/lustre/file1 and destroy it.
53 .TP
54 .B lfs mirror split --mirror-id 3 -f /mnt/lustre/file2 /mnt/lustre/file1
55 Split a mirror with ID 3 out of /mnt/lustre/file1 and store it into
56 /mnt/lustre/file2.
57 .TP
58 .B lfs mirror split --pool lustre-nvme -d /mnt/lustre/file1
59 Split a mirror on pool lustre-nvme out of /mnt/lustre/file1 and destroy it.
60 .SH AUTHOR
61 The \fBlfs mirror split\fR command is part of the Lustre filesystem.
62 .SH SEE ALSO
63 .BR lfs (1),
64 .BR lfs-setstripe (1),
65 .BR lfs-mirror-create (1),
66 .BR lfs-mirror-extend (1),
67 .BR lfs-mirror-resync (1),
68 .BR lfs-mirror-verify (1)