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\.  The primary NID must be specified.  By default, peers are marked as multi-rail capable\.
 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 .TP
 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\.
 253 .
 254 .TP
 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\.
 263 .
 264 .SS "Import and Export YAML Configuration Files"
 265 LNet configuration can be represented in YAML format\. A YAML configuration
 266 file can be passed to the lnetctl utility via the \fBimport\fR command\. The
 267 lnetctl utility will attempt to configure all elements defined in the YAML
 268 file\.
 269 .
 270 .P
 271 Similarly the \fBexport\fR command can be used to dump all supported LNet
 272 configuration to stdout\. The output can be redirected to a file\.
 273 .
 274 .TP
 275 \fBlnetctl import\fR \fIFILE\fR:
 276
 277 .
 278 .TP
 279 \fBlnetctl import\fR < \fIFILE\fR
 280 \fBimport\fR command uses the specified YAML configuration file to configure
 281 LNet parameters defined within\. The import command by default adds the LNet
 282 parameters defined in the YAML file, but this default behavior can be
 283 overwritten by specifying the desired behavior\.
 284 .
 285 .br
 286 \-\-add: add configuration
 287 .
 288 .br
 289 \-\-del: delete configuration
 290 .
 291 .br
 292 \-\-show: show configuration
 293 .
 294 .br
 295 \-\-help: display this help
 296 .
 297 .TP
 298 \fBlnetctl export\fR \fIFILE\fR:
 299
 300 .
 301 .TP
 302 \fBlnetctl export\fR > \fIFILE\fR
 303 \fBexport\fR command dumps the supported LNet configuration in YAML format to
 304 stdout, which can be redirected to a normal file\. The output of the
 305 \fBimport\fR command can be used as input to the \fBexport\fR command\.
 306 .
 307 .br
 308 \-\-help: display this help
 309 .
 310 .SS "LNet Statistics"
 311 .
 312 .TP
 313 \fBlnetctl stats\fR
 314 Show LNET statistics
 315 .
 316 .br
 317 \-> Number of messages allocated
 318 .
 319 .br
 320 \-> Maximum number of messages allocated
 321 .
 322 .br
 323 \-> Number of errors encountered
 324 .
 325 .br
 326 \-> Number of messages sent
 327 .
 328 .br
 329 \-> Number of messages received
 330 .
 331 .br
 332 \-> Number of messages routed
 333 .
 334 .br
 335 \-> Total size in bytes of messages sent
 336 .
 337 .br
 338 \-> Total size in bytes of messages received
 339 .
 340 .br
 341 \-> Total size in bytes of messages routed
 342 .
 343 .br
 344 \-> Total size in bytes of messages dropped
 345 .
 346 .br
 347
 348 .
 349 .SS "Showing Peer Credits"
 350 .
 351 .TP
 352 \fBlnetctl peer_credits\fR
 353 Show details on configured peer credits
 354 .
 355 .br
 356 \-> Peer nid
 357 .
 358 .br
 359 \-> State
 360 .
 361 .br
 362 \-> Reference count on the peer
 363 .
 364 .br
 365 \-> Maximum transmit credits
 366 .
 367 .br
 368 \-> Available transmit credits
 369 .
 370 .br
 371 \-> Available router credits
 372 .
 373 .br
 374 \-> Minimum router credits\.
 375 .
 376 .SH "OPTIONS"
 377 .TP
 378 .B --list-commands
 379 Output a list of the commands supported by the lnetctl utility
 380 .SH "EXAMPLES"
 381 .
 382 .SS "Initializing LNet after load"
 383 .
 384 .IP "\(bu" 4
 385 lnetctl lnet configure
 386 .
 387 .IP "\(bu" 4
 388 lnetctl lnet configure \-\-all
 389 .
 390 .IP "" 0
 391 .
 392 .SS "Shutting down LNet"
 393 .
 394 .IP "\(bu" 4
 395 lnetctl lnet unconfigure
 396 .
 397 .IP "" 0
 398 .
 399 .SS "Add network"
 400 .
 401 .IP "\(bu" 4
 402 lnetctl net add \-\-net tcp0 \-\-if eth0
 403 .
 404 .IP "\(bu" 4
 405 lnetctl net add \-\-ip2net "tcp0(eth0) 192\.168\.0\.[2,4]; tcp0 192\.168\.0\.*;
 406 o2ib0 132\.6\.[1\-3]\.[2\-8/2]"
 407 .
 408 .IP "" 0
 409 .
 410 .SS "Delete network"
 411 .
 412 .IP "\(bu" 4
 413 lnetctl net del \-\-net tcp0
 414 .
 415 .IP "" 0
 416 .
 417 .SS "Show network"
 418 .
 419 .TP
 420 lnetctl net show \-\-verbose:
 421
 422 .
 423 .P
 424 net:
 425 .
 426 .br
 427         \- nid: 0@lo
 428 .
 429 .br
 430           status: up
 431 .
 432 .br
 433           tunables:
 434 .
 435 .br
 436                 peer_timeout: 0
 437 .
 438 .br
 439                 peer_credits: 0
 440 .
 441 .br
 442                 peer_buffer_credits: 0
 443 .
 444 .br
 445                 credits: 0
 446 .
 447 .br
 448         \- nid: 192\.168\.205\.130@tcp1
 449 .
 450 .br
 451           status: up
 452 .
 453 .br
 454           interfaces:
 455 .
 456 .br
 457                 0: eth3
 458 .
 459 .br
 460                 1: eth4
 461 .
 462 .br
 463           tunables:
 464 .
 465 .br
 466                 peer_timeout: 180
 467 .
 468 .br
 469                 peer_credits: 8
 470 .
 471 .br
 472                 peer_buffer_credits: 0
 473 .
 474 .br
 475                 credits: 256
 476 .
 477 .br
 478 .
 479 .SS "Add route"
 480 .
 481 .IP "\(bu" 4
 482 lnetctl route add \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1 \-\-hop 1
 483 \-\-priority 1
 484 .
 485 .IP "" 0
 486 .
 487 .SS "Delete route"
 488 .
 489 .IP "\(bu" 4
 490 lnetctl route del \-\-net tcp0 \-\-gateway 10\.10\.10\.1@tcp1
 491 .
 492 .IP "" 0
 493 .
 494 .SS "Show route"
 495 .
 496 .IP "\(bu" 4
 497 lnetctl route show \-\-verbose
 498 .
 499 .IP "" 0
 500 .
 501 .P
 502 route:
 503 .
 504 .br
 505         \- net: tcp
 506 .
 507 .br
 508           gateway: 192\.168\.205\.131@tcp1
 509 .
 510 .br
 511           hop: 1
 512 .
 513 .br
 514           priority: 0 state: down
 515 .
 516 .br
 517 .
 518 .SS "Show routing"
 519 .
 520 .IP "\(bu" 4
 521 lnetctl routing show
 522 .
 523 .IP "" 0
 524 .
 525 .P
 526 routing:
 527 .
 528 .br
 529         \- cpt[0]:
 530 .
 531 .br
 532           tiny:
 533 .
 534 .br
 535                 npages: 0
 536 .
 537 .br
 538                 nbuffers: 2048
 539 .
 540 .br
 541                 credits: 2048
 542 .
 543 .br
 544                 mincredits: 2048
 545 .
 546 .br
 547           small:
 548 .
 549 .br
 550                 npages: 1
 551 .
 552 .br
 553                 nbuffers: 16384
 554 .
 555 .br
 556                 credits: 16384
 557 .
 558 .br
 559                 mincredits: 16384
 560 .
 561 .br
 562           large:
 563 .
 564 .br
 565                 npages: 256
 566 .
 567 .br
 568                 nbuffers: 1024
 569 .
 570 .br
 571                 credits: 1024
 572 .
 573 .br
 574                 mincredits: 1024
 575 .
 576 .br
 577         \- enable: 1
 578 .
 579 .SS "Setting variables"
 580 .
 581 .IP "\(bu" 4
 582 lnetctl set tiny_buffers 2048
 583 .
 584 .IP "\(bu" 4
 585 lnetctl set small_buffers 16384
 586 .
 587 .IP "\(bu" 4
 588 lnetctl set large_buffers 256
 589 .
 590 .IP "\(bu" 4
 591 lnetctl set routing 1
 592 .
 593 .IP "" 0
 594 .
 595 .SS "Importing YAML files for configuring"
 596 .
 597 .IP "\(bu" 4
 598 lnetctl import lnet\.conf
 599 .
 600 .IP "\(bu" 4
 601 lnetctl import < lnet\.conf
 602 .
 603 .IP "" 0
 604 .
 605 .SS "Exporting LNet Configuration"
 606 .
 607 .IP "\(bu" 4
 608 lnetctl export lnet\.conf
 609 .
 610 .IP "\(bu" 4
 611 lnetctl export > lnet\.conf
 612 .
 613 .IP "" 0
 614 .
 615 .SS "Showing LNet Stats"
 616 .
 617 .IP "\(bu" 4
 618 lnetctl stats show
 619 .
 620 .IP "" 0
 621 .
 622 .P
 623 statistics:
 624 .
 625 .br
 626         msgs_alloc: 0
 627 .
 628 .br
 629         msgs_max: 1
 630 .
 631 .br
 632         errors: 0
 633 .
 634 .br
 635         send_count: 89
 636 .
 637 .br
 638         recv_count: 0
 639 .
 640 .br
 641         route_count: 0
 642 .
 643 .br
 644         drop_count: 19
 645 .
 646 .br
 647         send_length: 0
 648 .
 649 .br
 650         recv_length: 0
 651 .
 652 .br
 653         route_length: 0
 654 .
 655 .br
 656         drop_length: 0
 657 .
 658 .br
 659 .
 660 .SS "Showing peer information"
 661 .
 662 .IP "\(bu" 4
 663 lnetctl peer show
 664 .
 665 .IP "" 0
 666 .
 667 .P
 668 peer:
 669 .
 670 .br
 671     \- primary nid: 10\.148\.0\.8@o2ib
 672 .
 673 .br
 674       Multi\-Rail: True
 675 .
 676 .br
 677       peer ni:
 678 .
 679 .br
 680         \- nid: 10\.148\.0\.8@o2ib
 681 .
 682 .br
 683           state: NA
 684 .
 685 .br
 686     \- primary nid: 10\.148\.0\.20@o2ib
 687 .
 688 .br
 689       Multi\-Rail: True
 690 .
 691 .br
 692       peer ni:
 693 .
 694 .br
 695         \- nid: 10\.148\.0\.20@o2ib
 696 .
 697 .br
 698           state: NA
 699 .
 700 .br
 701         \- nid: 10\.148\.0\.25@o2ib
 702 .
 703 .br
 704           state: NA
 705 .
 706 .br
 707
 708 .SH SEE ALSO
 709 .BR lustre (7)
 710