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