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'.
62 .BI ping " <nid> timeout"
63 Check LNET connectivity via an LNET ping. This will use the fabric
64 appropriate to the specified NID. By default lctl will attempt to
65 reach the remote node up to 120 seconds and then timeout. To disable
66 the timeout just specify an negative timeout value.
69 Print the network interface information for a given
74 Print the known peers for a given
79 Print all the connected remote NIDs for a given
84 Print the complete routing table.
88 .BI device " <devname> "
89 This will select the specified OBD device. All other commands depend on the device being set.
92 Show all the local Lustre OBDs. AKA
97 .BI list_param " [-F|-R] <param_search ...>"
98 List the Lustre or LNet parameter name
100 Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
103 Recursively list all parameters under the specified parameter search string. If
105 is unspecified, all the parameters will be shown.
110 # lctl list_param ost.*
117 # lctl list_param -F ost.* debug
126 # lctl list_param -R mdt
132 mdt.lustre-MDT0000.capa
134 mdt.lustre-MDT0000.capa_count
136 mdt.lustre-MDT0000.capa_key_timeout
138 mdt.lustre-MDT0000.capa_timeout
140 mdt.lustre-MDT0000.commit_on_sharing
142 mdt.lustre-MDT0000.evict_client
146 .BI get_param " [-F|-n|-N|-R] <parameter ...>"
147 Get the value of Lustre or LNET parameter.
150 When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
154 Print only the value and not parameter name.
157 Print only matched parameter names and not the values. (Especially useful when using patterns.)
160 Print all of the parameter names below the specified name.
165 # lctl get_param ost.*
172 # lctl get_param -n debug timeout
174 super warning dlmtrace error emerg ha rpctrace vfstrace config console
179 # lctl get_param -N ost.* debug
187 lctl "get_param -NF" is equivalent to "list_param -F".
189 .BI set_param " [-n] [-P] [-d] <parameter=value ...>"
190 Set the value of Lustre or LNET parameter.
193 Disable printing of the key name when printing values.
196 Set the parameter permanently, filesystem-wide.
197 This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters.
200 Remove the permanent setting (only with -P option)
205 # lctl set_param fail_loc=0 timeout=20
212 # lctl set_param -n fail_loc=0 timeout=20
219 # lctl set_param -P osc.*.max_dirty_mb=32
222 .BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
223 Set a permanent configuration parameter for any device via the MGS. This
224 command must be run on the MGS node.
226 .B -d <device|fsname>.<parameter>
227 Delete a parameter setting (use the default value at the next restart). A null value for <value> also deletes the parameter setting.
231 All of the writable parameters under
234 .I lctl list_param -F osc.*.* | grep =
235 ) can be permanently set using
237 , but the format is slightly different. For conf_param, the device is specified first, then the obdtype. (See examples below.) Wildcards are not supported.
239 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.
243 # lctl conf_param testfs.sys.at_max=1200
245 # lctl conf_param testfs.llite.max_read_ahead_mb=16
247 # lctl conf_param testfs-MDT0000.lov.stripesize=2M
249 # lctl conf_param lustre-OST0001.osc.active=0
251 # lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
253 # lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
255 # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
258 Reactivate an import after deactivating, below. This setting is only effective until the next restart (see
263 Deactivate an import, in particular meaning do not assign new file stripes
264 to an OSC. This command should be used on the OSC in the MDT LOV
265 corresponding to a failed OST device, to prevent further attempts at
266 communication with the failed OST.
269 Abort the recovery process on a restarting MDT or OST device
273 .BI changelog_register " [-n]"
274 Register a new changelog user for a particular device. Changelog entries
275 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
278 Print only the ID of the newly registered user.
280 .BI changelog_deregister " <id>"
281 Unregister an existing changelog user. If the user's "clear" record number
282 is the minimum for the device, changelog records will be purged until the
286 An identity mapping feature that facilitates mapping of client UIDs and GIDs to
287 local file system UIDs and GIDs, while maintaining POSIX ownership, permissions,
290 While the nodemap feature is enabled, all client file system access is subject
291 to the nodemap identity mapping policy, which consists of the 'default' catchall
292 nodemap, and any user-defined nodemaps. The 'default' nodemap maps all client
293 identities to 99:99 (nobody:nobody). Administrators can define nodemaps for a
294 range of client NIDs which map identities, and these nodemaps can be flagged as
295 'trusted' so identities are accepted without translation, as well as flagged
296 as 'admin' meaning that root is not squashed for these nodes.
298 Note: In the current phase of implementation, to use the nodemap functionality
299 you only need to enable and define nodemaps on the MDS. The MDSes must also be
300 in a nodemap with the admin and trusted flags set. To use quotas with nodemaps,
301 you must also use set_param to enable and define nodemaps on the OSS (matching
302 what is defined on the MDS). Nodemaps do not currently persist, unless you
303 define them with set_param and use the -P flag. Note that there is a hard limit
304 to the number of changes you can persist over the lifetime of the file system.
309 \fBlctl-nodemap-activate\fR(8)
311 Activate/deactivate the nodemap feature.
314 \fBlctl-nodemap-add\fR(8)
316 Add a new nodemap, to which NID ranges, identities, and properties can be added.
319 \fBlctl-nodemap-del\fR(8)
321 Delete an existing nodemap.
324 \fBlctl-nodemap-add-range\fR(8)
326 Define a range of NIDs for a nodemap.
329 \fBlctl-nodemap-del-range\fR(8)
331 Delete an existing NID range from a nodemap.
334 \fBlctl-nodemap-add-idmap\fR(8)
336 Add a UID or GID mapping to a nodemap.
339 \fBlctl-nodemap-del-idmap\fR(8)
341 Delete an existing UID or GID mapping from a nodemap.
344 \fBlctl-nodemap-modify\fR(8)
346 Modify a nodemap property.
350 An on-line Lustre consistency check and repair tool. It is used for totally
351 replacing the old lfsck tool for kinds of Lustre inconsistency verification,
352 including: corrupted or lost OI mapping, corrupted or lost link EA, corrupted
353 or lost FID in name entry, dangling name entry, multiple referenced name entry,
354 unmatched MDT-object and name entry pairs, orphan MDT-object, incorrect
355 MDT-object links count, corrupted namespace, corrupted or lost lov EA, lost
356 OST-object, multiple referenced OST-object, unmatched MDT-object and OST-object
357 pairs, orphan OST-object, and so on.
362 \fBlctl-lfsck-start\fR(8)
364 Start LFSCK on the specified MDT or OST device with specified parameters.
367 \fBlctl-lfsck-stop\fR(8)
369 Stop LFSCK on the specified MDT or OST device.
372 \fBlctl-lfsck-query\fR(8)
374 Get the LFSCK global status via the specified MDT device.
379 Start and stop the debug daemon, and control the output filename and size.
381 .BI debug_kernel " [file] [raw]"
382 Dump the kernel debug buffer to stdout or file.
384 .BI debug_file " <input> [output]"
385 Convert kernel-dumped debug log from binary to plain text format.
388 Clear the kernel debug buffer.
391 Insert marker text in the kernel debug buffer.
393 .BI filter " <subsystem id/debug mask>"
394 Filter kernel debug messages by subsystem or mask.
396 .BI show " <subsystem id/debug mask>"
397 Show specific type of messages.
399 .BI debug_list " <subs/types>"
400 List all the subsystem and debug types.
402 .BI modules " <path>"
403 Provide gdb-friendly module information.
406 The following options can be used to invoke lctl.
409 The device to be used for the operation. This can be specified by name or
413 .B --ignore_errors | ignore_errors
414 Ignore errors during script processing
416 .B lustre_build_version
417 Output the build version of the Lustre kernel modules
420 Output the build version of the lctl utility
423 Provides brief help on the various arguments
426 Quit the interactive lctl session
432 0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
433 1 UP ost OSS OSS_uuid 3
434 2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
437 Debug log: 87 lines, 87 kept, 0 dropped.
449 .BR mount.lustre (8),
451 .BR lctl-lfsck-start (8),
452 .BR lctl-lfsck-stop (8),
453 .BR lctl-lfsck-query (8),
454 .BR lctl-network (8),
455 .BR lctl-nodemap-activate (8),
456 .BR lctl-nodemap-add-idmap (8),
457 .BR lctl-nodemap-add-range (8),
458 .BR lctl-nodemap-add (8),
459 .BR lctl-nodemap-del-idmap (8),
460 .BR lctl-nodemap-del-range (8),
461 .BR lctl-nodemap-del (8),
462 .BR lctl-nodemap-modify (8),