X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;ds=sidebyside;f=lustre%2Fdoc%2Flctl.8;h=64d147c3cb1e0d6b64ae7a9d9cd875dc7d5d09da;hb=05e6ccd344e7eba44e43230fa2fa0a1b3b6115c4;hp=c5042bda0199d173295ce46391d45f060f5da45b;hpb=3f7c5d26e6c14e4fb7575ee0b983133adf5e9a05;p=fs%2Flustre-release.git diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index c5042bd..64d147c 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -1,6 +1,6 @@ -.TH lctl 8 "2017 Jan 12" 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 @@ -39,6 +39,12 @@ command, type 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 > @@ -53,7 +59,7 @@ Print all Network Identifiers on the local node. LNET must be running. From a list of nids for a remote node, show which interface communication will take place on. .TP -.BI replace_nids " [,nid2,nid3 ...]" +.BI replace_nids " [,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. @@ -62,6 +68,8 @@ in another cases). To start the MGS service only: mount -t lustre -o nosvc 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 " timeout" Check LNET connectivity via an LNET ping. This will use the fabric @@ -98,137 +106,14 @@ Show all the local Lustre OBDs. AKA .PP .SS Device Operations .TP -.BI list_param " [-F|-R] " -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] " -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] " -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] .=" Set a permanent configuration parameter for any device via the MGS. This command must be run on the MGS node. .br .B -d . -Delete a parameter setting (use the default value at the next restart). A null value for also deletes the parameter setting. +Delete a parameter setting (use the default value at the next restart). +A null value for also deletes the parameter setting. This is +useful if an incorrect or obsolete parameter is in the configuration. .br .B Parameters: .br @@ -257,6 +142,8 @@ Additionally, failover nodes may be added (or removed), and some system-wide par # 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 @@ -273,18 +160,21 @@ communication with the failed OST. 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 " " -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 @@ -349,7 +239,26 @@ Delete an existing UID or GID mapping from a nodemap. .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 " " +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, @@ -377,73 +286,37 @@ Stop LFSCK on the specified MDT or OST device. .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. -.TP -.B barrier_freeze \fR [timeout] -.br -Set write barrier on all MDTs. The barrier_freeze command will not return -until the barrier is set (frozen) or failed. With the write barrier set, -any subsequent metadata modification will be blocked until the barrier is -thawed or expired. The barrier lifetime is started when triggering -barrier_freeze, and will be terminated when barrier thawed. To avoid the -system being frozen for very long time if miss/fail to call barrier_thaw, -you can specify its lifetime via the 'timeout' parameter in second, the -default value is 60 (seconds). If the barrier is not thawed before that, -it will be expired automatically. -A barrier_freeze can only succeed when all registered MDTs are available. -If some MDT has ever registered but become offline, then barrier_freeze -will fail. To check and update current status of MDTs, see the command -barrier_rescan. -.TP -.B barrier_thaw \fR -.br -Reset write barrier on all MDTs. With the write barrier thawed, all blocked -metadata modifications (by the former barrier_freeze) will be handled normally. -.TP -.B barrier_stat \fR -.br -Query the write barrier status, the possible status and related meanings are -as following: -.br - 'init': has never set barrier on the system - 'freezing_p1': in the first stage of setting the write barrier - 'freezing_p2': in the second stage of setting the write barrier - 'frozen': the write barrier has been set successfully - 'thawing': in thawing the write barrier - 'thawed': the write barrier has been thawed - 'failed': fail to set write barrier - 'expired': the write barrier is expired - 'rescan': in scanning the MDTs status, see the command barrier_rescan - 'unknown': other cases -.br -If the barrier is in 'freezing_p1', 'freezing_p2' or 'frozen' status, then -the left lifetime will be returned also. -.TP -.B barrier_rescan \fR [timeout] -.br -Scan the system to check which MDTs are active. The status of the MDTs is -required because a barrier_freeze will be unsuccessful if any of the MDTs -are permenantly offline. During barrier_rescan, the MDT status is updated. -If an MDT does not respond the barrier_rescan within the given "timeout" -seconds (where the default value is 60 seconds), then it will be marked -as unavailable or inactive. +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 /etc/ldev.conf on the MGS, and call related ZFS commands to +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 /etc/ldev.conf is not only for snapshot, but also +The configuration file +.B /etc/ldev.conf +is not only for snapshot, but also for other purpose. The format is: foreign/-