X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;f=lustre%2Fdoc%2Flctl.8;h=4cd0e099c06f464f799d012fce22686165391ed3;hb=9bf46408b3c2c8b7f939d7000a9e8df38c3fd6ed;hp=9e2b52a510e5f21874a0e8dbbbe411fcd61d72c4;hpb=5e546603cbff0939c9f6335d9daddc641530dd7e;p=fs%2Flustre-release.git diff --git a/lustre/doc/lctl.8 b/lustre/doc/lctl.8 index 9e2b52a..4cd0e09 100644 --- a/lustre/doc/lctl.8 +++ b/lustre/doc/lctl.8 @@ -56,6 +56,16 @@ 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 ...]" +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 -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 " " Check LNET connectivity via an LNET ping. This will use the fabric appropriate to the specified NID. @@ -92,6 +102,127 @@ 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 " [-n|-N|-F] " +Get the value of Lustre or LNET parameter. +.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 -F +When -N specified, add '/', '@' or '=' for directories, symlinks and writeable files, respectively. +.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. @@ -162,8 +293,94 @@ will not be purged beyond any registered users' set point. (See lfs changelog_cl .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. +next minimum. .PP +.SS LFSCK +An on-line Lustre consistency check and repair tool. +.TP +.B lfsck_start \fR<-M | --device [MDT,OST]_device> + \fR[-A | --all] [-c | --create_ostobj [on | off]] + \fR[-e | --error ] [-h | --help] + \fR[-n | --dryrun [on | off]] [-o | --orphan] + \fR[-r | --reset] [-s | --speed speed_limit] + \fR[-t | --type lfsck_type[,lfsck_type...]] + \fR[-w | --window_size size] +.br +Start LFSCK on the specified MDT or OST device with specified parameters. +.TP + -M, --device +The MDT or OST device to start LFSCK/scrub on. +.TP + -A, --all +Start LFSCK on all available MDT devices. +.TP + -c, --create_ostobj [on | off] +Create the lost OST-object for dangling LOV EA: 'off' (default) or 'on'. Under +default mode, when the LFSCK find some MDT-object with dangling reference, it +will report the inconsistency but will not repair it. If 'on' is given, then +LFSCK will re-create the missed OST-object. +.TP + -e, --error +With error_handle as 'abort' then if a repair is impossible LFSCK will save +the current position stop with an error. Otherwise the default behavior is +to 'continue' if a repair is impossible. +.TP + -h, --help +Show the usage message. +.TP + -n, --dryrun [on | off] +Perform a trial run with no changes made, if 'on' or no argument is given. +Default is 'off', meaning that any inconsistencies found will be repaired. +.TP + -o, --orphan +Handle orphan objects, such as orphan OST-objects for layout LFSCK by +linking them under the .../.lustre/lost+found directory. +.TP + -r, --reset +Set the current position of object iteration to the beginning of the specified +device. The non-specified parameters will also be reset to the default. By +default the iterator will resume the scanning from the last saved checkpoint +position, and other unspecified parameters will be the same as the prior +incomplete run. +.TP + -s, --speed +Set the upper limit of LFSCK processing in objects per second to reduce load +on the servers and storage. If no value is specified the saved value is used +(if resuming from a checkpoint). Otherwise the default value of 0 is used, +which means check the filesystem as quickly as possible. +.TP + -t, --type +The type of LFSCK checking/repair to execute. If no type is given and the +previous run was incomplete or internal consistency checks detected an error, +then the same types are used for the next run. Otherwise, the default is to +check all types of consistency. Any time LFSCK is triggered on an ldiskfs +MDT or OST then OI Scrub is run. Valid types are a comma-separated list of one or more of +.B scrub +to run only the local OI Scrub on ldiskfs targets, +.B namespace +for FID-in-dirent and linkEA checking on the MDT(s), +.B layout +for MDT-OST cross-reference consistency, and +.B all +to run all of the available check types. +.TP + -w, --window_size +Specifies the maximum number of in-flight request being processed at +one time. This controls the load placed on remote OSTs when running +.B layout +checks. By default there are at most 1024 outstanding requests. +.TP +.B lfsck_stop \fR<-M | --device [MDT,OST]_device> [-A | --all] [-h | --help] +Stop LFSCK on the specified MDT or OST device. +.TP + -M, --device <[MDT,OST]_device> +The MDT or OST device to stop LFSCK/scrub on. +.TP + -A, --all +Stop LFSCK on all devices. +.TP + -h, --help +Show this help. .SS Debug .TP .BI debug_daemon @@ -203,6 +420,18 @@ number. See .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 help +Provides brief help on the various arguments +.TP +.B exit/quit +Quit the interactive lctl session .SH EXAMPLES # lctl @@ -217,15 +446,11 @@ Debug log: 87 lines, 87 kept, 0 dropped. .br lctl > quit -.SH BUGS -Please report all bugs to Sun Microsystems, Inc. http://bugzilla.lustre.org/ .SH AVAILABILITY .B lctl is part of the .BR Lustre (7) -filesystem package and is available from Sun Microsystems, Inc. -.br -http://www.sun.com/software/products/lustre/index.xml +filesystem package. .SH SEE ALSO .BR Lustre (7), .BR mkfs.lustre (8),