lustre/doc/lnetctl.8

   1 .
   2 .TH lnetctl 8 "2017 Jan 12" Lustre "configuration utilities"
   3 .
   4 .SH "SYNOPSIS"
   5 \fBlnetctl\fR
   6 .
   7 .br
   8 .B lnetctl --list-commands
   9 .br
  10 \fBlnetctl\fR \fB<cmd> <subcmd> [optional parameters]\fR
  11 .
  12 .br
  13 .SH "DESCRIPTION"
  14 \fBlnetctl\fR is used to configure LNet parameters allowing various configuration
  15 and debugging features to be accessed\.
  16 .
  17 .P
  18 \fBlnetctl\fR can be invoked in interactive mode by issuing lnetctl command\.
  19 After that, commands are issued as below\.
  20 .
  21 .P
  22 To get a complete listing of available commands, type
  23 .B --list-commands
  24 at the lnetctl prompt\. To get basic help on the meaning and syntax of a command
  25 type \fB<command>\fR \-\-help\.
  26 .
  27 .P
  28 For non\-interactive use the \fBlnetctl\fR utility can be invoked from the
  29 command line as follows:
  30 .
  31 .P
  32 lnetctl \fIcommand\fR \fIsubcommand\fR [optional parameters]
  33 .
  34 .SS "LNet Initialization:"
  35 .
  36 .TP
  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\.
  41 .
  42 .TP
  43 \fBlnetctl lnet\fR unconfigure
  44 Brings down the LNet Network Interface (NI) system including any configured
  45 networks\.
  46 .
  47 .SS "Network Configuration"
  48 .
  49 .TP
  50 \fBlnetctl net\fR add
  51 Configures a network interface either given the network name and physical
  52 interface device name, or given the ip2net parameter\. Other parameters
  53 are optional\.
  54 .
  55 .br
  56 \-\-net: net name (e.g. tcp0)
  57 .
  58 .br
  59 \-\-if: physical interface (e.g. eth0)
  60 .
  61 .br
  62 \-\-ip2net: specify networks based on IP address patterns
  63 .
  64 .br
  65 \-\-peer\-timeout: time to wait before declaring a peer dead (in seconds).
  66 Default value for o2iblnd and socklnd is 180 seconds.
  67 .
  68 .br
  69 \-\-peer\-credits: define the max number of in\-flight messages per peer.
  70 .
  71 .br
  72 \-\-peer\-buffer\-credits: the max number of routed in\-flight messages
  73 per peer.
  74 .
  75 .br
  76 \-\-credits: The total number of in\-flight messages over a network interface.
  77 .
  78 .br
  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,
  83 1]
  84 .
  85 .br
  86
  87 .
  88 .TP
  89 \fBlnetctl net\fR del
  90 Delete a network interface given the network name\.
  91 .
  92 .br
  93 \-\-net: net name (e.g. tcp0)
  94 .
  95 .br
  96
  97 .
  98 .TP
  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
 102 parameter\.
 103 .
 104 .br
 105 \-\-net: net name (e.g. tcp0) to filter on
 106 .
 107 .br
 108 \-\-verbose: display detailed output per network
 109
 110 .
 111 .SS "Peer Configuration"
 112 .TP
 113 \fBlnetctl peer\fR add
 114 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.
 115 .
 116 .br
 117 .
 118 \-\-nid: one or more peer NIDs to add to the peer\.
 119 .
 120 .br
 121 .
 122 \-\-prim_nid: Primary NID of the peer\.
 123 .
 124 .br
 125 \-\-non_mr: create this peer as not Multi-Rail capable\.
 126 .
 127 .br
 128
 129 .TP
 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.
 132 .
 133 .br
 134 .
 135 \-\-nid: one or more peer NIDs to remove from the peer\.
 136 .
 137 .br
 138 .
 139 \-\-prim_nid: Primary NID of the peer\.
 140 .
 141 .br
 142
 143 .TP
 144 \fBlnetctl peer\fR show
 145 Show configured peers.  By default, lists all peers and associated NIDs.
 146 .
 147 .br
 148 .
 149 \-\-nid: list of primary nids to filter on
 150 .
 151 .br
 152 .
 153 \-\-verbose: Include extended statistics, including credits and counters.
 154 .
 155 .br
 156
 157 .
 158 .SS "Route Configuration"
 159 .
 160 .TP
 161 \fBlnetctl route\fR add
 162 Add a route\.
 163 .
 164 .br
 165 \-\-net: net name (e.g. tcp0)
 166 .
 167 .br
 168 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
 169 .
 170 .br
 171 \-\-hop: number to final destination (1 < hops < 255)
 172 .
 173 .br
 174 \-\-priority: priority of route (0 \- highest prio)
 175 .
 176 .br
 177
 178 .
 179 .TP
 180 \fBlnetctl route\fR del
 181 Delete a route specified via the network and gateway\.
 182 .
 183 .br
 184 \-\-net: net name (e.g. tcp0)
 185 .
 186 .br
 187 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp)
 188 .
 189 .br
 190
 191 .
 192 .TP
 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
 196 parameter\.
 197 .
 198 .br
 199 \-\-net: net name (e.g. tcp0) to filter on
 200 .
 201 .br
 202 \-\-gateway: gateway nid (e.g. 10\.1\.1\.2@tcp) to filter on
 203 .
 204 .br
 205 \-\-hop: number to final destination (1 < hops < 255) to filter on
 206 .
 207 .br
 208 \-\-priority: priority of route (0 \- highest prio to filter on)
 209 .
 210 .br
 211 \-\-verbose: display detailed output per route
 212 .
 213 .br
 214
 215 .
 216 .SS "Routing Information"
 217 .
 218 .TP
 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)
 222 .
 223 .SS "Value Setting"
 224 Individual values can be set using the \fBlnetctl set\fR command\.
 225 .
 226 .TP
 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\.
 230 .
 231 .TP
 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\.
 235 .
 236 .TP
 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\.
 240 .
 241 .TP
 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
 246 count will be used\.
 247 .
 248 .SS "Import and Export YAML Configuration Files"
 249 LNet configuration can be represented in YAML format\. A YAML configuration
 250 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
 251 lnetctl utility will attempt to configure all elements defined in the YAML
 252 file\.
 253 .
 254 .P
 255 Similarly the \fBexport\fR command can be used to dump all supported LNet
 256 configuration to stdout\. The output can be redirected to a file\.
 257 .
 258 .TP
 259 \fBlnetctl import\fR \fIFILE\fR:
 260
 261 .
 262 .TP
 263 \fBlnetctl import\fR < \fIFILE\fR
 264 \fBimport\fR command uses the specified YAML configuration file to configure
 265 LNet parameters defined within\. The import command by default adds the LNet
 266 parameters defined in the YAML file, but this default behavior can be
 267 overwritten by specifying the desired behavior\.
 268 .
 269 .br
 270 \-\-add: add configuration
 271 .
 272 .br
 273 \-\-del: delete configuration
 274 .
 275 .br
 276 \-\-show: show configuration
 277 .
 278 .br
 279 \-\-help: display this help
 280 .
 281 .TP
 282 \fBlnetctl export\fR \fIFILE\fR:
 283
 284 .
 285 .TP
 286 \fBlnetctl export\fR > \fIFILE\fR
 287 \fBexport\fR command dumps the supported LNet configuration in YAML format to
 288 stdout, which can be redirected to a normal file\. The output of the
 289 \fBimport\fR command can be used as input to the \fBexport\fR command\.
 290 .
 291 .br
 292 \-\-help: display this help
 293 .
 294 .SS "LNet Statistics"
 295 .
 296 .TP
 297 \fBlnetctl stats\fR
 298 Show LNET statistics
 299 .
 300 .br
 301 \-> Number of messages allocated
 302 .
 303 .br
 304 \-> Maximum number of messages allocated
 305 .
 306 .br
 307 \-> Number of errors encountered
 308 .
 309 .br
 310 \-> Number of messages sent
 311 .
 312 .br
 313 \-> Number of messages received
 314 .
 315 .br
 316 \-> Number of messages routed
 317 .
 318 .br
 319 \-> Total size in bytes of messages sent
 320 .
 321 .br
 322 \-> Total size in bytes of messages received
 323 .
 324 .br
 325 \-> Total size in bytes of messages routed
 326 .
 327 .br
 328 \-> Total size in bytes of messages dropped
 329 .
 330 .br
 331
 332 .
 333 .SS "Showing Peer Credits"
 334 .
 335 .TP
 336 \fBlnetctl peer_credits\fR
 337 Show details on configured peer credits
 338 .
 339 .br
 340 \-> Peer nid
 341 .
 342 .br
 343 \-> State
 344 .
 345 .br
 346 \-> Reference count on the peer
 347 .
 348 .br
 349 \-> Maximum transmit credits
 350 .
 351 .br
 352 \-> Available transmit credits
 353 .
 354 .br
 355 \-> Available router credits
 356 .
 357 .br
 358 \-> Minimum router credits\.
 359 .
 360 .SH "OPTIONS"
 361 .TP
 362 .B --list-commands
 363 Output a list of the commands supported by the lnetctl utility
 364 .SH "EXAMPLES"
 365 .
 366 .SS "Initializing LNet after load"
 367 .
 368 .IP "\(bu" 4
 369 lnetctl lnet configure
 370 .
 371 .IP "\(bu" 4
 372 lnetctl lnet configure \-\-all
 373 .
 374 .IP "" 0
 375 .
 376 .SS "Shutting down LNet"
 377 .
 378 .IP "\(bu" 4
 379 lnetctl lnet unconfigure
 380 .
 381 .IP "" 0
 382 .
 383 .SS "Add network"
 384 .
 385 .IP "\(bu" 4
 386 lnetctl net add \-\-net tcp0 \-\-if eth0
 387 .
 388 .IP "\(bu" 4
 389 lnetctl net add \-\-ip2net "tcp0(eth0) 192\.168\.0\.[2,4]; tcp0 192\.168\.0\.*;
 390 o2ib0 132\.6\.[1\-3]\.[2\-8/2]"
 391 .
 392 .IP "" 0
 393 .
 394 .SS "Delete network"
 395 .
 396 .IP "\(bu" 4
 397 lnetctl net del \-\-net tcp0
 398 .
 399 .IP "" 0
 400 .
 401 .SS "Show network"
 402 .
 403 .TP
 404 lnetctl net show \-\-verbose:
 405
 406 .
 407 .P
 408 net:
 409 .
 410 .br
 411         \- nid: 0@lo
 412 .
 413 .br
 414           status: up
 415 .
 416 .br
 417           tunables:
 418 .
 419 .br
 420                 peer_timeout: 0
 421 .
 422 .br
 423                 peer_credits: 0
 424 .
 425 .br
 426                 peer_buffer_credits: 0
 427 .
 428 .br
 429                 credits: 0
 430 .
 431 .br
 432         \- nid: 192\.168\.205\.130@tcp1
 433 .
 434 .br
 435           status: up
 436 .
 437 .br
 438           interfaces:
 439 .
 440 .br
 441                 0: eth3
 442 .
 443 .br
 444                 1: eth4
 445 .
 446 .br
 447           tunables:
 448 .
 449 .br
 450                 peer_timeout: 180
 451 .
 452 .br
 453                 peer_credits: 8
 454 .
 455 .br
 456                 peer_buffer_credits: 0
 457 .
 458 .br
 459                 credits: 256
 460 .
 461 .br
 462 .
 463 .SS "Add route"
 464 .
 465 .IP "\(bu" 4
 466 lnetctl route add \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1 \-\-hop 1
 467 \-\-priority 1
 468 .
 469 .IP "" 0
 470 .
 471 .SS "Delete route"
 472 .
 473 .IP "\(bu" 4
 474 lnetctl route del \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1
 475 .
 476 .IP "" 0
 477 .
 478 .SS "Show route"
 479 .
 480 .IP "\(bu" 4
 481 lnetctl route show \-\-verbose
 482 .
 483 .IP "" 0
 484 .
 485 .P
 486 route:
 487 .
 488 .br
 489         \- net: tcp
 490 .
 491 .br
 492           gateway: 192\.168\.205\.131@tcp1
 493 .
 494 .br
 495           hop: 1
 496 .
 497 .br
 498           priority: 0 state: down
 499 .
 500 .br
 501 .
 502 .SS "Show routing"
 503 .
 504 .IP "\(bu" 4
 505 lnetctl routing show
 506 .
 507 .IP "" 0
 508 .
 509 .P
 510 routing:
 511 .
 512 .br
 513         \- cpt[0]:
 514 .
 515 .br
 516           tiny:
 517 .
 518 .br
 519                 npages: 0
 520 .
 521 .br
 522                 nbuffers: 2048
 523 .
 524 .br
 525                 credits: 2048
 526 .
 527 .br
 528                 mincredits: 2048
 529 .
 530 .br
 531           small:
 532 .
 533 .br
 534                 npages: 1
 535 .
 536 .br
 537                 nbuffers: 16384
 538 .
 539 .br
 540                 credits: 16384
 541 .
 542 .br
 543                 mincredits: 16384
 544 .
 545 .br
 546           large:
 547 .
 548 .br
 549                 npages: 256
 550 .
 551 .br
 552                 nbuffers: 1024
 553 .
 554 .br
 555                 credits: 1024
 556 .
 557 .br
 558                 mincredits: 1024
 559 .
 560 .br
 561         \- enable: 1
 562 .
 563 .SS "Setting variables"
 564 .
 565 .IP "\(bu" 4
 566 lnetctl set tiny_buffers 2048
 567 .
 568 .IP "\(bu" 4
 569 lnetctl set small_buffers 16384
 570 .
 571 .IP "\(bu" 4
 572 lnetctl set large_buffers 256
 573 .
 574 .IP "\(bu" 4
 575 lnetctl set routing 1
 576 .
 577 .IP "" 0
 578 .
 579 .SS "Importing YAML files for configuring"
 580 .
 581 .IP "\(bu" 4
 582 lnetctl import lnet\.conf
 583 .
 584 .IP "\(bu" 4
 585 lnetctl import < lnet\.conf
 586 .
 587 .IP "" 0
 588 .
 589 .SS "Exporting LNet Configuration"
 590 .
 591 .IP "\(bu" 4
 592 lnetctl export lnet\.conf
 593 .
 594 .IP "\(bu" 4
 595 lnetctl export > lnet\.conf
 596 .
 597 .IP "" 0
 598 .
 599 .SS "Showing LNet Stats"
 600 .
 601 .IP "\(bu" 4
 602 lnetctl stats show
 603 .
 604 .IP "" 0
 605 .
 606 .P
 607 statistics:
 608 .
 609 .br
 610         msgs_alloc: 0
 611 .
 612 .br
 613         msgs_max: 1
 614 .
 615 .br
 616         errors: 0
 617 .
 618 .br
 619         send_count: 89
 620 .
 621 .br
 622         recv_count: 0
 623 .
 624 .br
 625         route_count: 0
 626 .
 627 .br
 628         drop_count: 19
 629 .
 630 .br
 631         send_length: 0
 632 .
 633 .br
 634         recv_length: 0
 635 .
 636 .br
 637         route_length: 0
 638 .
 639 .br
 640         drop_length: 0
 641 .
 642 .br
 643 .
 644 .SS "Showing peer information"
 645 .
 646 .IP "\(bu" 4
 647 lnetctl peer show
 648 .
 649 .IP "" 0
 650 .
 651 .P
 652 peer:
 653 .
 654 .br
 655     \- primary nid: 10\.148\.0\.8@o2ib
 656 .
 657 .br
 658       Multi\-Rail: True
 659 .
 660 .br
 661       peer ni:
 662 .
 663 .br
 664         \- nid: 10\.148\.0\.8@o2ib
 665 .
 666 .br
 667           state: NA
 668 .
 669 .br
 670     \- primary nid: 10\.148\.0\.20@o2ib
 671 .
 672 .br
 673       Multi\-Rail: True
 674 .
 675 .br
 676       peer ni:
 677 .
 678 .br
 679         \- nid: 10\.148\.0\.20@o2ib
 680 .
 681 .br
 682           state: NA
 683 .
 684 .br
 685         \- nid: 10\.148\.0\.25@o2ib
 686 .
 687 .br
 688           state: NA
 689 .
 690 .br
 691
 692 .SH SEE ALSO
 693 .BR lustre (7)
 694