2 .TH lnetctl 8 "2017 Jan 12" Lustre "configuration utilities"
8 .B lnetctl --list-commands
10 \fBlnetctl\fR \fB<cmd> <subcmd> [optional parameters]\fR
14 \fBlnetctl\fR is used to configure LNet parameters allowing various configuration
15 and debugging features to be accessed\.
18 \fBlnetctl\fR can be invoked in interactive mode by issuing lnetctl command\.
19 After that, commands are issued as below\.
22 To get a complete listing of available commands, type
24 at the lnetctl prompt\. To get basic help on the meaning and syntax of a command
25 type \fB<command>\fR \-\-help\.
28 For non\-interactive use the \fBlnetctl\fR utility can be invoked from the
29 command line as follows:
32 lnetctl \fIcommand\fR \fIsubcommand\fR [optional parameters]
34 .SS "LNet Initialization:"
37 \fBlnetctl lnet\fR configure [\-\-all]
38 Brings up the LNet Network Interface (NI) system\. If the \-\-all option is
39 provided it will load network interfaces defined in the modprobe files\.
40 Otherwise, it doesn\'t initialize any networks by default\.
43 \fBlnetctl lnet\fR unconfigure
44 Brings down the LNet Network Interface (NI) system including any configured
47 .SS "Network Configuration"
51 Configures a network interface either given the network name and physical
52 interface device name, or given the ip2net parameter\. Other parameters
56 \-\-net: net name (e.g. tcp0)
59 \-\-if: physical interface (e.g. eth0)
62 \-\-ip2net: specify networks based on IP address patterns
65 \-\-peer\-timeout: time to wait before declaring a peer dead (in seconds).
66 Default value for o2iblnd and socklnd is 180 seconds.
69 \-\-peer\-credits: define the max number of in\-flight messages per peer.
72 \-\-peer\-buffer\-credits: the max number of routed in\-flight messages
76 \-\-credits: The total number of in\-flight messages over a network interface.
79 \-\-cpt: The CPU partitions on which the created network interface is bound to.
80 Refer to the Lustre Manual Section "Binding Network Interface Against CPU
81 Partitions" for more details. For example to bind a Network Interface to
82 CPU partitions 0 and 1, you would specify this parameter as \-\-cpt [0,
90 Delete a network interface given the network name\.
93 \-\-net: net name (e.g. tcp0)
99 \fBlnetctl net\fR show
100 Show all currently configured network interfaces if no parameters given or filter
101 on the network name\. More details can be shown by specifying the \-\-verbose
105 \-\-net: net name (e.g. tcp0) to filter on
108 \-\-verbose: display detailed output per network
111 .SS "Peer Configuration"
113 \fBlnetctl peer\fR add
114 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\.
118 \-\-nid: one or more peer NIDs to add to the peer\.
122 \-\-prim_nid: Primary NID of the peer\.
125 \-\-non_mr: create this peer as not Multi-Rail capable\.
130 \fBlnetctl peer\fR del
131 Delete a peer NID. The primary NID must be specified. If the removed NID is the primary NID, the peer entry will be deleted.
135 \-\-nid: one or more peer NIDs to remove from the peer\.
139 \-\-prim_nid: Primary NID of the peer\.
144 \fBlnetctl peer\fR show
145 Show configured peers. By default, lists all peers and associated NIDs.
149 \-\-nid: list of primary nids to filter on
153 \-\-verbose: Include extended statistics, including credits and counters.
158 .SS "Route Configuration"
161 \fBlnetctl route\fR add
165 \-\-net: net name (e.g. tcp0)
168 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
171 \-\-hop: number to final destination (1 < hops < 255)
174 \-\-priority: priority of route (0 \- highest prio)
180 \fBlnetctl route\fR del
181 Delete a route specified via the network and gateway\.
184 \-\-net: net name (e.g. tcp0)
187 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
193 \fBlnetctl route\fR show
194 Show all currently configured routes if no parameters given, or filter on
195 given parameters\. More details can be shown by specifying the \-\-verbose
199 \-\-net: net name (e.g. tcp0) to filter on
202 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp) to filter on
205 \-\-hop: number to final destination (1 < hops < 255) to filter on
208 \-\-priority: priority of route (0 \- highest prio to filter on)
211 \-\-verbose: display detailed output per route
216 .SS "Routing Information"
219 \fBlnetctl routing\fR show
220 Show router buffers values as well as show the status of routing (IE: whether
221 the node is set to be a router)
224 Individual values can be set using the \fBlnetctl set\fR command\.
227 \fBlnetctl set\fR tiny_buffers \fIvalue\fR
228 Set the number of tiny buffers in the system\. This is the total number of tiny
229 buffers for all CPU partitions\.
232 \fBlnetctl set\fR small_buffers \fIvalue\fR
233 Set the number of small buffers in the system\. This is the total number of
234 small buffers for all CPU partitions\.
237 \fBlnetctl set\fR large_buffers \fIvalue\fR
238 Set the number of large buffers in the system\. This is the total number of
239 large buffers for all CPU partitions\.
242 \fBlnetctl set\fR routing \fI[0, 1]\fR
243 0 value indicates to disable routing\. 1 value indicates to enable routing\.
244 When routing is disabled the values of the buffers that might have been changed
245 are not remembered, and the next time routing is enabled the default buffer
249 \fBlnetctl set\fR drop_asym_route \fI[0, 1]\fR
250 0 value indicates to accept asymmetrical route messages\. 1 value indicates to
251 drop them\. Asymmetrical route is when a message from a remote peer is coming
252 through a router that would not be used by this node to reach the remote peer\.
255 \fBlnetctl set\fR response_tracking \fI[0, 1, 2, 3]\fR
256 Set the behavior of response tracking\.
257 0 - Only LNet pings and discovery pushes utilize response tracking\.
258 1 - GETs are eligible for response tracking\.
259 2 - PUTs are eligible for response tracking\.
260 3 - Both PUTs and GETs are eligible for response tracking (default)\.
261 Note: Regardless of the value of the response_tracking parameter LNet
262 pings and discovery pushes always utilize response tracking\.
265 \fBlnetctl set\fR recovery_limit \fIvalue\fR
266 Set how long LNet will attempt to recover unhealthy peer interfaces\.
267 0 - Recover indefinitely (default)\.
268 >0 - Recover for the specified number of seconds\.
270 .SS "Import and Export YAML Configuration Files"
271 LNet configuration can be represented in YAML format\. A YAML configuration
272 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
273 lnetctl utility will attempt to configure all elements defined in the YAML
277 Similarly the \fBexport\fR command can be used to dump all supported LNet
278 configuration to stdout\. The output can be redirected to a file\.
281 \fBlnetctl import\fR \fIFILE\fR:
285 \fBlnetctl import\fR < \fIFILE\fR
286 \fBimport\fR command uses the specified YAML configuration file to configure
287 LNet parameters defined within\. The import command by default adds the LNet
288 parameters defined in the YAML file, but this default behavior can be
289 overwritten by specifying the desired behavior\.
292 \-\-add: add configuration
295 \-\-del: delete configuration
298 \-\-show: show configuration
301 \-\-exec: execute command
304 \-\-help: display this help
307 \fBlnetctl export\fR \fIFILE\fR:
311 \fBlnetctl export\fR > \fIFILE\fR
312 \fBexport\fR command dumps the LNet configuration, state information, and stats
313 in YAML format to stdout, which can be redirected to a normal file\. The output
314 of the \fBexport\fR command can be used as input to the \fBimport\fR command\.
317 \-\-backup: dump only elements necessary to recreate the current configuration.
320 \-\-help: display this help
322 .SS "LNet Statistics"
329 \-> Number of messages allocated
332 \-> Maximum number of messages allocated
335 \-> Number of errors encountered
338 \-> Number of messages sent
341 \-> Number of messages received
344 \-> Number of messages routed
347 \-> Total size in bytes of messages sent
350 \-> Total size in bytes of messages received
353 \-> Total size in bytes of messages routed
356 \-> Total size in bytes of messages dropped
361 .SS "Showing Peer Credits"
364 \fBlnetctl peer_credits\fR
365 Show details on configured peer credits
374 \-> Reference count on the peer
377 \-> Maximum transmit credits
380 \-> Available transmit credits
383 \-> Available router credits
386 \-> Minimum router credits\.
391 Output a list of the commands supported by the lnetctl utility
394 .SS "Initializing LNet after load"
397 lnetctl lnet configure
400 lnetctl lnet configure \-\-all
404 .SS "Shutting down LNet"
407 lnetctl lnet unconfigure
414 lnetctl net add \-\-net tcp0 \-\-if eth0
417 lnetctl net add \-\-ip2net "tcp0(eth0) 192\.168\.0\.[2,4]; tcp0 192\.168\.0\.*;
418 o2ib0 132\.6\.[1\-3]\.[2\-8/2]"
425 lnetctl net del \-\-net tcp0
432 lnetctl net show \-\-verbose:
454 peer_buffer_credits: 0
460 \- nid: 192\.168\.205\.130@tcp1
484 peer_buffer_credits: 0
494 lnetctl route add \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1 \-\-hop 1
502 lnetctl route del \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1
509 lnetctl route show \-\-verbose
520 gateway: 192\.168\.205\.131@tcp1
526 priority: 0 state: down
591 .SS "Setting variables"
594 lnetctl set tiny_buffers 2048
597 lnetctl set small_buffers 16384
600 lnetctl set large_buffers 256
603 lnetctl set routing 1
607 .SS "Importing YAML files for configuring"
610 lnetctl import lnet\.conf
613 lnetctl import < lnet\.conf
617 .SS "Exporting LNet Configuration"
620 lnetctl export lnet\.conf
623 lnetctl export > lnet\.conf
627 .SS "Showing LNet Stats"
672 .SS "Showing peer information"
683 \- primary nid: 10\.148\.0\.8@o2ib
692 \- nid: 10\.148\.0\.8@o2ib
698 \- primary nid: 10\.148\.0\.20@o2ib
707 \- nid: 10\.148\.0\.20@o2ib
713 \- nid: 10\.148\.0\.25@o2ib