LU-11138 lfs: getstripe display certain mirror(s)

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

diff --git a/lustre/doc/lfs-getstripe.1 b/lustre/doc/lfs-getstripe.1
index 98c1156..e8a18cc 100644 (file)
--- a/lustre/doc/lfs-getstripe.1
+++ b/lustre/doc/lfs-getstripe.1
@@ -21,6 +21,7 @@ lfs getstripe \- Lustre client command to print layout parameters of a file
 [\fB--stripe-count\fR|\fB-c\fR]
 [\fB--stripe-index\fR|\fB-i\fR]
       [\fB--stripe-size\fR|\fB-S\fR]
+[[\fB!\fR] \fB--mirror-index\fR=[\fB+-\fR]\fI<index>\fR | [\fB!\fR] \fB--mirror-id\fR=[\fB+-\fR]\fI<id>\fR]
 [\fB--verbose\fR|\fB-v\fR]
 [\fB--yaml\fR|\fB-y\fR]
       <\fIdirname\fR|\fIfilename\fR> ...
@@ -41,18 +42,24 @@ specific layout information to be printed, then the
 .BR --component-count ,
 .BR --component-start ,
 .BR --component-end ,
-or
 .BR --pool
+or
+.BR --mirror-index
+or
+.BR --mirror-id
 options, or equivalent single-character options, can be used without an
 argument to return only the specified field(s).
 .PP
-You can limit the displayed content to one or more specific components of
-a composite file layout by specifying the matching parameter(s) for the
+You can limit the displayed content to one or more specific components or
+mirror of a composite file layout by specifying the matching
+parameter(s) for the
 .BR --component-id ,
 .BR --component-flags ,
 .BR --component-start ,
-and
 .BR --component-end ,
+.BR --mirror-index ,
+or
+.BR --mirror-id ,
 or their single-character options. For single-character options, the
 argument must follow the option without a space, and for long options an
 .RB ' = '
@@ -131,6 +138,43 @@ is used, print components with respectively a larger or smaller
 .I start
 offset.
 .TP
+.BR --mirror-index = [\fB+-\fR]\fR<\fIindex\fR>
+Print only the components of \fI<index>\fR-th mirror, based on the order
+that the mirror components are stored in the file layout, The \fIindex\fR
+starts at 1. If
+.BI + index
+or
+.BI - index
+is used, print components of mirror(s) respectively a later or earlier
+\fIindex\fR-th mirror.
+.RS 1.2i
+.TP
+.B !
+Negates the meaning. Using + before \fIindex\fR means mirror appears 'later
+than \fIindex\fR',
+- before \fIindex\fR means mirror appears 'earlier than \fIindex\fR'. If
+neither is used, it means 'equal to \fIindex\fR'.
+.RE
+.TP
+.BR --mirror-id = [\fB+-\fR]\fR<\fIid\fR>
+Print only the component s of the mirror with ID of \fIid\fR. The mirror IDs
+are assigned to new mirrors as they are created, but may not be sequential if
+some mirrors are removed. If
+.BI + id
+or
+.BI - id
+is used, print components of mirror(s) with respectively a larger or smaller
+mirror ID of
+.I id
+.
+.RS 1.2i
+.TP
+.B !
+Negates the meaning. Using + before \fIid\fR means mirror with ID 'larger
+than \fIid\fR', - before \fIid\fR means mirror with ID 'smaller than \fIid\fR'.
+If neither is used, it means 'equal to \fIid\fR'.
+.RE
+.TP
 .BR --directory | -d
 Get striping information for only the specified directory, like
 .RB ' "ls -d" '.
@@ -202,11 +246,17 @@ List the detailed object allocation of the given file.
 .B $ lfs getstripe -v -I2 /mnt/lustre/file1
 List the detailed information of only component with ID 2 of the given file.
 .TP
+.B $ lfs getstripe --mirror-index=+1 /mnt/lustre/file1
+Print the mirror(s) appearing later than the first mirror in the the file.
+.TP
+.B $ lfs getstripe ! --mirror-id=2 /mnt/lustre/file1
+Print the mirror(s) with mirror ID other than 2 in the file.
+.TP
 .B $ lfs getstripe --component-flags=^init -I /mnt/lustre/file1
 Print only the component IDs for all the uninitialized components.
 .TP
 .B $ lfs getstripe --component-flags=init,^stale -I /mnt/lustre/file1
-Print only the component(s) that are instantiated but not stale
+Print only the component(s) that are instantiated but not stale.
 .TP
 .B $ lfs getstripe -E-64M /mnt/lustre/file1
 List information of components in a file with extent end less than 64MiB.