-.TH lctl 1 "2003 Oct 8" Lustre "configuration utilities"
+.TH lctl 8 "2017 Jan 12" Lustre "configuration utilities"
.SH NAME
lctl \- Low level Lustre filesystem configuration utility
.SH SYNOPSIS
.br
.B lctl --device <devno> <command [args]>
.br
-.B lctl --threads <numthreads> <verbose> <devno> <command [args]>
+.B lctl --version
+.br
+.B lctl --list-commands
.br
.SH DESCRIPTION
.B lctl
-can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are (in matching pairs)
-.B device
-and
-.B attach
-,
-.B detach
-and
-.B setup
-,
-.B cleanup
-and
-.B connect
-,
-.B disconnect
-and
-.B help
-, and
-.B quit.
+is used to directly control Lustre via an ioctl interface, allowing
+various configuration, maintenance, and debugging features to be accessed.
-To get a complete listing of available commands, type help at the lctl prompt. To get basic help on the meaning and syntax of a command, type help command. Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
+.B lctl
+can be invoked in interactive mode by issuing lctl command. After that, commands are issued as below. The most common commands in lctl are
+.BR dl ,
+.BR dk ,
+.BR device ,
+.B network
+.IR <up/down> ,
+.BR list_nids ,
+.B ping
+.IR nid ,
+.BR help ,
+.BR quit .
-For non-interactive single-threaded use, one uses the second invocation, which runs command after connecting to the device.
+To get a complete listing of available commands, type
+.B --list-commands
+at the lctl prompt. To get basic help on the meaning and syntax of a
+command, type
+.B help
+.I command
+. Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys.
-.B Network Configuration
-.TP
-network <tcp/elans/myrinet>
-Indicate what kind of network applies for the configuration commands that follow.
-.TP
-connect [[<hostname> <port>] | <elan id>]
-This will establish a connection to a remote network network id given by the hostname/port combination, or the elan id.
-.TP
-disconnect <nid>
-Disconnect from a remote nid.
-.TP
-mynid [nid]
-Informs the socknal of the local nid. It defaults to hostname for tcp networks and is automatically setup for elan/myrinet networks.
-.TP
-add_uuid <uuid> <nid>
-Associate a given UUID with an nid.
-.TP
-close_uuid <uuid>
-Disconnect a UUID.
-.TP
-del_uuid <uuid>
-Delete a UUID association.
-.TP
-add_route <gateway> <target> [target]
-Add an entry to the routing table for the given target.
-.TP
-del_route <target>
-Delete an entry for the target from the routing table.
-.TP
-route_list
-Print the complete routing table.
-.TP
-recv_mem [size]
-Set the socket receive buffer size; if the size is omitted, the default size for the buffer is printed.
-.TP
-send_mem [size]
-Set send buffer size for the socket; if size is omitted, the default size for the buffer is printed.
-.TP
-nagle [on/off]
-Enable/disable nagle; omitting the argument will cause the default value to be printed.
-.TP
-fail nid|all [count]
-Fail/restore communications. Ommiting tha count implies fail indefinitely, count of zero indicates that communication should be restored. A non-zero count indicates the number of portals messages to be dropped after which the communication is restored.
-.PP
-.B Device Selection
-.TP
-newdev
-Create a new device.
-.TP
-name2dev
-This command can be used to determine a device number for the given device name.
-.TP
-device
-This will select the specified OBD device. All other commands depend on the device being set.
-.TP
-device_list
-Show all the devices.
-.TP
-lustre_build_version
-Print the Lustre build version.
-.PP
-.B Device Configuration
-.TP
-attach type [name [uuid]]
-Attach a type to the current device (which you need to set using the device command) and give that device a name and UUID. This allows us to identify the device for use later, and also tells us what type of device we will have.
-.TP
-setup <args...>
-Type specific device setup commands. For obdfilter, a setup command tells the driver which block device it should use for storage and what type of filesystem is on that device.
-.TP
-cleanup
-Cleanup a previously setup device.
-.TP
-detach
-Remove driver (and name and UUID) from the current device.
-.TP
-lov_setconfig lov-uuid stripe-count default-stripe-size offset pattern UUID1 [UUID2...]
-Write LOV configuration to an MDS device.
-.TP
-lov_getconfig lov-uuid
-Read LOV configuration from an MDS device. Returns default-stripe-count, default-stripe-size, offset, pattern, and a list of OST UUID's.
-.PP
-.B Device Operations
-.TP
-probe [timeout]
-Build a connection handle to a device. This command is used to suspend configuration until the lctl command has ensured that the MDS and OSC services are available. This is to avoid mount failures in a rebooting cluster.
-.TP
-close
-Close the connection handle
-.TP
-getattr <objid>
-Get attributes for an OST object <objid> .
-.TP
-setattr <objid> <mode>
-Set mode attribute for OST object <objid>.
-.TP
-create [num [mode [verbose]]]
-Create the specified number <num> of OST objects with the given <mode>.
-.TP
-destroy <num>
-Starting at <objid>, destroy <num> number of objects starting from the object with object id <objid>.
-.TP
-test_getattr <num> [verbose [[t]objid]]
-Do <num> getattrs on OST object <objid> (objectid+1 on each thread).
-.TP
-test_brw [t]<num> [write [verbose [npages [[t]objid]]]]
-Do <num> bulk read/writes on OST object <objid> (<npages> per I/O).
-.TP
-test_ldlm
-Perform lock manager test.
-.TP
-ldlm_regress_start %s [numthreads [refheld [numres [numext]]]]
-Start lock manager stress test.
-.TP
-ldlm_regress_stop
-Stop lock manager stress test.
-.TP
-dump_ldlm
-Dump all lock manager state, this is very useful for debugging
-.TP
-activate
-Activate an import
-.TP
-deacttivate
-De-activate an import
-.TP
-recover <connection UUID>
-.TP
-lookup <directory> <file>
-.TP
-notransno
-Disable sending of committed transnumber updates
-.TP
-readonly
-Disable writes to the underlying device
-.TP
-abort_recovery
-Abort recovery on MDS device
-.TP
-mount_option
-Dump mount options to a file
-.TP
-get_stripe
-Show stripe info for an echo client object.
-.TP
-set_stripe <objid>[ width!count[@offset] [:id:id....]
-Set stripe info for an echo client
-.TP
-unset_stripe <objid>
-Unset stripe info for an echo client object.
-.PP
-.B Debug
-.TP
-debug_daemon
-Debug daemon control and dump to a file
-.TP
-debug_kernel [file] [raw]
-Get debug buffer and dump to a fileusage.
-.TP
-debug_file <input> [output] [raw]
-Read debug buffer from input and dump to outputusage.
-.TP
-clear
-Clear kernel debug buffer.
-.TP
-mark <text>
-Insert marker text in kernel debug buffer.
-.TP
-filter <subsystem id/debug mask>
-Filter message type from the kernel debug buffer.
-.TP
-show <subsystem id/debug mask>
-Show specific type of messages.
-.TP
-debug_list <subs/types>
-List all the subsystem and debug types.
-.TP
-panic
-Force the kernel to panic.
+For non-interactive use, one uses the second invocation, which runs command after connecting to the device.
+
+.SS System Configuration
+The on-line tool set for backup or removal of Lustre system configuration. For detail, please see:
.PP
-.B Control
-.TP
-help
-Show a complete list of commands; help <command name> can be used to get help on specific command.
-.TP
-exit
-Close the lctl session.
-.TP
-quit
-Close the lctl session.
+\fBlctl-lcfg\fR(8)
+.RS 4
-.SH OPTIONS
-The following options can be used to invoke lctl.
+.SS Network Configuration
.TP
-.B --device
-The device number to be used for the operation. The value of devno is an integer, normally found by calling lctl name2dev on a device name.
+.BR network " <" up / down >|< tcp / o2ib >
+Start or stop LNET, or select a network type for other
+.I lctl
+LNET commands
.TP
-.B --threads
-How many threads should be forked doing the command specified. The numthreads variable is a strictly positive integer indicating how many threads should be started. The devno option is used as above.
+.BI list_nids
+Print all Network Identifiers on the local node. LNET must be running.
.TP
-.B --ignore_errors | ignore_errors
-Ignore errors during script processing
+.BI which_nid " <nidlist>"
+From a list of nids for a remote node, show which interface communication
+will take place on.
.TP
-.B dump
-Save ioctls to a file
-.SH EXAMPLES
-.B attach
-
-# lctl
-.br
-lctl > newdev
-.br
-lctl > attach obdfilter OBDDEV OBDUUID
-
-.B connect
-
-lctl > name2dev OSCDEV 2
-.br
-lctl > device 2
-.br
-lctl > connect
-
-.B getattr
-
-lctl > getattr 12
-.br
-id: 12
-.br
-grp: 0
+.BI replace_nids " <devicename> <nid1>[,nid2,nid3:nid4,nid5:nid6 ...]"
+Replace the LNET Network Identifiers for a given device,
+as when the server's IP address has changed.
+This command must be run on the MGS node.
+Only MGS server should be started (command execution returns error
+in another cases). To start the MGS service only:
+mount -t lustre <MDT partition> -o nosvc <mount point>
+Note the replace_nids command skips any invalidated records in the configuration log.
+The previous log is backed up with the suffix '.bak'.
+Failover nids must be passed after ':' symbol. More then
+one failover can be set (every failover nids after ':' symbol).
+.TP
+.BI ping " <nid> timeout"
+Check LNET connectivity via an LNET ping. This will use the fabric
+appropriate to the specified NID. By default lctl will attempt to
+reach the remote node up to 120 seconds and then timeout. To disable
+the timeout just specify an negative timeout value.
+.TP
+.BI interface_list
+Print the network interface information for a given
+.B network
+type.
+.TP
+.BI peer_list
+Print the known peers for a given
+.B network
+type.
+.TP
+.BI conn_list
+Print all the connected remote NIDs for a given
+.B network
+type.
+.TP
+.BI route_list
+Print the complete routing table.
+.PP
+.SS Device Selection
+.TP
+.BI device " <devname> "
+This will select the specified OBD device. All other commands depend on the device being set.
+.TP
+.BI device_list
+Show all the local Lustre OBDs. AKA
+.B dl
+.PP
+.SS Device Operations
+.TP
+.BI conf_param " [-d] <device|fsname>.<parameter>=<value>"
+Set a permanent configuration parameter for any device via the MGS. This
+command must be run on the MGS node.
.br
-atime: 1002663714
+.B -d <device|fsname>.<parameter>
+Delete a parameter setting (use the default value at the next restart).
+A null value for <value> also deletes the parameter setting. This is
+useful if an incorrect or obsolete parameter is in the configuration.
.br
-mtime: 1002663535
+.B Parameters:
.br
-ctime: 1002663535
+All of the writable parameters under
+.B lctl list_param
+(e.g.
+.I lctl list_param -F osc.*.* | grep =
+) can be permanently set using
+.B lctl conf_param
+, but the format is slightly different. For conf_param, the device is specified first, then the obdtype. (See examples below.) Wildcards are not supported.
.br
-size: 10
+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.
.br
-blocks: 8
+.B Examples:
.br
-blksize: 4096
+# lctl conf_param testfs.sys.at_max=1200
.br
-mode: 100644
+# lctl conf_param testfs.llite.max_read_ahead_mb=16
.br
-uid: 0
+# lctl conf_param testfs-MDT0000.lov.stripesize=2M
.br
-gid: 0
+# lctl conf_param lustre-OST0001.osc.active=0
.br
-flags: 0
+# lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15
.br
-obdflags: 0
+# lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
.br
-nlink: 1
+# lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
.br
-valid: ffffffff
+# lctl conf_param -d testfs-OST0000.bad_param
+.TP
+.BI activate
+Reactivate an import after deactivating, below. This setting is only effective until the next restart (see
+.B conf_param
+).
+.TP
+.BI deactivate
+Deactivate an import, in particular meaning do not assign new file stripes
+to an OSC. This command should be used on the OSC in the MDT LOV
+corresponding to a failed OST device, to prevent further attempts at
+communication with the failed OST.
+.TP
+.BI abort_recovery
+Abort the recovery process on a restarting MDT or OST device
+.PP
+.SS Changelogs
+.TP
+.BI changelog_register " [-n]"
+Register a new changelog user for a particular device. Changelog entries
+will not be purged beyond any registered users' set point. (See lfs changelog_clear.)
.br
-inline:
+.B -n
+Print only the ID of the newly registered user.
+.TP
+.BI changelog_deregister " <id>"
+Unregister an existing changelog user. If the user's "clear" record number
+is the minimum for the device, changelog records will be purged until the
+next minimum.
+.PP
+.SS Nodemap
+An identity mapping feature that facilitates mapping of client UIDs and GIDs to
+local file system UIDs and GIDs, while maintaining POSIX ownership, permissions,
+and quota.
+
+While the nodemap feature is enabled, all client file system access is subject
+to the nodemap identity mapping policy, which consists of the 'default' catchall
+nodemap, and any user-defined nodemaps. The 'default' nodemap maps all client
+identities to 99:99 (nobody:nobody). Administrators can define nodemaps for a
+range of client NIDs which map identities, and these nodemaps can be flagged as
+ 'trusted' so identities are accepted without translation, as well as flagged
+as 'admin' meaning that root is not squashed for these nodes.
+
+Note: In the current phase of implementation, to use the nodemap functionality
+you only need to enable and define nodemaps on the MDS. The MDSes must also be
+in a nodemap with the admin and trusted flags set. To use quotas with nodemaps,
+you must also use set_param to enable and define nodemaps on the OSS (matching
+what is defined on the MDS). Nodemaps do not currently persist, unless you
+define them with set_param and use the -P flag. Note that there is a hard limit
+to the number of changes you can persist over the lifetime of the file system.
+
+See also:
+
+.PP
+\fBlctl-nodemap-activate\fR(8)
+.RS 4
+Activate/deactivate the nodemap feature.
+.RE
+.PP
+\fBlctl-nodemap-add\fR(8)
+.RS 4
+Add a new nodemap, to which NID ranges, identities, and properties can be added.
+.RE
+.PP
+\fBlctl-nodemap-del\fR(8)
+.RS 4
+Delete an existing nodemap.
+.RE
+.PP
+\fBlctl-nodemap-add-range\fR(8)
+.RS 4
+Define a range of NIDs for a nodemap.
+.RE
+.PP
+\fBlctl-nodemap-del-range\fR(8)
+.RS 4
+Delete an existing NID range from a nodemap.
+.RE
+.PP
+\fBlctl-nodemap-add-idmap\fR(8)
+.RS 4
+Add a UID or GID mapping to a nodemap.
+.RE
+.PP
+\fBlctl-nodemap-del-idmap\fR(8)
+.RS 4
+Delete an existing UID or GID mapping from a nodemap.
+.RE
+.PP
+\fBlctl-nodemap-modify\fR(8)
+.RS 4
+Modify a nodemap property.
+.RE
+.PP
+\fBlctl-nodemap-set-fileset\fR(8)
+.RS 4
+Add a fileset to a nodemap.
+.RE
+.PP
+\fBlctl-nodemap-set-sepol\fR(8)
+.RS 4
+Set SELinux policy info on a nodemap.
+.RE
+.SS Configuration logs
+.TP
+.BI clear_conf " <device|fsname>"
+This command runs on MGS node having MGS device mounted with -o
+nosvc. It cleans up configuration files stored in the CONFIGS/ directory
+of any records marked SKIP. If the device name is given, then the
+specific logs for that filesystem (e.g. testfs-MDT0000) is processed.
+Otherwise, if a filesystem name is given then all configuration files for the
+specified filesystem are cleared.
+.PP
+.SS LFSCK
+An on-line Lustre consistency check and repair tool. It is used for totally
+replacing the old lfsck tool for kinds of Lustre inconsistency verification,
+including: corrupted or lost OI mapping, corrupted or lost link EA, corrupted
+or lost FID in name entry, dangling name entry, multiple referenced name entry,
+unmatched MDT-object and name entry pairs, orphan MDT-object, incorrect
+MDT-object links count, corrupted namespace, corrupted or lost lov EA, lost
+OST-object, multiple referenced OST-object, unmatched MDT-object and OST-object
+pairs, orphan OST-object, and so on.
+
+See also:
+
+.PP
+\fBlctl-lfsck-start\fR(8)
+.RS 4
+Start LFSCK on the specified MDT or OST device with specified parameters.
+.RE
+.PP
+\fBlctl-lfsck-stop\fR(8)
+.RS 4
+Stop LFSCK on the specified MDT or OST device.
+.RE
+.PP
+\fBlctl-lfsck-query\fR(8)
+.RS 4
+Get the LFSCK global status via the specified MDT device.
+.RE
+
+.SS BARRIER
+The tools set for write (modify) barrier on all MDTs. For detail, please see:
+.PP
+\fBlctl-barrier\fR(8)
+.RS 4
+
+.SS SNAPSHOT
+ZFS backend based snapshot tools set. The tool loads system configuration
+from the file
+.B /etc/ldev.conf
+on the MGS, and call related ZFS commands to
+maintain Lustre snapshot pieces on all targets (MGS/MDT/OST).
+The configuration file
+.B /etc/ldev.conf
+is not only for snapshot, but also
+for other purpose. The format is:
+ <host> foreign/- <label> <device> [journal-path]/- [raidtab]
+
+The format of
+.I <label>
+is:
+ fsname-<role><index> or <role><index>
+
+The format of
+.I <device>
+is:
+ [md|zfs:][pool_dir/]<pool>/<filesystem>
+
+Snapshot only uses the fields <host>, <label> and <device>.
+
.br
-obdmd:
+.B Example:
.br
-lctl > disconnect
+.B
+# cat /etc/ldev.conf
.br
-Finished (success)
+ host-mdt1 - myfs-MDT0000 zfs:/tmp/myfs-mdt1/mdt1
+ host-mdt2 - myfs-MDT0001 zfs:myfs-mdt2/mdt2
+ host-ost1 - OST0000 zfs:/tmp/myfs-ost1/ost1
+ host-ost2 - OST0001 zfs:myfs-ost2/ost2
+
+See also:
+
+.PP
+\fBlctl-snapshot-create\fR(8)
+.RS 4
+Create snapshot with the given name.
+.RE
+.PP
+\fBlctl-snapshot-destroy\fR(8)
+.RS 4
+Destroy the specified snapshot.
+.RE
+.PP
+\fBlctl-snapshot-modify\fR(8)
+.RS 4
+Modify the specified snapshot.
+.RE
+.PP
+\fBlctl-snapshot-list\fR(8)
+.RS 4
+Query the snapshot information.
+.RE
+.PP
+\fBlctl-snapshot-mount\fR(8)
+.RS 4
+Mount the specified snapshot.
+.RE
+.PP
+\fBlctl-snapshot-umount\fR(8)
+.RS 4
+Umount the specified snapshot.
+.RE
-.B setup
+.SS Debug
+.TP
+.BI debug_daemon
+Start and stop the debug daemon, and control the output filename and size.
+.TP
+.BI debug_kernel " [file] [raw]"
+Dump the kernel debug buffer to stdout or file.
+.TP
+.BI debug_file " <input> [output]"
+Convert kernel-dumped debug log from binary to plain text format.
+.TP
+.BI clear
+Clear the kernel debug buffer.
+.TP
+.BI mark " <text>"
+Insert marker text in the kernel debug buffer.
+.TP
+.BI filter " <subsystem id/debug mask>"
+Filter kernel debug messages by subsystem or mask.
+.TP
+.BI show " <subsystem id/debug mask>"
+Show specific type of messages.
+.TP
+.BI debug_list " <subs/types>"
+List all the subsystem and debug types.
+.TP
+.BI modules " <path>"
+Provide gdb-friendly module information.
-lctl > setup /dev/loop0 extN
+.SH OPTIONS
+The following options can be used to invoke lctl.
+.TP
+.B --device
+The device to be used for the operation. This can be specified by name or
+number. See
+.B device_list
+.TP
+.B --ignore_errors | ignore_errors
+Ignore errors during script processing
+.TP
+.B lustre_build_version
+Output the build version of the Lustre kernel modules
+.TP
+.B --version
+Output the build version of the lctl utility
+.TP
+.B --list-commands
+Output a list of the commands supported by the lctl utility
+.TP
+.B help
+Provides brief help on the various arguments
+.TP
+.B exit/quit
+Quit the interactive lctl session
+
+.SH EXAMPLES
+# lctl
+.br
+lctl > dl
+ 0 UP mgc MGC192.168.0.20@tcp bfbb24e3-7deb-2ffa-eab0-44dffe00f692 5
+ 1 UP ost OSS OSS_uuid 3
+ 2 UP obdfilter testfs-OST0000 testfs-OST0000_UUID 3
+.br
+lctl > dk /tmp/log
+Debug log: 87 lines, 87 kept, 0 dropped.
.br
lctl > quit
-.SH BUGS
-None are known.
+.SH AVAILABILITY
+.B lctl
+is part of the
+.BR lustre (7)
+filesystem package.
+.SH SEE ALSO
+.BR lustre (7),
+.BR mkfs.lustre (8),
+.BR mount.lustre (8),
+.BR lctl (8),
+.BR lctl-barrier (8),
+.BR lctl-lcfg (8),
+.BR lctl-get_param (8),
+.BR lctl-lfsck-start (8),
+.BR lctl-lfsck-stop (8),
+.BR lctl-lfsck-query (8),
+.BR lctl-list_param (8),
+.BR lctl-set_param (8),
+.BR lctl-snapshot-create (8),
+.BR lctl-snapshot-destroy (8),
+.BR lctl-snapshot-modify (8),
+.BR lctl-snapshot-list (8),
+.BR lctl-snapshot-mount (8),
+.BR lctl-snapshot-umount (8),
+.BR lctl-llog_catlist (8),
+.BR lctl-llog_info (8),
+.BR lctl-llog_print (8),
+.BR lctl-network (8),
+.BR lctl-nodemap-activate (8),
+.BR lctl-nodemap-add-idmap (8),
+.BR lctl-nodemap-add-range (8),
+.BR lctl-nodemap-add (8),
+.BR lctl-nodemap-del-idmap (8),
+.BR lctl-nodemap-del-range (8),
+.BR lctl-nodemap-del (8),
+.BR lctl-nodemap-modify (8),
+.BR lctl-pcc (8),
+.BR lfs (1)
git://git.whamcloud.com / fs / lustre-release.git / blobdiff