LU-13482 utils: bandwidth limit for lfs migrate

[fs/lustre-release.git] / lustre / doc / lfs-migrate.1

diff --git a/lustre/doc/lfs-migrate.1 b/lustre/doc/lfs-migrate.1
index 795b5d3..02dd7bb 100644 (file)
--- a/lustre/doc/lfs-migrate.1
+++ b/lustre/doc/lfs-migrate.1
@@ -8,7 +8,7 @@ lfs migrate \- migrate files or directories between MDTs or OSTs.
 .IR FILE " ..."
 .br
 .B lfs migrate -m \fISTART_MDT_INDEX
-.RB [ -cHv ]
+.RB [ -cdHv ]
 .I DIRECTORY
 .br
 .SH DESCRIPTION
@@ -72,6 +72,20 @@ write operations synchronous.  Using the
 .B --non-direct
 option uses buffered read/write operations, which may improve migration
 speed at the cost of more CPU and memory overhead.
+.br
+This option cannot be used on encrypted files when the encryption key is not
+available. It will result in
+.B
+-ENOKEY.
+.TP
+.BR -W , --bandwidth
+Limit how much file system bandwidth a migrate job can consume.
+.TP
+.BR --stats
+Output verbose stats about migrate job progress in YAML format.
+.TP
+.BR --stats-interval
+Controls how often the stats are output; this defaults to 5 seconds.
 .TP
 .BR -v , --verbose
 Print each filename as it is migrated.
@@ -124,6 +138,11 @@ values are specified in a comma-separated list, then the number of specified
 values must match
 .IR COUNT .
 .TP
+.BR -d , --directory
+Only migrate the specified \fIDIRECTORY\fR and the non-directory inodes that are
+directly located within it.
+Similar to '\fBls -d\fR' and '\fBlfs getstripe -d\fR'.
+.TP
 .BR -H , --mdt-hash=\fIHASH_TYPE\fR
 Use
 .I HASH_TYPE
@@ -193,6 +212,11 @@ from its current MDT to MDT0000 and MDT0002.  The
 .B testremote
 directory and all of its subdirectories will be striped across both MDTs.
 .TP
+.B $ lfs migrate -m 0,2 -d ./testremote
+Move ./testremote and the first level of sub files from their current MDT
+to the MDT with index 0 and 2. Different from above case, the layout of
+subdirectories under ./testremote won't be changed.
+.TP
 .B # lfs setstripe -E 256M -c 1 -E 16G -c 4 -E eof -c 40 topdir
 Set a default PFL layout (without any DoM component) on the directory
 .BR topdir ,