Whamcloud - gitweb
LU-14034 hsm: add PID file handling to lhsmtool_posix
[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|\
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 .TP
44 .BR \-f\fR\ <\fInew_file\fR>
45 This option indicates the layout of the split mirror will be stored into
46 <\fInew_file\fR>.
47 .SH EXAMPLES
48 .TP
49 .B lfs mirror split --mirror-id 1 /mnt/lustre/file1
50 Split a mirror with ID 1 out of /mnt/lustre/file1 and store it into
51 /mnt/lustre/file1.mirror~1.
52 .TP
53 .B lfs mirror split --mirror-id 2 -d /mnt/lustre/file1
54 Split a mirror with ID 2 out of /mnt/lustre/file1 and destroy it.
55 .TP
56 .B lfs mirror split --mirror-id 3 -f /mnt/lustre/file2 /mnt/lustre/file1
57 Split a mirror with ID 3 out of /mnt/lustre/file1 and store it into
58 /mnt/lustre/file2.
59 .TP
60 .B lfs mirror split --comp-id 65537 -d /mnt/lustre/file1
61 Split a mirror containing the component with ID 65537 out of /mnt/lustre/file1
62 and destroy it.
63 .TP
64 .B lfs mirror split --pool lustre-nvme -d /mnt/lustre/file1
65 Split a mirror on pool lustre-nvme out of /mnt/lustre/file1 and destroy it.
66 .SH AUTHOR
67 The \fBlfs mirror split\fR command is part of the Lustre filesystem.
68 .SH SEE ALSO
69 .BR lfs (1),
70 .BR lfs-setstripe (1),
71 .BR lfs-mirror-create (1),
72 .BR lfs-mirror-delete (1),
73 .BR lfs-mirror-extend (1),
74 .BR lfs-mirror-resync (1),
75 .BR lfs-mirror-verify (1)