Whamcloud - gitweb
LU-16974 utils: lfs mirror resync to show progress
[fs/lustre-release.git] / lustre / doc / lfs-mirror-resync.1
1 .TH LFS-MIRROR-RESYNC 1 2017-07-25 "Lustre" "Lustre Utilities"
2 .SH NAME
3 lfs-mirror-resync \- resynchronize an out-of-sync mirrored file
4 .SH SYNOPSIS
5 .B lfs mirror resync
6 [\fB\-\-only\fR <\fImirror_id\fR[,...]>]
7 <\fB\-\-bandwidth\-limit=\fR|\fB\-W\fR[\fIbandwidth_limit\fR]>
8 [\fB\-\-stats\fR]
9 <\fB\-\-stats\-interval\fR=\fIinterval_in_sec\fR>
10 <\fImirrored_file\fR> [<\fImirrored_file2\fR>...]
11 .SH DESCRIPTION
12 This command resynchronizes out-of-sync mirrored file(s) specified by the path
13 name \fImirrored_file\fR.
14 .br
15 If there is no stale mirror for the \fImirrored_file(s)\fR, then the command does
16 nothing. Otherwise, it will copy data from synced mirror to stale mirror(s), and
17 mark all successfully copied mirror(s) as SYNC.
18 .br
19 If \fB\-\-only\fR option is not specified, the \fBnosync\fR mirror(s) (i.e.
20 components that have this flag set) will not be synced.
21 .br
22 If \fB\-\-only\fR <\fImirror_id\fR[,...]> option is specified, then the
23 command will resynchronize the mirror(s) specified by the \fImirror_id\fR(s),
24 even nosync mirror(s) will be resynchronized as well.
25 This option cannot be used when multiple mirrored files are specified.
26 .SH OPTIONS
27 .TP
28 .BR \-\-only\fR\ <\fImirror_id\fR[,...]>
29 This option indicates which mirror(s) specified by \fImirror_id\fR(s) needs to
30 be resynchronized. The \fImirror_id\fR is the numerical unique identifier for
31 a mirror. Multiple \fImirror_id\fRs are separated by comma. This option cannot
32 be used when multiple mirrored files are specified.
33 .TP
34 .BR \-\-stats
35 This option enables progress updates every 5 seconds, in YAML format.
36 .TP
37 .BR \-\-stats-interval=\fIstats_interval
38 This option enables progress updates every \fIstats_interval\fR seconds, in YAML format.
39 .TP
40 .BR \-\-bandwidth\-limit\fR|\fB\-W\fR\fIbandwidth_limit\fR
41 This option enables throttling so that mirror extending writes no more than
42 \fIbandwidth_limit\fR bytes a second.  An optional suffix can be used to
43 specify the units in
44 .BR K ilobytes,
45 .BR M egabytes
46 or
47 .BR  G igabytes.
48 .SH EXAMPLES
49 .TP
50 .B lfs mirror resync /mnt/lustre/file1 /mnt/lustre/file2
51 Resynchronize all of the stale and sync-able mirror(s) for /mnt/lustre/file1 and /mnt/lustre/file2.
52 .TP
53 .B lfs mirror resync --only 4,5 /mnt/lustre/file1
54 Resynchronize mirrors with mirror ID 4 and 5 for /mnt/lustre/file1 even if they
55 are not marked as STALE.
56 .SH AUTHOR
57 The \fBlfs mirror resync\fR command is part of the Lustre filesystem.
58 .SH SEE ALSO
59 .BR lfs (1),
60 .BR lfs-setstripe (1),
61 .BR lfs-mirror-create (1),
62 .BR lfs-mirror-extend (1),
63 .BR lfs-mirror-split (1),
64 .BR lfs-mirror-verify (1)