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\.
128 \-\-lock_prim: lock primary NID of the peer for the purpose of identification with Lustre\.
133 \fBlnetctl peer\fR del
134 Delete a peer NID. The primary NID must be specified. If the removed NID is the primary NID, the peer entry will be deleted.
138 \-\-nid: one or more peer NIDs to remove from the peer\.
142 \-\-prim_nid: Primary NID of the peer\.
145 \-\-force: optional, use to delete a peer with primary NID locked\.
150 \fBlnetctl peer\fR show
151 Show configured peers. By default, lists all peers and associated NIDs.
155 \-\-nid: list of primary nids to filter on
159 \-\-verbose: Include extended statistics, including credits and counters.
164 .SS "Route Configuration"
167 \fBlnetctl route\fR add
171 \-\-net: net name (e.g. tcp0)
174 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
177 \-\-hop: number to final destination (1 < hops < 255)
180 \-\-priority: priority of route (0 \- highest prio)
186 \fBlnetctl route\fR del
187 Delete a route specified via the network and gateway\.
190 \-\-net: net name (e.g. tcp0)
193 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
199 \fBlnetctl route\fR show
200 Show all currently configured routes if no parameters given, or filter on
201 given parameters\. More details can be shown by specifying the \-\-verbose
205 \-\-net: net name (e.g. tcp0) to filter on
208 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp) to filter on
211 \-\-hop: number to final destination (1 < hops < 255) to filter on
214 \-\-priority: priority of route (0 \- highest prio to filter on)
217 \-\-verbose: display detailed output per route
222 .SS "Routing Information"
225 \fBlnetctl routing\fR show
226 Show router buffers values as well as show the status of routing (IE: whether
227 the node is set to be a router)
230 Individual values can be set using the \fBlnetctl set\fR command\.
233 \fBlnetctl set\fR tiny_buffers \fIvalue\fR
234 Set the number of tiny buffers in the system\. This is the total number of tiny
235 buffers for all CPU partitions\.
238 \fBlnetctl set\fR small_buffers \fIvalue\fR
239 Set the number of small buffers in the system\. This is the total number of
240 small buffers for all CPU partitions\.
243 \fBlnetctl set\fR large_buffers \fIvalue\fR
244 Set the number of large buffers in the system\. This is the total number of
245 large buffers for all CPU partitions\.
248 \fBlnetctl set\fR routing \fI[0, 1]\fR
249 0 value indicates to disable routing\. 1 value indicates to enable routing\.
250 When routing is disabled the values of the buffers that might have been changed
251 are not remembered, and the next time routing is enabled the default buffer
255 \fBlnetctl set\fR drop_asym_route \fI[0, 1]\fR
256 0 value indicates to accept asymmetrical route messages\. 1 value indicates to
257 drop them\. Asymmetrical route is when a message from a remote peer is coming
258 through a router that would not be used by this node to reach the remote peer\.
261 \fBlnetctl set\fR response_tracking \fI[0, 1, 2, 3]\fR
262 Set the behavior of response tracking\.
263 0 - Only LNet pings and discovery pushes utilize response tracking\.
264 1 - GETs are eligible for response tracking\.
265 2 - PUTs are eligible for response tracking\.
266 3 - Both PUTs and GETs are eligible for response tracking (default)\.
267 Note: Regardless of the value of the response_tracking parameter LNet
268 pings and discovery pushes always utilize response tracking\.
271 \fBlnetctl set\fR recovery_limit \fIvalue\fR
272 Set how long LNet will attempt to recover unhealthy peer interfaces\.
273 0 - Recover indefinitely (default)\.
274 >0 - Recover for the specified number of seconds\.
277 \fBlnetctl set\fR max_recovery_ping_interval \fIvalue\fR
278 Set the maximum recovery ping interval.
279 The recovery ping mechanism increases the next scheduled recovery ping attempt
280 timeout exponentially (base 2) until it is equal to the value set.
281 The default value is 900.
283 .SS "Import and Export YAML Configuration Files"
284 LNet configuration can be represented in YAML format\. A YAML configuration
285 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
286 lnetctl utility will attempt to configure all elements defined in the YAML
290 Similarly the \fBexport\fR command can be used to dump all supported LNet
291 configuration to stdout\. The output can be redirected to a file\.
294 \fBlnetctl import\fR \fIFILE\fR:
298 \fBlnetctl import\fR < \fIFILE\fR
299 \fBimport\fR command uses the specified YAML configuration file to configure
300 LNet parameters defined within\. The import command by default adds the LNet
301 parameters defined in the YAML file, but this default behavior can be
302 overwritten by specifying the desired behavior\.
305 \-\-add: add configuration
308 \-\-del: delete configuration
311 \-\-show: show configuration
314 \-\-exec: execute command
317 \-\-help: display this help
320 \fBlnetctl export\fR \fIFILE\fR:
324 \fBlnetctl export\fR > \fIFILE\fR
325 \fBexport\fR command dumps the LNet configuration, state information, and stats
326 in YAML format to stdout, which can be redirected to a normal file\. The output
327 of the \fBexport\fR command can be used as input to the \fBimport\fR command\.
330 \-\-backup: dump only elements necessary to recreate the current configuration.
333 \-\-help: display this help
335 .SS "LNet Statistics"
338 \fBlnetctl stats\fR show
342 \-> Number of messages allocated
345 \-> Maximum number of messages allocated
348 \-> Number of errors encountered
351 \-> Number of messages sent
354 \-> Number of messages received
357 \-> Number of messages routed
360 \-> Total size in bytes of messages sent
363 \-> Total size in bytes of messages received
366 \-> Total size in bytes of messages routed
369 \-> Total size in bytes of messages dropped
374 .SS "Showing Peer Credits"
377 \fBlnetctl peer_credits\fR
378 Show details on configured peer credits
387 \-> Reference count on the peer
390 \-> Maximum transmit credits
393 \-> Available transmit credits
396 \-> Available router credits
399 \-> Minimum router credits\.
401 .SS "UDSP Configuration"
404 \fBlnetctl udsp\fR add
405 Add user-defined selection policy.
410 Adding a local network udsp.
413 If multiple local networks are available, each one can be assigned a priority\.
414 The one with the highest priority is selected to send on\.
415 NID and network matching is using NID-range syntax, please see the manual for more detail\.
418 \-\-src : network in NID-range syntax (e.g. tcp0 or tcp[1-3])
421 \-\-<priority> <priority value>: optional priority value in [0-255], 0 as the highest
424 \-\-<idx>: The index of where to insert the rule\. By default append to the end of the list
429 Adding a local NID udsp.
432 Assign priority to local NIDs\. After a local network is chosen, the NI with highest priority is selected\.
435 \-\-src: NID in NID-range syntax (e.g. 10.1.1.2@tcp or 10.1.1.*@tcp)
438 \-\-<priority> <priority value>: optional priority value in [0-255], 0 as the highest
441 \-\-<idx>: The index of where to insert the rule\. By default append to the end of the list
446 Adding a peer NID udsp.
449 Assign priority to peer NIDs. Peer NID with highest priority is selected to send to\.
452 \-\-dst: NID in NID-range syntax (e.g. 10.1.1.2@tcp)
455 \-\-<priority> <priority value>: optional priority value in [0-255], 0 as the highest
458 \-\-<idx>: The index of where to insert the rule\. By default append to the end of the list
463 Adding a NID pair udsp.
466 The local NIDs which match the rule are added on a list on the peer NIs matching the rule\.
467 When selecting the peer NI, the one with the local NID being used on its list is preferred\.
470 \-\-dst: NID in NID-range syntax (e.g. 10.1.1.1@tcp)
473 \-\-src: NID in NID-range syntax (e.g. 10.1.1.2@tcp)
476 \-\-<idx>: The index of where to insert the rule\. By default append to the end of the list
481 Adding a Peer Router udsp.
484 The router NIDs matching the rule are added on a list on the peer NIs matching the rule\.
485 When sending to a remote peer, the router which has its nid on the peer NI list is preferred\.
488 \-\-dst: peer NID in NID-range syntax (e.g. 10.1.1.1@tcp)
491 \-\-rte: router NID in NID-range syntax (e.g. 10.1.2.1@tcp)
494 \-\-<idx>: The index of where to insert the rule\. By default append to the end of the list
499 \fBlnetctl udsp\fR del
500 Delete user-defined selection policy.
503 \-\-idx: The index of the rule to delete\.
507 \fBlnetctl udsp\fR show
508 Show all user-defined selection policies in the system\. The policies are dumped in YAML form\.
513 \fBlnetctl debug\fR recovery
514 List NIDs on recovery queue
517 \-\-local : list NIDs on local recovery queue
520 \-\-peer : list NIDs on peer recovery queue
525 \fBlnetctl debug\fR peer
526 Dump peer debug info to debug log and console
536 Output a list of the commands supported by the lnetctl utility
539 .SS "Initializing LNet after load"
542 lnetctl lnet configure
545 lnetctl lnet configure \-\-all
549 .SS "Shutting down LNet"
552 lnetctl lnet unconfigure
559 lnetctl net add \-\-net tcp0 \-\-if eth0
562 lnetctl net add \-\-ip2net "tcp0(eth0) 192\.168\.0\.[2,4]; tcp0 192\.168\.0\.*;
563 o2ib0 132\.6\.[1\-3]\.[2\-8/2]"
570 lnetctl net del \-\-net tcp0
577 lnetctl net show \-\-verbose:
599 peer_buffer_credits: 0
605 \- nid: 192\.168\.205\.130@tcp1
629 peer_buffer_credits: 0
639 lnetctl route add \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1 \-\-hop 1
647 lnetctl route del \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1
654 lnetctl route show \-\-verbose
665 gateway: 192\.168\.205\.131@tcp1
671 priority: 0 state: down
736 .SS "Setting variables"
739 lnetctl set tiny_buffers 2048
742 lnetctl set small_buffers 16384
745 lnetctl set large_buffers 256
748 lnetctl set routing 1
752 .SS "Importing YAML files for configuring"
755 lnetctl import lnet\.conf
758 lnetctl import < lnet\.conf
762 .SS "Exporting LNet Configuration"
765 lnetctl export lnet\.conf
768 lnetctl export > lnet\.conf
772 .SS "Showing LNet Stats"
817 .SS "Showing peer information"
828 \- primary nid: 10\.148\.0\.8@o2ib
837 \- nid: 10\.148\.0\.8@o2ib
843 \- primary nid: 10\.148\.0\.20@o2ib
852 \- nid: 10\.148\.0\.20@o2ib
858 \- nid: 10\.148\.0\.25@o2ib
868 lnetctl udsp add \-\-src tcp \-\-priority 1
874 .SS "Deleting a UDSP"
877 lnetctl udsp del \-\-idx 0