1 .TH lctl 1 "2003 Oct 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
35 To get a complete listing of available commands, type
37 at the lctl prompt. To get basic help on the meaning and syntax of a
41 . Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
43 For non-interactive use, one uses the second invocation, which runs command after connecting to the device.
45 .SS Network Configuration
47 .BI network " <up/down>|<tcp/elan/myrinet>"
48 Start or stop LNET, or select a network type for other
53 Print all Network Identifiers on the local node. LNET must be running.
55 .BI which_nid " <nidlist>"
56 From a list of nids for a remote node, show which interface communication
59 .BI replace_nids " <devicename> <nid1>[,nid2,nid3 ...]"
60 Replace the LNET Network Identifiers for a given device,
61 as when the server's IP address has changed.
62 This command must be run on the MGS node.
63 Only MGS server should be started (command execution returns error
64 in another cases). To start the MGS service only:
65 mount -t lustre <MDT partition> -o nosvc <mount point>
66 Note the replace_nids command skips any invalidated records in the configuration log.
67 The previous log is backed up with the suffix '.bak'.
70 Check LNET connectivity via an LNET ping. This will use the fabric
71 appropriate to the specified NID.
74 Print the network interface information for a given
79 Print the known peers for a given
84 Print all the connected remote NIDs for a given
89 This command should print active transmits, and it is only used for elan network type.
92 Print the complete routing table.
96 .BI device " <devname> "
97 This will select the specified OBD device. All other commands depend on the device being set.
100 Show all the local Lustre OBDs. AKA
103 .SS Device Operations
105 .BI list_param " [-F|-R] <param_search ...>"
106 List the Lustre or LNet parameter name
108 Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
111 Recursively list all parameters under the specified parameter search string. If
113 is unspecified, all the parameters will be shown.
118 # lctl list_param ost.*
125 # lctl list_param -F ost.* debug
134 # lctl list_param -R mdt
140 mdt.lustre-MDT0000.capa
142 mdt.lustre-MDT0000.capa_count
144 mdt.lustre-MDT0000.capa_key_timeout
146 mdt.lustre-MDT0000.capa_timeout
148 mdt.lustre-MDT0000.commit_on_sharing
150 mdt.lustre-MDT0000.evict_client
154 .BI get_param " [-n|-N|-F] <parameter ...>"
155 Get the value of Lustre or LNET parameter.
158 Print only the value and not parameter name.
161 Print only matched parameter names and not the values. (Especially useful when using patterns.)
164 When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
169 # lctl get_param ost.*
176 # lctl get_param -n debug timeout
178 super warning dlmtrace error emerg ha rpctrace vfstrace config console
183 # lctl get_param -N ost.* debug
191 lctl "get_param -NF" is equivalent to "list_param -F".
193 .BI set_param " [-n] [-P] [-d] <parameter=value ...>"
194 Set the value of Lustre or LNET parameter.
197 Disable printing of the key name when printing values.
200 Set the parameter permanently, filesystem-wide.
201 This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters.
204 Remove the permanent setting (only with -P option)
209 # lctl set_param fail_loc=0 timeout=20
216 # lctl set_param -n fail_loc=0 timeout=20
223 # lctl set_param -P osc.*.max_dirty_mb=32
226 .BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
227 Set a permanent configuration parameter for any device via the MGS. This
228 command must be run on the MGS node.
230 .B -d <device|fsname>.<parameter>
231 Delete a parameter setting (use the default value at the next restart). A null value for <value> also deletes the parameter setting.
235 All of the writable parameters under
238 .I lctl list_param -F osc.*.* | grep =
239 ) can be permanently set using
241 , but the format is slightly different. For conf_param, the device is specified first, then the obdtype. (See examples below.) Wildcards are not supported.
243 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.
247 # lctl conf_param testfs.sys.at_max=1200
249 # lctl conf_param testfs.llite.max_read_ahead_mb=16
251 # lctl conf_param testfs-MDT0000.lov.stripesize=2M
253 # lctl conf_param lustre-OST0001.osc.active=0
255 # lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
257 # lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
259 # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
262 Reactivate an import after deactivating, below. This setting is only effective until the next restart (see
267 Deactivate an import, in particular meaning do not assign new file stripes
268 to an OSC. This command should be used on the OSC in the MDT LOV
269 corresponding to a failed OST device, to prevent further attempts at
270 communication with the failed OST.
273 Abort the recovery process on a restarting MDT or OST device
275 .SS Virtual Block Device Operation
276 Lustre is able to emulate a virtual block device upon regular file. It is necessary to be used when you are trying to setup a swap space via file.
278 .BI blockdev_attach " <file name> <device node>"
279 Attach the lustre regular file to a block device. If the device node is not existent, lctl will create it \- it is recommended to create it by lctl since the emulator uses a dynamical major number.
281 .BI blockdev_detach " <device node>"
282 Detach the virtual block device.
284 .BI blockdev_info " <device node>"
285 Acquire which lustre file was attached to the device node.
289 .BI changelog_register
290 Register a new changelog user for a particular device. Changelog entries
291 will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
293 .BI changelog_deregister " <id>"
294 Unregister an existing changelog user. If the user's "clear" record number
295 is the minimum for the device, changelog records will be purged until the
299 An on-line Lustre consistency check and repair tool.
301 .B lfsck_start \fR<-M | --device MDT_device>
302 \fR[-e | --error <error_handle>]
304 \fR[-n | --dryrun <switch>]
306 \fR[-s | --speed <speed_limit>]
307 \fR[-t | --type <lfsck_type[,lfsck_type...]>]
309 Start LFSCK on the specified MDT device with specified parameters.
311 -M, --device <MDT_device>
312 The MDT device to check.
314 -e, --error <error_handle>
315 With error_handle as 'abort' LFSCK will stop if a repair is impossible. If no
316 value is specified, the saved value will be used if resuming from a checkpoint.
317 Otherwise the default behavior is to 'continue' if a rapair is impossible.
322 -n, --dryrun <on|off>
323 Perform a trial run with no changes made.
326 Set the current position of LFSCK progress to the beginning of the specified
329 -s, --speed <speed_limit>
330 Set the upper limit of LFSCK processing in objects per second. If no value is
331 specified the saved value is used (if resuming from a check point). Otherwise
332 the default value of 0 is used. 0 means run as fast as possible.
334 -t, --type <lfsck_type[,lfsck_type...]>
335 Specify the type of LFSCK to execute. By default, OI Scrub is executed.
336 Alternative types include FID-in-dirent and linkEA (namespace).
338 .B lfsck_stop \fR<-M | --device MDT_device> [-h | --help]
339 Stop LFSCK on the specified MDT device.
341 -M, --device <MDT_device>
349 Start and stop the debug daemon, and control the output filename and size.
351 .BI debug_kernel " [file] [raw]"
352 Dump the kernel debug buffer to stdout or file.
354 .BI debug_file " <input> [output]"
355 Convert kernel-dumped debug log from binary to plain text format.
358 Clear the kernel debug buffer.
361 Insert marker text in the kernel debug buffer.
363 .BI filter " <subsystem id/debug mask>"
364 Filter kernel debug messages by subsystem or mask.
366 .BI show " <subsystem id/debug mask>"
367 Show specific type of messages.
369 .BI debug_list " <subs/types>"
370 List all the subsystem and debug types.
372 .BI modules " <path>"
373 Provide gdb-friendly module information.
376 The following options can be used to invoke lctl.
379 The device to be used for the operation. This can be specified by name or
383 .B --ignore_errors | ignore_errors
384 Ignore errors during script processing
390 0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
391 1 UP ost OSS OSS_uuid 3
392 2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
395 Debug log: 87 lines, 87 kept, 0 dropped.
407 .BR mount.lustre (8),