X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flctl.8;h=7954b7ca5feebdb5923c1f873b9f5994ef005ce5;hb=31a690291b077646d6f42e0c90ce81bb3938deda;hp=8a248f07b1889618bca3748aaf1ef96f24744ec0;hpb=9f0a59237e9ed5ffa56d6e6bb7ea95fb3d232bea;p=fs%2Flustre-release.git diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index 8a248f0..7954b7c 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -1,4 +1,4 @@ -.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 @@ -7,44 +7,47 @@ lctl \- Low level Lustre filesystem configuration utility .br .B lctl --device .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 various configuration, maintenance, and debugging features to be accessed. - + .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 -.B dl -, -.B dk -, -.B device -, -.B network -.I -, -.B list_nids -, +.BR dl , +.BR dk , +.BR device , +.B network +.IR , +.BR list_nids , .B ping -.I nid -, -.B help -, -.B quit. +.IR nid , +.BR help , +.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 +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. +. Command completion is activated with the TAB key, and command history is available via the up- and down-arrow keys. -For non-interactive use, one uses the second invocation, which runs command after connecting to the device. +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 -.BI network " |" +.BR network " <" up / down >|< tcp / o2ib > Start or stop LNET, or select a network type for other .I lctl LNET commands @@ -66,39 +69,41 @@ 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'. .TP -.BI ping " " +.BI ping " 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 +.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 +.BI peer_list +Print the known peers for a given .B network type. .TP -.BI conn_list +.BI conn_list Print all the connected remote NIDs for a given .B network type. -.TP -.BI route_list +.TP +.BI route_list Print the complete routing table. .PP .SS Device Selection -.TP -.BI device " " -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 +.TP +.BI device " " +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 +.TP .BI list_param " [-F|-R] " List the Lustre or LNet parameter name .B -F @@ -224,18 +229,29 @@ Remove the permanent setting (only with -P option) # lctl set_param -P osc.*.max_dirty_mb=32 .br .TP +.BI "set_param -F " +.br +Apply configuration file specified by +.br +File is in YAML format, created as an output from +\fBlctl --device MGS llog_print -client\fR or any other valid +llog_file from the output of \fBlctl --device MGS llog_catlist\fR +.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 -All of the writable parameters under +All of the writable parameters under .B lctl list_param -(e.g. +(e.g. .I lctl list_param -F osc.*.* | grep = ) can be permanently set using .B lctl conf_param @@ -244,46 +260,36 @@ All of the writable parameters under 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.) is ignored for system wide parameters. .br .B Examples: -.br +.br # lctl conf_param testfs.sys.at_max=1200 .br -# lctl conf_param testfs.llite.max_read_ahead_mb=16 +# lctl conf_param testfs.llite.max_read_ahead_mb=16 .br # lctl conf_param testfs-MDT0000.lov.stripesize=2M .br -# lctl conf_param lustre-OST0001.osc.active=0 +# lctl conf_param lustre-OST0001.osc.active=0 .br -# lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15 +# lctl conf_param testfs-OST0000.osc.max_dirty_mb=29.15 .br -# lctl conf_param testfs-OST0000.ost.client_cache_seconds=15 +# lctl conf_param testfs-OST0000.ost.client_cache_seconds=15 .br # lctl conf_param testfs-OST0000.failover.node=1.2.3.4@tcp1 -.TP -.BI activate -Reactivate an import after deactivating, below. This setting is only effective until the next restart (see +.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 .B conf_param ). -.TP -.BI deactivate +.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 Virtual Block Device Operation -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. -.TP -.BI blockdev_attach " " -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. .TP -.BI blockdev_detach " " -Detach the virtual block device. -.TP -.BI blockdev_info " " -Acquire which lustre file was attached to the device node. +.BI abort_recovery +Abort the recovery process on a restarting MDT or OST device .PP .SS Changelogs .TP @@ -362,7 +368,16 @@ Delete an existing UID or GID mapping from a nodemap. .RS 4 Modify a nodemap property. .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, @@ -390,44 +405,119 @@ 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. 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: + foreign/-