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