Whamcloud - gitweb
b2aa2d7afe4ea63fbb049ab6289b3f1ffec8ca22
[fs/lustre-release.git] / lustre / doc / lctl-lfsck-start.8
1 .TH lctl-lfsck-start 8 "2016 Apr 1" Lustre "Lustre online fsck"
2 .SH SYNOPSIS
3 .br
4 .B lctl lfsck_start \fR[-M | --device [MDT,OST]_device]
5      \fR[-A | --all] [-c | --create-ostobj [on | off]]
6      \fR[-C | --create-mttobj [on | off]]
7      \fR[-e | --error <continue | abort>] [-h | --help]
8      \fR[-n | --dryrun [on | off]] [-o | --orphan]
9      \fR[-r | --reset] [-s | --speed speed_limit]
10      \fR[-t | --type lfsck_type[,lfsck_type...]]
11      \fR[-w | --window-size size]
12 .br
13 .SH DESCRIPTION
14 Start LFSCK on the specified MDT or OST device with specified parameters.
15 .SH OPTIONS
16 .TP
17 .B  -M, --device <MDT,OST_device>
18 The MDT or OST device to start LFSCK/scrub on. If "-M" option is not specified,
19 it will select the available Lustre device on current server automatically.
20 But under the following cases you need to specify the device (see "-M" option)
21 explicitly: if there are multiple devices on current server those belong to
22 different Lustre filesystems, or if "-A" option is not specified and there are
23 multiple devices on current server.
24 .TP
25 .B  -A, --all
26 Start LFSCK on all available devices in the system by single LFSCK command.
27 Such LFSCK command can be executed on any MDT deivce in the system.
28 .TP
29 .B  -c, --create-ostobj [on | off]
30 Create the lost OST-object for dangling LOV EA: 'off' (default) or 'on'. Under
31 default mode, when the LFSCK find some MDT-object with dangling reference, it
32 will report the inconsistency but will not repair it.  If 'on' is given, then
33 LFSCK will re-create the missed OST-object.
34 .TP
35 .B  -C, --create-mdtobj [on | off]
36 Create the lost MDT-object for dangling name entry: 'off' (default) or 'on'.
37 Under default mode, when the LFSCK find dangling name entry, it will report
38 the inconsistency but will not repair it.  If 'on' is given, then LFSCK will
39 re-create the missed MDT-object.
40 .TP
41 .B  -e, --error <error_handle>
42 With error_handle as 'abort' then if the repair of a file is not possible, then
43 LFSCK will save the current position stop with an error.  Otherwise the default
44 behavior is to 'continue' if the repair of a file is not possible.
45 .TP
46 .B  -h, --help
47 Show the usage message.
48 .TP
49 .B  -n, --dryrun [on | off]
50 Perform a trial run with no changes made, if 'on' or no argument is given.
51 Default is 'off', meaning that any inconsistencies found will be repaired.
52 .TP
53 .B  -o, --orphan
54 Handle orphan objects, such as orphan OST-objects for layout LFSCK by
55 linking them under the .../.lustre/lost+found directory.
56 .TP
57 .B  -r, --reset
58 Set the current position of object iteration to the beginning of the specified
59 device. The non-specified parameters will also be reset to the default. By
60 default the iterator will resume the scanning from the last saved checkpoint
61 position, and other unspecified parameters will be the same as the prior
62 incomplete run.
63 .TP
64 .B  -s, --speed <speed_limit>
65 Set the upper limit of LFSCK processing in objects per second to reduce load
66 on the servers and storage. If no value is specified the saved value is used
67 (if resuming from a checkpoint). Otherwise the default value of 0 is used,
68 which means check the filesystem as quickly as possible.
69 .TP
70 .B  -t, --type <lfsck_type[,lfsck_type...]>
71 The type of LFSCK checking/repair to execute. If no type is given and the
72 previous run was incomplete or internal consistency checks detected an error,
73 then the same types are used for the next run. Otherwise, the default is to
74 check all types of consistency. Any time LFSCK is triggered on an ldiskfs
75 MDT or OST then OI Scrub is run. Valid types are a comma-separated list of one or more of:
76 .B scrub
77 to run only the local OI Scrub on ldiskfs targets,
78 .B namespace
79 for FID-in-dirent and linkEA checking on the MDT(s),
80 .B layout
81 for MDT-OST cross-reference consistency, and
82 .B all
83 to run all of the available check types.
84 .TP
85 .B  -w, --window-size <size>
86 Specifies the maximum number of in-flight request being processed at
87 one time.  This controls the load placed on remote OSTs when running
88 .B layout
89 checks.  By default there are at most 1024 outstanding requests.
90
91 .SH AVAILABILITY
92 .B lctl
93 is part of the
94 .BR Lustre (7)
95 filesystem package.
96 .SH SEE ALSO
97 .BR lustre (7),
98 .BR lctl-lfsck-stop (8),
99 .BR lctl-lfsck-query (8)