2 .TH lnetctl 1 "2014 Sep 12" Lustre "configuration utilities"
8 \fBlnetctl\fR \fB<cmd> <subcmd> [optional parameters]\fR
11 \fBlnetctl\fR is used to configure LNet parameters allowing various configuration
12 and debugging features to be accessed\.
15 \fBlnetctl\fR can be invoked in interactive mode by issuing lnetctl command\.
16 After that, commands are issued as below\.
19 To get a complete listing of available commands, type \fBhelp\fR at the
20 lnetctl prompt\. To get basic help on the meaning and syntax of a command
21 type \fB<command>\fR \-\-help\.
24 For non\-interactive use the \fBlnetctl\fR utility can be invoked from the
25 command line as follows:
28 lnetctl \fIcommand\fR \fIsubcommand\fR [optional parameters]
30 .SS "LNet Initialization:"
33 \fBlnetctl lnet\fR configure [\-\-all]
34 Brings up the LNet Network Interface (NI) system\. If the \-\-all option is
35 provided it will load network interfaces defined in the modprobe files\.
36 Otherwise, it doesn\'t initialize any networks by default\.
39 \fBlnetctl lnet\fR unconfigure
40 Brings down the LNet Network Interface (NI) system including any configured
43 .SS "Network Configuration"
47 Configures a network interface either given the network name and physical
48 interface device name, or given the ip2net parameter\. Other parameters
52 \-\-net: net name (e.g. tcp0)
55 \-\-if: physical interface (e.g. eth0)
58 \-\-ip2net: specify networks based on IP address patterns
61 \-\-peer\-timeout: time to wait before declaring a peer dead (in seconds).
62 Default value for o2iblnd and socklnd is 180 seconds.
65 \-\-peer\-credits: define the max number of in\-flight messages per peer.
68 \-\-peer\-buffer\-credits: the max number of routed in\-flight messages
72 \-\-credits: The total number of in\-flight messages over a network interface.
75 \-\-cpt: The CPU partitions on which the created network interface is bound to.
76 Refer to the Lustre Manual Section "Binding Network Interface Against CPU
77 Partitions" for more details. For example to bind a Network Interface to
78 CPU partitions 0 and 1, you would specify this parameter as \-\-cpt [0,
86 Delete a network interface given the network name\.
89 \-\-net: net name (e.g. tcp0)
95 \fBlnetctl net\fR show
96 Show all currently configured network interfaces if no parameters given or filter
97 on the network name\. More details can be shown by specifying the \-\-verbose
101 \-\-net: net name (e.g. tcp0) to filter on
104 \-\-verbose: display detailed output per network
106 .SS "Route Configuration"
109 \fBlnetctl route\fR add
113 \-\-net: net name (e.g. tcp0)
116 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
119 \-\-hop: number to final destination (1 < hops < 255)
122 \-\-priority: priority of route (0 \- highest prio)
128 \fBlnetctl route\fR del
129 Delete a route specified via the network and gateway\.
132 \-\-net: net name (e.g. tcp0)
135 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
141 \fBlnetctl route\fR show
142 Show all currently configured routes if no parameters given, or filter on
143 given parameters\. More details can be shown by specifying the \-\-verbose
147 \-\-net: net name (e.g. tcp0) to filter on
150 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp) to filter on
153 \-\-hop: number to final destination (1 < hops < 255) to filter on
156 \-\-priority: priority of route (0 \- highest prio to filter on)
159 \-\-verbose: display detailed output per route
164 .SS "Routing Information"
167 \fBlnetctl routing\fR show
168 Show router buffers values as well as show the status of routing (IE: whether
169 the node is set to be a router)
172 Individual values can be set using the \fBlnetctl set\fR command\.
175 \fBlnetctl set\fR tiny_buffers \fIvalue\fR
176 Set the number of tiny buffers in the system\. This is the total number of tiny
177 buffers for all CPU partitions\.
180 \fBlnetctl set\fR small_buffers \fIvalue\fR
181 Set the number of small buffers in the system\. This is the total number of
182 small buffers for all CPU partitions\.
185 \fBlnetctl set\fR large_buffers \fIvalue\fR
186 Set the number of large buffers in the system\. This is the total number of
187 large buffers for all CPU partitions\.
190 \fBlnetctl set\fR routing \fI[0, 1]\fR
191 0 value indicates to disable routing\. 1 value indicates to enable routing\.
192 When routing is disabled the values of the buffers that might have been changed
193 are not remembered, and the next time routing is enabled the default buffer
196 .SS "Import and Export YAML Configuration Files"
197 LNet configuration can be represented in YAML format\. A YAML configuration
198 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
199 lnetctl utility will attempt to configure all elements defined in the YAML
203 Similarly the \fBexport\fR command can be used to dump all supported LNet
204 configuration to stdout\. The output can be redirected to a file\.
207 \fBlnetctl import\fR \fIFILE\fR:
211 \fBlnetctl import\fR < \fIFILE\fR
212 \fBimport\fR command uses the specified YAML configuration file to configure
213 LNet parameters defined within\. The import command by default adds the LNet
214 parameters defined in the YAML file, but this default behavior can be
215 overwritten by specifying the desired behavior\.
218 \-\-add: add configuration
221 \-\-del: delete configuration
224 \-\-show: show configuration
227 \-\-help: display this help
230 \fBlnetctl export\fR \fIFILE\fR:
234 \fBlnetctl export\fR > \fIFILE\fR
235 \fBexport\fR command dumps the supported LNet configuration in YAML format to
236 stdout, which can be redirected to a normal file\. The output of the
237 \fBimport\fR command can be used as input to the \fBexport\fR command\.
240 \-\-help: display this help
242 .SS "LNet Statistics"
249 \-> Number of messages allocated
252 \-> Maximum number of messages allocated
255 \-> Number of errors encountered
258 \-> Number of messages sent
261 \-> Number of messages received
264 \-> Number of messages routed
267 \-> Total size in bytes of messages sent
270 \-> Total size in bytes of messages received
273 \-> Total size in bytes of messages routed
276 \-> Total size in bytes of messages dropped
281 .SS "Showing Peer Credits"
284 \fBlnetctl peer_credits\fR
285 Show details on configured peer credits
294 \-> Reference count on the peer
297 \-> Maximum transmit credits
300 \-> Available transmit credits
303 \-> Available router credits
306 \-> Minimum router credits\.
310 .SS "Initializing LNet after load"
313 lnetctl lnet configure
316 lnetctl lnet configure \-\-all
320 .SS "Shutting down LNet"
323 lnetctl lnet unconfigure
330 lnetctl net add \-\-net tcp0 \-\-if eth0
333 lnetctl net add \-\-ip2net "tcp0(eth0) 192\.168\.0\.[2,4]; tcp0 192\.168\.0\.*;
334 o2ib0 132\.6\.[1\-3]\.[2\-8/2]"
341 lnetctl net del \-\-net tcp0
348 lnetctl net show \-\-verbose:
370 peer_buffer_credits: 0
376 \- nid: 192\.168\.205\.130@tcp1
400 peer_buffer_credits: 0
410 lnetctl route add \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1 \-\-hop 1
418 lnetctl route del \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1
425 lnetctl route show \-\-verbose
436 gateway: 192\.168\.205\.131@tcp1
442 priority: 0 state: down
507 .SS "Setting variables"
510 lnetctl set tiny_buffers 2048
513 lnetctl set small_buffers 16384
516 lnetctl set large_buffers 256
519 lnetctl set routing 1
523 .SS "Importing YAML files for configuring"
526 lnetctl import lnet\.conf
529 lnetctl import < lnet\.conf
533 .SS "Exporting LNet Configuration"
536 lnetctl export lnet\.conf
539 lnetctl export > lnet\.conf
543 .SS "Showing LNet Stats"
588 .SS "Showing peer credits information"
591 lnetctl peer_credits show
599 \- nid: 192\.168\.205\.131@tcp1
611 available_tx_credits: 8
614 available_rtr_credits: 8