1 .TH lctl 1 "2016 Sep 8" Lustre "configuration utilities"
3 lctl \- Low level Lustre filesystem configuration utility
8 .B lctl --device <devno> <command [args]>
12 is used to directly control Lustre via an ioctl interface, allowing
13 various configuration, maintenance, and debugging features to be accessed.
16 can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are
28 To get a complete listing of available commands, type
30 at the lctl prompt. To get basic help on the meaning and syntax of a
34 . Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
36 For non-interactive use, one uses the second invocation, which runs command after connecting to the device.
38 .SS Network Configuration
40 .BR network " <" up / down >|< tcp / o2ib >
41 Start or stop LNET, or select a network type for other
46 Print all Network Identifiers on the local node. LNET must be running.
48 .BI which_nid " <nidlist>"
49 From a list of nids for a remote node, show which interface communication
52 .BI replace_nids " <devicename> <nid1>[,nid2,nid3 ...]"
53 Replace the LNET Network Identifiers for a given device,
54 as when the server's IP address has changed.
55 This command must be run on the MGS node.
56 Only MGS server should be started (command execution returns error
57 in another cases). To start the MGS service only:
58 mount -t lustre <MDT partition> -o nosvc <mount point>
59 Note the replace_nids command skips any invalidated records in the configuration log.
60 The previous log is backed up with the suffix '.bak'.
63 Check LNET connectivity via an LNET ping. This will use the fabric
64 appropriate to the specified NID.
67 Print the network interface information for a given
72 Print the known peers for a given
77 Print all the connected remote NIDs for a given
82 Print the complete routing table.
86 .BI device " <devname> "
87 This will select the specified OBD device. All other commands depend on the device being set.
90 Show all the local Lustre OBDs. AKA
95 .BI list_param " [-F|-R] <param_search ...>"
96 List the Lustre or LNet parameter name
98 Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
101 Recursively list all parameters under the specified parameter search string. If
103 is unspecified, all the parameters will be shown.
108 # lctl list_param ost.*
115 # lctl list_param -F ost.* debug
124 # lctl list_param -R mdt
130 mdt.lustre-MDT0000.capa
132 mdt.lustre-MDT0000.capa_count
134 mdt.lustre-MDT0000.capa_key_timeout
136 mdt.lustre-MDT0000.capa_timeout
138 mdt.lustre-MDT0000.commit_on_sharing
140 mdt.lustre-MDT0000.evict_client
144 .BI get_param " [-F|-n|-N|-R] <parameter ...>"
145 Get the value of Lustre or LNET parameter.
148 When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
152 Print only the value and not parameter name.
155 Print only matched parameter names and not the values. (Especially useful when using patterns.)
158 Print all of the parameter names below the specified name.
163 # lctl get_param ost.*
170 # lctl get_param -n debug timeout
172 super warning dlmtrace error emerg ha rpctrace vfstrace config console
177 # lctl get_param -N ost.* debug
185 lctl "get_param -NF" is equivalent to "list_param -F".
187 .BI set_param " [-n] [-P] [-d] <parameter=value ...>"
188 Set the value of Lustre or LNET parameter.
191 Disable printing of the key name when printing values.
194 Set the parameter permanently, filesystem-wide.
195 This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters.
198 Remove the permanent setting (only with -P option)
203 # lctl set_param fail_loc=0 timeout=20
210 # lctl set_param -n fail_loc=0 timeout=20
217 # lctl set_param -P osc.*.max_dirty_mb=32
220 .BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
221 Set a permanent configuration parameter for any device via the MGS. This
222 command must be run on the MGS node.
224 .B -d <device|fsname>.<parameter>
225 Delete a parameter setting (use the default value at the next restart). A null value for <value> also deletes the parameter setting.
229 All of the writable parameters under
232 .I lctl list_param -F osc.*.* | grep =
233 ) can be permanently set using
235 , but the format is slightly different. For conf_param, the device is specified first, then the obdtype. (See examples below.) Wildcards are not supported.
237 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.
241 # lctl conf_param testfs.sys.at_max=1200
243 # lctl conf_param testfs.llite.max_read_ahead_mb=16
245 # lctl conf_param testfs-MDT0000.lov.stripesize=2M
247 # lctl conf_param lustre-OST0001.osc.active=0
249 # lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
251 # lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
253 # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
256 Reactivate an import after deactivating, below. This setting is only effective until the next restart (see
261 Deactivate an import, in particular meaning do not assign new file stripes
262 to an OSC. This command should be used on the OSC in the MDT LOV
263 corresponding to a failed OST device, to prevent further attempts at
264 communication with the failed OST.
267 Abort the recovery process on a restarting MDT or OST device
271 .BI changelog_register " [-n]"
272 Register a new changelog user for a particular device. Changelog entries
273 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
276 Print only the ID of the newly registered user.
278 .BI changelog_deregister " <id>"
279 Unregister an existing changelog user. If the user's "clear" record number
280 is the minimum for the device, changelog records will be purged until the
284 An identity mapping feature that facilitates mapping of client UIDs and GIDs to
285 local file system UIDs and GIDs, while maintaining POSIX ownership, permissions,
288 While the nodemap feature is enabled, all client file system access is subject
289 to the nodemap identity mapping policy, which consists of the 'default' catchall
290 nodemap, and any user-defined nodemaps. The 'default' nodemap maps all client
291 identities to 99:99 (nobody:nobody). Administrators can define nodemaps for a
292 range of client NIDs which map identities, and these nodemaps can be flagged as
293 'trusted' so identities are accepted without translation, as well as flagged
294 as 'admin' meaning that root is not squashed for these nodes.
296 Note: In the current phase of implementation, to use the nodemap functionality
297 you only need to enable and define nodemaps on the MDS. The MDSes must also be
298 in a nodemap with the admin and trusted flags set. To use quotas with nodemaps,
299 you must also use set_param to enable and define nodemaps on the OSS (matching
300 what is defined on the MDS). Nodemaps do not currently persist, unless you
301 define them with set_param and use the -P flag. Note that there is a hard limit
302 to the number of changes you can persist over the lifetime of the file system.
307 \fBlctl-nodemap-activate\fR(8)
309 Activate/deactivate the nodemap feature.
312 \fBlctl-nodemap-add\fR(8)
314 Add a new nodemap, to which NID ranges, identities, and properties can be added.
317 \fBlctl-nodemap-del\fR(8)
319 Delete an existing nodemap.
322 \fBlctl-nodemap-add-range\fR(8)
324 Define a range of NIDs for a nodemap.
327 \fBlctl-nodemap-del-range\fR(8)
329 Delete an existing NID range from a nodemap.
332 \fBlctl-nodemap-add-idmap\fR(8)
334 Add a UID or GID mapping to a nodemap.
337 \fBlctl-nodemap-del-idmap\fR(8)
339 Delete an existing UID or GID mapping from a nodemap.
342 \fBlctl-nodemap-modify\fR(8)
344 Modify a nodemap property.
348 An on-line Lustre consistency check and repair tool. It is used for totally
349 replacing the old lfsck tool for kinds of Lustre inconsistency verification,
350 including: corrupted or lost OI mapping, corrupted or lost link EA, corrupted
351 or lost FID in name entry, dangling name entry, multiple referenced name entry,
352 unmatched MDT-object and name entry pairs, orphan MDT-object, incorrect
353 MDT-object links count, corrupted namespace, corrupted or lost lov EA, lost
354 OST-object, multiple referenced OST-object, unmatched MDT-object and OST-object
355 pairs, orphan OST-object, and so on.
360 \fBlctl-lfsck-start\fR(8)
362 Start LFSCK on the specified MDT or OST device with specified parameters.
365 \fBlctl-lfsck-stop\fR(8)
367 Stop LFSCK on the specified MDT or OST device.
370 \fBlctl-lfsck-query\fR(8)
372 Get the LFSCK global status via the specified MDT device.
377 Start and stop the debug daemon, and control the output filename and size.
379 .BI debug_kernel " [file] [raw]"
380 Dump the kernel debug buffer to stdout or file.
382 .BI debug_file " <input> [output]"
383 Convert kernel-dumped debug log from binary to plain text format.
386 Clear the kernel debug buffer.
389 Insert marker text in the kernel debug buffer.
391 .BI filter " <subsystem id/debug mask>"
392 Filter kernel debug messages by subsystem or mask.
394 .BI show " <subsystem id/debug mask>"
395 Show specific type of messages.
397 .BI debug_list " <subs/types>"
398 List all the subsystem and debug types.
400 .BI modules " <path>"
401 Provide gdb-friendly module information.
404 The following options can be used to invoke lctl.
407 The device to be used for the operation. This can be specified by name or
411 .B --ignore_errors | ignore_errors
412 Ignore errors during script processing
414 .B lustre_build_version
415 Output the build version of the Lustre kernel modules
418 Output the build version of the lctl utility
421 Provides brief help on the various arguments
424 Quit the interactive lctl session
430 0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
431 1 UP ost OSS OSS_uuid 3
432 2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
435 Debug log: 87 lines, 87 kept, 0 dropped.
447 .BR mount.lustre (8),
449 .BR lctl-lfsck-start (8),
450 .BR lctl-lfsck-stop (8),
451 .BR lctl-lfsck-query (8),
452 .BR lctl-network (8),
453 .BR lctl-nodemap-activate (8),
454 .BR lctl-nodemap-add-idmap (8),
455 .BR lctl-nodemap-add-range (8),
456 .BR lctl-nodemap-add (8),
457 .BR lctl-nodemap-del-idmap (8),
458 .BR lctl-nodemap-del-range (8),
459 .BR lctl-nodemap-del (8),
460 .BR lctl-nodemap-modify (8),