LU-13569 lnet: Add lnet_recovery_limit to lnetctl

[fs/lustre-release.git] / lustre / doc / lnetctl.8

diff --git a/lustre/doc/lnetctl.8 b/lustre/doc/lnetctl.8
index a1165da..6e04865 100644 (file)
--- a/lustre/doc/lnetctl.8
+++ b/lustre/doc/lnetctl.8
@@ -111,7 +111,7 @@ parameter\.
 .SS "Peer Configuration"
 .TP
 \fBlnetctl peer\fR add
-Configure an LNET peer with at least one supplied NID\.  By default, peers are marked as multi-rail capable\.  If prim_nid is not specified, the first NID in this list is assumed to be the primary NID for the peer.
+Configure an LNET peer with at least one supplied NID\.  The primary NID must be specified.  By default, peers are marked as multi-rail capable\.
 .
 .br
 .
@@ -245,6 +245,28 @@ When routing is disabled the values of the buffers that might have been changed
 are not remembered, and the next time routing is enabled the default buffer
 count will be used\.
 .
+.TP
+\fBlnetctl set\fR drop_asym_route \fI[0, 1]\fR
+0 value indicates to accept asymmetrical route messages\. 1 value indicates to
+drop them\. Asymmetrical route is when a message from a remote peer is coming
+through a router that would not be used by this node to reach the remote peer\.
+.
+.TP
+\fBlnetctl set\fR response_tracking \fI[0, 1, 2, 3]\fR
+Set the behavior of response tracking\.
+  0 - Only LNet pings and discovery pushes utilize response tracking\.
+  1 - GETs are eligible for response tracking\.
+  2 - PUTs are eligible for response tracking\.
+  3 - Both PUTs and GETs are eligible for response tracking (default)\.
+  Note: Regardless of the value of the response_tracking parameter LNet
+        pings and discovery pushes always utilize response tracking\.
+.
+.TP
+\fBlnetctl set\fR recovery_limit \fIvalue\fR
+Set how long LNet will attempt to recover unhealthy peer interfaces\.
+  0 - Recover indefinitely (default)\.
+  >0 - Recover for the specified number of seconds\.
+.
 .SS "Import and Export YAML Configuration Files"
 LNet configuration can be represented in YAML format\. A YAML configuration
 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
@@ -276,6 +298,9 @@ overwritten by specifying the desired behavior\.
 \-\-show: show configuration
 .
 .br
+\-\-exec: execute command
+.
+.br
 \-\-help: display this help
 .
 .TP
@@ -284,9 +309,12 @@ overwritten by specifying the desired behavior\.
 .
 .TP
 \fBlnetctl export\fR > \fIFILE\fR
-\fBexport\fR command dumps the supported LNet configuration in YAML format to
-stdout, which can be redirected to a normal file\. The output of the
-\fBimport\fR command can be used as input to the \fBexport\fR command\.
+\fBexport\fR command dumps the LNet configuration, state information, and stats
+in YAML format to stdout, which can be redirected to a normal file\. The output
+of the \fBexport\fR command can be used as input to the \fBimport\fR command\.
+.
+.br
+\-\-backup: dump only elements necessary to recreate the current configuration.
 .
 .br
 \-\-help: display this help