Revert "LU-11058 test: reenable sanity 77k test"

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

diff --git a/lustre/doc/lnetctl.8 b/lustre/doc/lnetctl.8
index 21fb896..a1165da 100644 (file)
--- a/lustre/doc/lnetctl.8
+++ b/lustre/doc/lnetctl.8
@@ -1,12 +1,15 @@
 .
-.TH lnetctl 1 "2014 Sep 12" Lustre "configuration utilities"
+.TH lnetctl 8 "2017 Jan 12" Lustre "configuration utilities"
 .
 .SH "SYNOPSIS"
 \fBlnetctl\fR
 .
 .br
+.B lnetctl --list-commands
+.br
 \fBlnetctl\fR \fB<cmd> <subcmd> [optional parameters]\fR
 .
+.br
 .SH "DESCRIPTION"
 \fBlnetctl\fR is used to configure LNet parameters allowing various configuration
 and debugging features to be accessed\.
@@ -16,8 +19,9 @@ and debugging features to be accessed\.
 After that, commands are issued as below\.
 .
 .P
-To get a complete listing of available commands, type \fBhelp\fR at the
-lnetctl prompt\. To get basic help on the meaning and syntax of a command
+To get a complete listing of available commands, type
+.B --list-commands
+at the lnetctl prompt\. To get basic help on the meaning and syntax of a command
 type \fB<command>\fR \-\-help\.
 .
 .P
@@ -102,6 +106,54 @@ parameter\.
 .
 .br
 \-\-verbose: display detailed output per network
+
+.
+.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.
+.
+.br
+.
+\-\-nid: one or more peer NIDs to add to the peer\.
+.
+.br
+.
+\-\-prim_nid: Primary NID of the peer\.
+.
+.br
+\-\-non_mr: create this peer as not Multi-Rail capable\.
+.
+.br
+
+.TP
+\fBlnetctl peer\fR del
+Delete a peer NID.  The primary NID must be specified.  If the removed NID is the primary NID, the peer entry will be deleted.
+.
+.br
+.
+\-\-nid: one or more peer NIDs to remove from the peer\.
+.
+.br
+.
+\-\-prim_nid: Primary NID of the peer\.
+.
+.br
+
+.TP
+\fBlnetctl peer\fR show
+Show configured peers.  By default, lists all peers and associated NIDs.
+.
+.br
+.
+\-\-nid: list of primary nids to filter on
+.
+.br
+.
+\-\-verbose: Include extended statistics, including credits and counters.
+.
+.br
+
 .
 .SS "Route Configuration"
 .
@@ -156,7 +208,7 @@ parameter\.
 \-\-priority: priority of route (0 \- highest prio to filter on)
 .
 .br
-\-\-vebose: display detailed output per route
+\-\-verbose: display detailed output per route
 .
 .br
 
@@ -305,6 +357,10 @@ Show details on configured peer credits
 .br
 \-> Minimum router credits\.
 .
+.SH "OPTIONS"
+.TP
+.B --list-commands
+Output a list of the commands supported by the lnetctl utility
 .SH "EXAMPLES"
 .
 .SS "Initializing LNet after load"
@@ -585,10 +641,10 @@ statistics:
 .
 .br
 .
-.SS "Showing peer credits information"
+.SS "Showing peer information"
 .
 .IP "\(bu" 4
-lnetctl peer_credits show
+lnetctl peer show
 .
 .IP "" 0
 .
@@ -596,31 +652,43 @@ lnetctl peer_credits show
 peer:
 .
 .br
-       \- nid: 192\.168\.205\.131@tcp1
+    \- primary nid: 10\.148\.0\.8@o2ib
+.
+.br
+      Multi\-Rail: True
+.
+.br
+      peer ni:
+.
+.br
+        \- nid: 10\.148\.0\.8@o2ib
+.
+.br
+          state: NA
 .
 .br
-         state: down
+    \- primary nid: 10\.148\.0\.20@o2ib
 .
 .br
-         refcount: 4
+      Multi\-Rail: True
 .
 .br
-         max_ni_tx_credits: 8
+      peer ni:
 .
 .br
-         available_tx_credits: 8
+        \- nid: 10\.148\.0\.20@o2ib
 .
 .br
-         available_rtr_credits: 8
+          state: NA
 .
 .br
-         min_rtr_credits: 7
+        \- nid: 10\.148\.0\.25@o2ib
 .
 .br
-         tx_q_num_of_buf: 0
+          state: NA
 .
 .br
 
 .SH SEE ALSO
-.BR Lustre (7)
+.BR lustre (7)