.
-.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\.
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
.
.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\. The primary NID must be specified. By default, peers are marked as multi-rail capable\.
+.
+.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"
.
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
\-\-show: show configuration
.
.br
+\-\-exec: execute command
+.
+.br
\-\-help: display this help
.
.TP
.
.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
.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"
.
.br
.
-.SS "Showing peer credits information"
+.SS "Showing peer information"
.
.IP "\(bu" 4
-lnetctl peer_credits show
+lnetctl peer show
.
.IP "" 0
.
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)
git://git.whamcloud.com / fs / lustre-release.git / blobdiff