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