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