-.TH lctl 1 "2016 Sep 8" Lustre "configuration utilities"
+.TH LCTL 8 "2019-06-16" Lustre "configuration utilities"
.SH NAME
-lctl \- Low level Lustre filesystem configuration utility
+lctl \- Lustre filesystem administrator configuration tool
.SH SYNOPSIS
.br
.B lctl
.br
.B lctl --device <devno> <command [args]>
.br
+.B lctl --version
+.br
+.B lctl --list-commands
+.br
.SH DESCRIPTION
.B lctl
is used to directly control Lustre via an ioctl interface, allowing
.BR quit .
To get a complete listing of available commands, type
-.B help
+.B --list-commands
at the lctl prompt. To get basic help on the meaning and syntax of a
command, type
.B help
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
+\fBlctl-lcfg\fR(8)
+.RS 4
+
.SS Network Configuration
.TP
.BR network " <" up / down >|< tcp / o2ib >
From a list of nids for a remote node, show which interface communication
will take place on.
.TP
-.BI replace_nids " <devicename> <nid1>[,nid2,nid3 ...]"
+.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.
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> "
+.BI ping " <nid> timeout"
Check LNET connectivity via an LNET ping. This will use the fabric
-appropriate to the specified NID.
+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
.PP
.SS Device Operations
.TP
-.BI list_param " [-F|-R] <param_search ...>"
-List the Lustre or LNet parameter name
-.B -F
-Add '/', '@' or '=' for dirs, symlinks and writeable files, respectively.
-.br
-.B -R
-Recursively list all parameters under the specified parameter search string. If
-.I param_search
-is unspecified, all the parameters will be shown.
-.br
-.B Examples:
-.br
-.B
-# lctl list_param ost.*
-.br
- ost.OSS
-.br
- ost.num_refs
-.br
-.B
-# lctl list_param -F ost.* debug
-.br
- ost.OSS/
-.br
- ost.num_refs
-.br
- debug=
-.br
-.B
-# lctl list_param -R mdt
-.br
- mdt
-.br
- mdt.lustre-MDT0000
-.br
- mdt.lustre-MDT0000.capa
-.br
- mdt.lustre-MDT0000.capa_count
-.br
- mdt.lustre-MDT0000.capa_key_timeout
-.br
- mdt.lustre-MDT0000.capa_timeout
-.br
- mdt.lustre-MDT0000.commit_on_sharing
-.br
- mdt.lustre-MDT0000.evict_client
-.br
- ...
-.TP
-.BI get_param " [-F|-n|-N|-R] <parameter ...>"
-Get the value of Lustre or LNET parameter.
-.br
-.B -F
-When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively.
-.br
-.br
-.B -n
-Print only the value and not parameter name.
-.br
-.B -N
-Print only matched parameter names and not the values. (Especially useful when using patterns.)
-.br
-.B -R
-Print all of the parameter names below the specified name.
-.br
-.B Examples:
-.br
-.B
-# lctl get_param ost.*
-.br
- ost.OSS
-.br
- ost.num_refs
-.br
-.B
-# lctl get_param -n debug timeout
-.br
- super warning dlmtrace error emerg ha rpctrace vfstrace config console
-.br
- 20
-.br
-.B
-# lctl get_param -N ost.* debug
-.br
- ost.OSS
-.br
- ost.num_refs
-.br
- debug
-.br
-lctl "get_param -NF" is equivalent to "list_param -F".
-.TP
-.BI set_param " [-n] [-P] [-d] <parameter=value ...>"
-Set the value of Lustre or LNET parameter.
-.br
-.B -n
-Disable printing of the key name when printing values.
-.br
-.B -P
-Set the parameter permanently, filesystem-wide.
-This parameters are only visible to 2.5.0 and later clients, older clients will not see these parameters.
-.br
-.B -d
-Remove the permanent setting (only with -P option)
-.br
-.B Examples:
-.br
-.B
-# lctl set_param fail_loc=0 timeout=20
-.br
- fail_loc=0
-.br
- timeout=20
-.br
-.B
-# lctl set_param -n fail_loc=0 timeout=20
-.br
- 0
-.br
- 20
-.br
-.B
-# lctl set_param -P osc.*.max_dirty_mb=32
-.br
-.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
.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.
+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
.B Parameters:
.br
# lctl conf_param testfs-OST0000.ost.client_cache_seconds=15
.br
# lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1
+.br
+# 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
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
-.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.
+Changelog user can be registered and deregistered on particular device.
+Changelog starts logging when any user is registered.
+
+For more details see:
+
+.PP
+\fBlctl-changelog_register\fR(8)
+.RS 4
+Register a new changelog user on specified MDT device with specified parameters.
+.RE
+.PP
+\fBlctl-changelog_deregister\fR(8)
+.RS 4
+Deregister an existing changelog user on the specified MDT.
+
.PP
.SS Nodemap
An identity mapping feature that facilitates mapping of client UIDs and GIDs to
.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,
.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
+.B Example:
+.br
+.B
+# cat /etc/ldev.conf
+.br
+ 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
+
.SS Debug
.TP
.BI debug_daemon
.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
.SH AVAILABILITY
.B lctl
is part of the
-.BR Lustre (7)
+.BR lustre (7)
filesystem package.
.SH SEE ALSO
+.BR lfs (1)
.BR lustre (7),
-.BR mkfs.lustre (8),
-.BR mount.lustre (8),
.BR lctl (8),
+.BR lctl-barrier (8),
+.BR lctl-changelog_deregister (8),
+.BR lctl-changelog_register (8),
+.BR lctl-get_param (8),
+.BR lctl-lcfg (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 (8),
.BR lctl-nodemap-add-idmap (8),
.BR lctl-nodemap-add-range (8),
-.BR lctl-nodemap-add (8),
+.BR lctl-nodemap-del (8),
.BR lctl-nodemap-del-idmap (8),
.BR lctl-nodemap-del-range (8),
-.BR lctl-nodemap-del (8),
.BR lctl-nodemap-modify (8),
-.BR lfs (1)
+.BR lctl-pcc (8),
+.BR mkfs.lustre (8),
+.BR mount.lustre (8),
git://git.whamcloud.com / fs / lustre-release.git / blobdiff