lustre/doc/lctl.8

   1 .TH lctl 8 "2017 Jan 12" Lustre "configuration utilities"
   2 .SH NAME
   3 lctl \- Low level Lustre filesystem configuration utility
   4 .SH SYNOPSIS
   5 .br
   6 .B lctl
   7 .br
   8 .B lctl --device <devno> <command [args]>
   9 .br
  10 .B lctl --version
  11 .br
  12 .B lctl --list-commands
  13 .br
  14 .SH DESCRIPTION
  15 .B lctl
  16 is used to directly control Lustre via an ioctl interface, allowing
  17 various configuration, maintenance, and debugging features to be accessed.
  18
  19 .B lctl
  20 can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are
  21 .BR dl ,
  22 .BR dk ,
  23 .BR device ,
  24 .B network
  25 .IR <up/down> ,
  26 .BR list_nids ,
  27 .B ping
  28 .IR nid ,
  29 .BR help ,
  30 .BR quit .
  31
  32 To get a complete listing of available commands, type
  33 .B --list-commands
  34 at the lctl prompt.  To get basic help on the meaning and syntax of a
  35 command, type
  36 .B help
  37 .I command
  38 .  Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
  39
  40 For non-interactive use, one uses the second invocation, which runs command after connecting to the device.
  41
  42 .SS System Configuration
  43 The on-line tool set for backup or removal of Lustre system configuration. For detail, please see:
  44 .PP
  45 \fBlctl-lcfg\fR(8)
  46 .RS 4
  47
  48 .SS Network Configuration
  49 .TP
  50 .BR network " <" up / down >|< tcp / o2ib >
  51 Start or stop LNET, or select a network type for other
  52 .I lctl
  53 LNET commands
  54 .TP
  55 .BI list_nids
  56 Print all Network Identifiers on the local node. LNET must be running.
  57 .TP
  58 .BI which_nid " <nidlist>"
  59 From a list of nids for a remote node, show which interface communication
  60 will take place on.
  61 .TP
  62 .BI replace_nids " <devicename> <nid1>[,nid2,nid3 ...]"
  63 Replace the LNET Network Identifiers for a given device,
  64 as when the server's IP address has changed.
  65 This command must be run on the MGS node.
  66 Only MGS server should be started (command execution returns error
  67 in another cases). To start the MGS service only:
  68 mount -t lustre <MDT partition> -o nosvc <mount point>
  69 Note the replace_nids command skips any invalidated records in the configuration log.
  70 The previous log is backed up with the suffix '.bak'.
  71 .TP
  72 .BI ping " <nid> timeout"
  73 Check LNET connectivity via an LNET ping. This will use the fabric
  74 appropriate to the specified NID. By default lctl will attempt to
  75 reach the remote node up to 120 seconds and then timeout. To disable
  76 the timeout just specify an negative timeout value.
  77 .TP
  78 .BI interface_list
  79 Print the network interface information for a given
  80 .B network
  81 type.
  82 .TP
  83 .BI peer_list
  84 Print the known peers for a given
  85 .B network
  86 type.
  87 .TP
  88 .BI conn_list
  89 Print all the connected remote NIDs for a given
  90 .B network
  91 type.
  92 .TP
  93 .BI route_list
  94 Print the complete routing table.
  95 .PP
  96 .SS Device Selection
  97 .TP
  98 .BI device " <devname> "
  99 This will select the specified OBD device.  All other commands depend on the device being set.
 100 .TP
 101 .BI device_list
 102 Show all the local Lustre OBDs. AKA
 103 .B dl
 104 .PP
 105 .SS Device Operations
 106 .TP
 107 .BI list_param " [-F|-R] <param_search ...>"
 108 List the Lustre or LNet parameter name
 109 .B -F
 110 Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
 111 .br
 112 .B -R
 113 Recursively list all parameters under the specified parameter search string. If
 114 .I param_search
 115 is unspecified, all the parameters will be shown.
 116 .br
 117 .B Examples:
 118 .br
 119 .B
 120 # lctl list_param ost.*
 121 .br
 122   ost.OSS
 123 .br
 124   ost.num_refs
 125 .br
 126 .B
 127 # lctl list_param -F ost.* debug
 128 .br
 129   ost.OSS/
 130 .br
 131   ost.num_refs
 132 .br
 133   debug=
 134 .br
 135 .B
 136 # lctl list_param -R mdt
 137 .br
 138   mdt
 139 .br
 140   mdt.lustre-MDT0000
 141 .br
 142   mdt.lustre-MDT0000.capa
 143 .br
 144   mdt.lustre-MDT0000.capa_count
 145 .br
 146   mdt.lustre-MDT0000.capa_key_timeout
 147 .br
 148   mdt.lustre-MDT0000.capa_timeout
 149 .br
 150   mdt.lustre-MDT0000.commit_on_sharing
 151 .br
 152   mdt.lustre-MDT0000.evict_client
 153 .br
 154   ...
 155 .TP
 156 .BI get_param " [-F|-n|-N|-R] <parameter ...>"
 157 Get the value of Lustre or LNET parameter.
 158 .br
 159 .B -F
 160 When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
 161 .br
 162 .br
 163 .B -n
 164 Print only the value and not parameter name.
 165 .br
 166 .B -N
 167 Print only matched parameter names and not the values. (Especially useful when using patterns.)
 168 .br
 169 .B -R
 170 Print all of the parameter names below the specified name.
 171 .br
 172 .B Examples:
 173 .br
 174 .B
 175 # lctl get_param ost.*
 176 .br
 177   ost.OSS
 178 .br
 179   ost.num_refs
 180 .br
 181 .B
 182 # lctl get_param -n debug timeout
 183 .br
 184   super warning dlmtrace error emerg ha rpctrace vfstrace config console
 185 .br
 186   20
 187 .br
 188 .B
 189 # lctl get_param -N ost.* debug
 190 .br
 191   ost.OSS
 192 .br
 193   ost.num_refs
 194 .br
 195   debug
 196 .br
 197 lctl "get_param -NF" is equivalent to "list_param -F".
 198 .TP
 199 .BI set_param " [-n] [-P] [-d] <parameter=value ...>"
 200 Set the value of Lustre or LNET parameter.
 201 .br
 202 .B -n
 203 Disable printing of the key name when printing values.
 204 .br
 205 .B -P
 206 Set the parameter permanently, filesystem-wide.
 207 This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters.
 208 .br
 209 .B -d
 210 Remove the permanent setting (only with -P option)
 211 .br
 212 .B Examples:
 213 .br
 214 .B
 215 # lctl set_param fail_loc=0 timeout=20
 216 .br
 217   fail_loc=0
 218 .br
 219   timeout=20
 220 .br
 221 .B
 222 # lctl set_param -n fail_loc=0 timeout=20
 223 .br
 224   0
 225 .br
 226   20
 227 .br
 228 .B
 229 # lctl set_param -P osc.*.max_dirty_mb=32
 230 .br
 231 .TP
 232 .BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
 233 Set a permanent configuration parameter for any device via the MGS.  This
 234 command must be run on the MGS node.
 235 .br
 236 .B -d <device|fsname>.<parameter>
 237 Delete a parameter setting (use the default value at the next restart).  A null value for <value> also deletes the parameter setting.
 238 .br
 239 .B Parameters:
 240 .br
 241 All of the writable parameters under
 242 .B lctl list_param
 243 (e.g.
 244 .I lctl list_param -F osc.*.* | grep =
 245 ) can be permanently set using
 246 .B lctl conf_param
 247 , but the format is slightly different.  For conf_param, the device is specified first, then the obdtype. (See examples below.)  Wildcards are not supported.
 248 .br
 249 Additionally, failover nodes may be added (or removed), and some system-wide parameters may be set as well (sys.at_max, sys.at_min, sys.at_extra, sys.at_early_margin, sys.at_history, sys.timeout, sys.ldlm_timeout.)  <device> is ignored for system wide parameters.
 250 .br
 251 .B Examples:
 252 .br
 253 # lctl conf_param testfs.sys.at_max=1200
 254 .br
 255 # lctl conf_param testfs.llite.max_read_ahead_mb=16
 256 .br
 257 # lctl conf_param testfs-MDT0000.lov.stripesize=2M
 258 .br
 259 # lctl conf_param lustre-OST0001.osc.active=0
 260 .br
 261 # lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
 262 .br
 263 # lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
 264 .br
 265 # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
 266 .TP
 267 .BI activate
 268 Reactivate an import after deactivating, below.  This setting is only effective until the next restart (see
 269 .B conf_param
 270 ).
 271 .TP
 272 .BI deactivate
 273 Deactivate an import, in particular meaning do not assign new file stripes
 274 to an OSC.  This command should be used on the OSC in the MDT LOV
 275 corresponding to a failed OST device, to prevent further attempts at
 276 communication with the failed OST.
 277 .TP
 278 .BI abort_recovery
 279 Abort the recovery process on a restarting MDT or OST device
 280 .PP
 281 .SS Changelogs
 282 .TP
 283 .BI changelog_register " [-n]"
 284 Register a new changelog user for a particular device.  Changelog entries
 285 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
 286 .br
 287 .B -n
 288 Print only the ID of the newly registered user.
 289 .TP
 290 .BI changelog_deregister " <id>"
 291 Unregister an existing changelog user.  If the user's "clear" record number
 292 is the minimum for the device, changelog records will be purged until the
 293 next minimum.
 294 .PP
 295 .SS Nodemap
 296 An identity mapping feature that facilitates mapping of client UIDs and GIDs to
 297 local file system UIDs and GIDs, while maintaining POSIX ownership, permissions,
 298 and quota.
 299
 300 While the nodemap feature is enabled, all client file system access is subject
 301 to the nodemap identity mapping policy, which consists of the 'default' catchall
 302 nodemap, and any user-defined nodemaps. The 'default' nodemap maps all client
 303 identities to 99:99 (nobody:nobody). Administrators can define nodemaps for a
 304 range of client NIDs which map identities, and these nodemaps can be flagged as
 305  'trusted' so identities are accepted without translation, as well as flagged
 306 as 'admin' meaning that root is not squashed for these nodes.
 307
 308 Note: In the current phase of implementation, to use the nodemap functionality
 309 you only need to enable and define nodemaps on the MDS. The MDSes must also be
 310 in a nodemap with the admin and trusted flags set. To use quotas with nodemaps,
 311 you must also use set_param to enable and define nodemaps on the OSS (matching
 312 what is defined on the MDS). Nodemaps do not currently persist, unless you
 313 define them with set_param and use the -P flag. Note that there is a hard limit
 314 to the number of changes you can persist over the lifetime of the file system.
 315
 316 See also:
 317
 318 .PP
 319 \fBlctl-nodemap-activate\fR(8)
 320 .RS 4
 321 Activate/deactivate the nodemap feature.
 322 .RE
 323 .PP
 324 \fBlctl-nodemap-add\fR(8)
 325 .RS 4
 326 Add a new nodemap, to which NID ranges, identities, and properties can be added.
 327 .RE
 328 .PP
 329 \fBlctl-nodemap-del\fR(8)
 330 .RS 4
 331 Delete an existing nodemap.
 332 .RE
 333 .PP
 334 \fBlctl-nodemap-add-range\fR(8)
 335 .RS 4
 336 Define a range of NIDs for a nodemap.
 337 .RE
 338 .PP
 339 \fBlctl-nodemap-del-range\fR(8)
 340 .RS 4
 341 Delete an existing NID range from a nodemap.
 342 .RE
 343 .PP
 344 \fBlctl-nodemap-add-idmap\fR(8)
 345 .RS 4
 346 Add a UID or GID mapping to a nodemap.
 347 .RE
 348 .PP
 349 \fBlctl-nodemap-del-idmap\fR(8)
 350 .RS 4
 351 Delete an existing UID or GID mapping from a nodemap.
 352 .RE
 353 .PP
 354 \fBlctl-nodemap-modify\fR(8)
 355 .RS 4
 356 Modify a nodemap property.
 357 .RE
 358
 359 .SS LFSCK
 360 An on-line Lustre consistency check and repair tool. It is used for totally
 361 replacing the old lfsck tool for kinds of Lustre inconsistency verification,
 362 including: corrupted or lost OI mapping, corrupted or lost link EA, corrupted
 363 or lost FID in name entry, dangling name entry, multiple referenced name entry,
 364 unmatched MDT-object and name entry pairs, orphan MDT-object, incorrect
 365 MDT-object links count, corrupted namespace, corrupted or lost lov EA, lost
 366 OST-object, multiple referenced OST-object, unmatched MDT-object and OST-object
 367 pairs, orphan OST-object, and so on.
 368
 369 See also:
 370
 371 .PP
 372 \fBlctl-lfsck-start\fR(8)
 373 .RS 4
 374 Start LFSCK on the specified MDT or OST device with specified parameters.
 375 .RE
 376 .PP
 377 \fBlctl-lfsck-stop\fR(8)
 378 .RS 4
 379 Stop LFSCK on the specified MDT or OST device.
 380 .RE
 381 .PP
 382 \fBlctl-lfsck-query\fR(8)
 383 .RS 4
 384 Get the LFSCK global status via the specified MDT device.
 385 .RE
 386
 387 .SS BARRIER
 388 The tools set for write (modify) barrier on all MDTs. For detail, please see:
 389 .PP
 390 \fBlctl-barrier\fR(8)
 391 .RS 4
 392
 393 .SS SNAPSHOT
 394 ZFS backend based snapshot tools set. The tool loads system configuration
 395 from the file
 396 .B /etc/ldev.conf
 397 on the MGS, and call related ZFS commands to
 398 maintain Lustre snapshot pieces on all targets (MGS/MDT/OST).
 399 The configuration file
 400 .B /etc/ldev.conf
 401 is not only for snapshot, but also
 402 for other purpose. The format is:
 403   <host> foreign/- <label> <device> [journal-path]/- [raidtab]
 404
 405 The format of
 406 .I <label>
 407 is:
 408   fsname-<role><index> or <role><index>
 409
 410 The format of
 411 .I <device>
 412 is:
 413   [md|zfs:][pool_dir/]<pool>/<filesystem>
 414
 415 Snapshot only uses the fields <host>, <label> and <device>.
 416
 417 .br
 418 .B Example:
 419 .br
 420 .B
 421 # cat /etc/ldev.conf
 422 .br
 423  host-mdt1 - myfs-MDT0000 zfs:/tmp/myfs-mdt1/mdt1
 424  host-mdt2 - myfs-MDT0001 zfs:myfs-mdt2/mdt2
 425  host-ost1 - OST0000 zfs:/tmp/myfs-ost1/ost1
 426  host-ost2 - OST0001 zfs:myfs-ost2/ost2
 427
 428 See also:
 429
 430 .PP
 431 \fBlctl-snapshot-create\fR(8)
 432 .RS 4
 433 Create snapshot with the given name.
 434 .RE
 435 .PP
 436 \fBlctl-snapshot-destroy\fR(8)
 437 .RS 4
 438 Destroy the specified snapshot.
 439 .RE
 440 .PP
 441 \fBlctl-snapshot-modify\fR(8)
 442 .RS 4
 443 Modify the specified snapshot.
 444 .RE
 445 .PP
 446 \fBlctl-snapshot-list\fR(8)
 447 .RS 4
 448 Query the snapshot information.
 449 .RE
 450 .PP
 451 \fBlctl-snapshot-mount\fR(8)
 452 .RS 4
 453 Mount the specified snapshot.
 454 .RE
 455 .PP
 456 \fBlctl-snapshot-umount\fR(8)
 457 .RS 4
 458 Umount the specified snapshot.
 459 .RE
 460
 461 .SS Debug
 462 .TP
 463 .BI debug_daemon
 464 Start and stop the debug daemon, and control the output filename and size.
 465 .TP
 466 .BI debug_kernel " [file] [raw]"
 467 Dump the kernel debug buffer to stdout or file.
 468 .TP
 469 .BI debug_file " <input> [output]"
 470 Convert kernel-dumped debug log from binary to plain text format.
 471 .TP
 472 .BI clear
 473 Clear the kernel debug buffer.
 474 .TP
 475 .BI mark " <text>"
 476 Insert marker text in the kernel debug buffer.
 477 .TP
 478 .BI filter " <subsystem id/debug mask>"
 479 Filter kernel debug messages by subsystem or mask.
 480 .TP
 481 .BI show " <subsystem id/debug mask>"
 482 Show specific type of messages.
 483 .TP
 484 .BI debug_list " <subs/types>"
 485 List all the subsystem and debug types.
 486 .TP
 487 .BI modules " <path>"
 488 Provide gdb-friendly module information.
 489
 490 .SH OPTIONS
 491 The following options can be used to invoke lctl.
 492 .TP
 493 .B --device
 494 The device to be used for the operation. This can be specified by name or
 495 number. See
 496 .B device_list
 497 .TP
 498 .B --ignore_errors | ignore_errors
 499 Ignore errors during script processing
 500 .TP
 501 .B lustre_build_version
 502 Output the build version of the Lustre kernel modules
 503 .TP
 504 .B --version
 505 Output the build version of the lctl utility
 506 .TP
 507 .B --list-commands
 508 Output a list of the commands supported by the lctl utility
 509 .TP
 510 .B help
 511 Provides brief help on the various arguments
 512 .TP
 513 .B exit/quit
 514 Quit the interactive lctl session
 515
 516 .SH EXAMPLES
 517 # lctl
 518 .br
 519 lctl > dl
 520   0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
 521   1 UP ost OSS OSS_uuid 3
 522   2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
 523 .br
 524 lctl > dk /tmp/log
 525 Debug log: 87 lines, 87 kept, 0 dropped.
 526 .br
 527 lctl > quit
 528
 529 .SH AVAILABILITY
 530 .B lctl
 531 is part of the
 532 .BR lustre (7)
 533 filesystem package.
 534 .SH SEE ALSO
 535 .BR lustre (7),
 536 .BR mkfs.lustre (8),
 537 .BR mount.lustre (8),
 538 .BR lctl (8),
 539 .BR lctl-lfsck-start (8),
 540 .BR lctl-lfsck-stop (8),
 541 .BR lctl-lfsck-query (8),
 542 .BR lctl-lcfg (8),
 543 .BR lctl-barrier (8),
 544 .BR lctl-snapshot-create (8),
 545 .BR lctl-snapshot-destroy (8),
 546 .BR lctl-snapshot-modify (8),
 547 .BR lctl-snapshot-list (8),
 548 .BR lctl-snapshot-mount (8),
 549 .BR lctl-snapshot-umount (8),
 550 .BR lctl-llog_catlist (8),
 551 .BR lctl-llog_info (8),
 552 .BR lctl-llog_print (8),
 553 .BR lctl-network (8),
 554 .BR lctl-nodemap-activate (8),
 555 .BR lctl-nodemap-add-idmap (8),
 556 .BR lctl-nodemap-add-range (8),
 557 .BR lctl-nodemap-add (8),
 558 .BR lctl-nodemap-del-idmap (8),
 559 .BR lctl-nodemap-del-range (8),
 560 .BR lctl-nodemap-del (8),
 561 .BR lctl-nodemap-modify (8),
 562 .BR lfs (1)