Whamcloud - gitweb
ba93482cf2fd6d93f00d89b31de732fad9fcf931
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2017 Jan 12" Lustre "user utilities"
2 .SH NAME
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of existing files, do certain quota operations, and manage distributed namespace options for directories
4 .SH SYNOPSIS
5 .br
6 .B lfs
7 .br
8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
9 .br
10 .B lfs changelog_clear <mdtname> <id> <endrec>
11 .br
12 .B lfs check <mds|osts|servers>
13 .br
14 .B lfs data_version [-n] \fB<filename>\fR
15 .br
16 .B lfs df [-ihlv] [--pool|-p <fsname>[.<pool>]] [path]
17 .br
18 .B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
19 .br
20 .B lfs find <directory|filename>
21         \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N]
22         \fB[--maxdepth|-D N] [[!] --mdt|-m <uuid|index,...>] [--name|-n pattern]
23         \fB[[!] --ost|-O <uuid|index,...>] [--print|-p] [--print0|-P]
24         \fB[[!] --size|-s [-+]N[kMGTPE]]
25         \fB[[!] --stripe-count|-c [+-]<stripes>]
26         \fB[[!] --stripe-index|-i <index,...>]
27         \fB[[!] --stripe-size|-S [+-]N[kMG]]
28         \fB[[!] --layout|-L raid0,released]
29         \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
30         \fB[[!] --uid|-u|--user|-U <uname>|<uid>] [[!] --pool <pool>]\fR
31 .br
32 .B lfs getname [-h]|[path ...]
33 .br
34 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
35         \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M] [--fid|-F]
36         \fB[--stripe-size|-S] [--directory|-d] [--layout|-L] [--generation|-g]
37         \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
38 .br
39 .B lfs migrate \fB-m <mdt_index>\fR
40 .IR directory
41 .br
42 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
43                [\fB-i | --stripe-index <start_ost_idx>\fR]
44                [\fB-S | --stripe-size <stripe_size>\fR]
45                [\fB-p | --pool <pool_name>\fR]
46                [\fB-o | --ost-list <ost_indices>\fR]
47                [\fB-b | --block\fR]
48                [\fB-n | --non-block\fR]
49 .IR file|directory
50 .br
51 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
52              [\fB-i | --index <mdt_idx>\fR]
53              [\fB-h | --hash-type <hash_name>\fR]
54              [\fB-m | --mode <mode>\fR]
55              [\fB-D | --default\fR]
56 .IR directory
57 .br
58 .B lfs osts
59 .RB [ path ]
60 .br
61 .B lfs mdts
62 .RB [ path ]
63 .br
64 .B lfs path2fid [--parents] <path> ...
65 .br
66 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
67 .br
68 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
69 .br
70 .B lfs quota -t <-u|-g> <filesystem>
71 .br
72 .B lfs quotacheck [-ug] <filesystem>
73 .br
74 .B lfs quotaon [-ugf] <filesystem>
75 .br
76 .B lfs quotaoff [-ug] <filesystem>
77 .br
78 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
79              \fB[--block-softlimit <block-softlimit>]
80              \fB[--block-hardlimit <block-hardlimit>]
81              \fB[--inode-softlimit <inode-softlimit>]
82              \fB[--inode-hardlimit <inode-hardlimit>]
83              \fB<filesystem>\fR
84 .br
85 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
86              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
87              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
88              \fB<filesystem>\fR
89 .br
90 .B lfs setquota -t <-u|-g>
91              \fB[--block-grace <block-grace>]\fR
92              \fB[--inode-grace <inode-grace>]\fR
93              \fB<filesystem>\fR
94 .br
95 .B lfs setquota -t <-u|-g>
96              \fB[-b <block-grace>] [-i <inode-grace>]\fR
97              \fB<filesystem>\fR
98 .br
99 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
100         \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
101         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
102 .br
103 .B lfs setstripe -d <dir>
104 .br
105 .B lfs --version
106 .br
107 .B lfs --list-commands
108 .br
109 .B lfs help
110 .SH DESCRIPTION
111 .B lfs
112 can be used to create a new file with a specific striping pattern, determine
113 the default striping pattern, gather the extended attributes (object numbers
114 and location) for a specific file. It can be invoked interactively without any
115 arguments or in a non-interactive mode with one of the arguments supported.
116 .SH OPTIONS
117 The various options supported by lfs are listed and explained below:
118 .TP
119 .B changelog
120 Show the metadata changes on an MDT.  Start and end points are optional.  The --follow option will block on new changes; this option is only valid when run direclty on the MDT node.
121 .TP
122 .B changelog_clear
123 Indicate that changelog records previous to <endrec> are no longer of
124 interest to a particular consumer <id>, potentially allowing the MDT to
125 free up disk space. An <endrec> of 0 indicates the current last record.
126 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
127 .TP
128 .B check
129 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
130 .TP
131 .B df
132 See
133 .BR lfs-df (1)
134 for details of
135 .B lfs df
136 usage.
137 .TP
138 .B find
139 To search the directory tree rooted at the given dir/file name for the files that match the given parameters: \fB--atime\fR (file was last accessed N*24 hours ago), \fB--ctime\fR (file's status was last changed N*24 hours ago), \fB--mtime\fR (file's data was last modified N*24 hours ago), \fB--obd\fR (file has an object on a specific OST or OSTs), \fB--size\fR (file has size in bytes, or \fBk\fRilo-, \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes if a suffix is given), \fB--type\fR (file has the type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory, \fBp\fRipe, \fBf\fRile, sym\fBl\fRink, \fBs\fRocket, or \fBD\fRoor (Solaris)), \fB--uid\fR (file has specific numeric user ID), \fB--user\fR (file owned by specific user, numeric user ID allowed), \fB--gid\fR (file has specific group ID), \fB--group\fR (file belongs to specific group, numeric group ID allowed), \fB--layout\fR (file has a raid0 layout or is released). The option \fB--maxdepth\fR limits find to decend at most N levels of directory tree. The options \fB--print\fR and \fB--print0\fR print full file name, followed by a newline or NUL character correspondingly.  Using \fB!\fR before an option negates its meaning (\fIfiles NOT matching the parameter\fR).  Using \fB+\fR before a numeric value means \fIfiles with the parameter OR MORE\fR, while \fB-\fR before a numeric value means \fIfiles with the parameter OR LESS\fR.
140 .TP
141 .B getname [-h]|[path ...]
142 Report all the Lustre mount points and the corresponding Lustre filesystem
143 instance. If one or more \fBpath\fR entries are provided, then only the
144 Lustre instance for these mount points is returned. If the path given is not on
145 a Lustre instance 'No such device' is reported.
146 .TP
147 .B osts
148 .RB [ path ]
149 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
150 that is located on a lustre mounted file system then only the OSTs belonging
151 to that filesystem are displayed.
152 .TP
153 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
154         \fB[--count | -c ] [--index | -i | --offset | -o  ]
155         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
156         \fB[--layout | -L ] [--fid | -F ] [--generation | -g ]
157         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
158 .br
159 List the striping information for a given filename or directory tree.
160 By default the stripe count, size, and offset will be returned. If you
161 only want specific striping information then the options of
162 .BR --count ,
163 .BR --size ,
164 .BR --index ,
165 .BR --offset ,
166 .BR --layout ,
167 .BR --fid ,
168 .BR --generation ,
169 or
170 .B --pool
171 can be used to return only the specific fields.
172 .br
173 If the
174 .B --raw
175 option is specified, the stripe information is printed without substituting the
176 filesystem's default values for unspecified fields. If the striping EA is not
177 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
178 respectively.
179 In the case where you only want details about the files' object id
180 information then the
181 .B --quiet
182 option is used. Additional information available about striping can be
183 displayed with
184 .BR --verbose .
185 The default behavior when a directory is specified is to list the striping
186 information for all files within the specified directory (like
187 .RB ' "ls -l" ') .
188 This can be expanded with
189 .B --recursive
190 which will recurse into all subdirectories.
191 If you wish to get striping information for only the specified directory, then
192 .B --directory
193 can be used to limit the information, like
194 .RB ' "ls -d" ').
195 You can limit the returned files to those with objects on a specific OST with
196 .BR --obd .
197 To show only the FID use
198 .BR --fid .
199 The layout generation can be printed with the
200 .B --generation
201 option.
202 .TP
203 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
204         \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
205         \fB[--ost-index|-o <ost_indices>] <dirname|filename>\fR
206 .br
207 To create a new file, or set the directory default, with the specified striping
208 parameters.  The
209 .I stripe_count
210 is the number of OSTs to stripe a file over. A
211 .I stripe_count
212 of 0 means to use the filesystem-wide default stripe count (default 1), and a
213 .I stripe_count
214 of -1 means to stripe over all available OSTs.  The
215 .I stripe_size
216 is the number of bytes to store on each OST before moving to the next OST.  A
217 .I stripe_size
218 of 0 means to use the filesystem-wide default stripe_size (default 1MB).  The
219 .I start_ost_index
220 is the OST index (starting at 0) on which to start striping for this file.  A
221 .I start_ost_index
222 of -1 allows the MDS to choose the starting index and it is strongly
223 recommended, as this allows space and load balancing to be done by the MDS as
224 needed. The
225 .B -o
226 option is used to specify the exact stripe layout on the file system.
227 .I ost_indices
228 is a list of OSTs referenced by their indices, which are specified in decimal
229 or hex form and can be obtained using the
230 .B lfs osts
231 command. The list format consists of individual OST indices and index ranges
232 separated by commas, e.g. 1,2-4,7. The
233 .B -o
234 option may be specified multiple times to stripe across the union of all listed
235 OSTs. If the
236 .B -c
237 option is combined with
238 .B -o
239 the
240 .I stripe_count
241 must agree with the number of OSTs in
242 .IR ost_indices .
243 If the
244 .B -i
245 option is combined with
246 .B -o
247 the
248 .I start_ost_index
249 must be in the OST list, and it will be used as the index on which to start
250 striping the file. Otherwise the striping will occur in the order specified in
251 .IR ost_indices .
252 The
253 .I poolname
254 is the name of a predefined pool of OSTs (see
255 .BR lctl (8))
256 that will be used for striping. The
257 .IR stripe_count ,
258 .IR stripe_size ,
259 and
260 .I start_ost_index
261 will be used as well; the
262 .I start_ost_index
263 must be part of the pool or an error will be returned.
264 .TP
265 .B setstripe -d
266 Delete the default striping on the specified directory.
267 .TP
268 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
269 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
270 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
271 hard links, then all of the pathnames for that file are printed, unless
272 \fB--link\fR limits the printing to only the specified link number (starting
273 at 0, in no particular order).  If multiple fids are specified, but only a
274 single pathname is needed for each file, use \fB--link 0\fR.
275 .TP
276 .B path2fid [--parents] <path> ...
277 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
278 are given, then they will be printed one per line with the path as prefix.
279 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
280 given entries. If an entry has multiple links, these are displayed on a single
281 line, tab-separated.
282 .TP
283 .B pool_list
284 .RI { filesystem }[ .poolname "] | {" pathname }
285 List the pools in
286 .I filesystem
287 or
288 .IR pathname ,
289 or the OSTs in
290 .IR filesystem.pool .
291 .TP
292 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
293 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name or an ID can be specified. If both user and group are omitted quotas for current uid/gid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles).
294 .TP
295 .B quota -t <-u|-g> <filesystem>
296 To display block and inode grace times for user (-u) or group (-g) quotas
297 .TP
298 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
299 To scan the specified filesystem for disk usage, and create or update quota files. Options specify quota for users (-u) groups (-g) and force (-f). Not useful anymore with servers >= 2.4.0 since space accounting is always turned on.
300 .TP
301 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
302 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement must be enabled via conf_param (e.g. lctl conf_param ${FSNAME}.quota.<ost|mdt>=<u|g|ug>)
303 .TP
304 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
305 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement can be turned off (for inode or block) by running the following command on the MGS: lctl conf_param ${FSNAME}.quota.<ost|mdt>=""
306 .TP
307 .B setquota  <-u|-g> <uname>|<uid>|<gname>|<gid> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
308 To set filesystem quotas for users or groups. Limits can be specified with -b, -k, -m, -g, -t, -p suffixes which specify units of 1, 2^10, 2^20, 2^30, 2^40 and 2^50 accordingly. Block limits unit is kilobyte (1024) by default and block limits are always kilobyte-grained (even if specified in bytes), see EXAMPLES
309 .TP
310 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
311 To set filesystem quota grace times for users or groups. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES
312 .TP
313 .B swap_layouts <filename1> <filename2>
314 Swap the data (layout and OST objects) of two regular files. The
315 two files have to be in the same filesystem, owned by the same user,
316 reside on the same MDT and writable by the user.
317
318 Swapping the layout of two directories is not permitted.
319 .TP
320 .B data_version [-n] <filename>
321 Display current version of file data. If -n is specified, data version is read
322 without taking lock. As a consequence, data version could be outdated if there
323 is dirty caches on filesystem clients, but this will not force data flushes and
324 has less impact on filesystem.
325
326 Even without -n, race conditions are possible and data version should be
327 checked before and after an operation to be confident the data did not change
328 during it.
329 .TP
330 .B mkdir
331 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
332 .B lfs setdirstripe
333 is an alias of the command
334 .B lfs mkdir
335 .TP
336 .B mv
337 lfs mv is deprecated, use lfs
338 .B migrate
339 instead.
340 .TP
341 .B migrate
342 See lfs-migrate(1).
343 .TP
344 .B --version
345 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
346 .TP
347 .B --list-commands
348 Output a list of the commands supported by the lfs utility
349 .TP
350 .B help
351 Provides brief help on the various arguments
352 .TP
353 .B exit/quit
354 Quit the interactive lfs session
355 .SH EXAMPLES
356 .TP
357 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
358 This creates a file striped on two OSTs with 128kB on each stripe.
359 .TP
360 .B $ lfs setstripe -d /mnt/lustre/dir
361 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
362 .TP
363 .B $ lfs getstripe -v /mnt/lustre/file1
364 Lists the detailed object allocation of a given file
365 .TP
366 .B $ lfs find /mnt/lustre
367 Efficiently lists all files in a given directory and its subdirectories
368 .TP
369 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
370 Recursively list all regular files in given directory more than 30 days old
371 .TP
372 .B $ lfs find --obd OST2-UUID /mnt/lustre/
373 Recursively list all files in a given directory that have objects on OST2-UUID.
374 .tP
375 .B $ lfs check servers
376 Check the status of all servers (MDT, OST)
377 .TP
378 .B $ lfs osts
379 List all the OSTs
380 .TP
381 .B $ lfs mdts
382 List all the MDTs
383 .TP
384 .B $ lfs quota -u bob /mnt/lustre
385 List quotas of user `bob'
386 .TP
387 .B $ lfs quota -t -u /mnt/lustre
388 Show grace times for user quotas on /mnt/lustre
389 .TP
390 .B $ lfs quotachown -i /mnt/lustre
391 Change file owner and group
392 .TP
393 .B $ lfs quotacheck -ug /mnt/lustre
394 Quotacheck for user and group - will turn on quotas after making the check.
395 .TP
396 .B $ lfs quotaon -ug /mnt/lustre
397 Turn quotas of user and group on
398 .TP
399 .B $ lfs quotaoff -ug /mnt/lustre
400 Turn quotas of user and group off
401 .TP
402 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
403 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
404 .TP
405 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
406 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
407 .TP
408 .SH BUGS
409 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
410 .SH AUTHOR
411 The lfs command is part of the Lustre filesystem.
412 .SH SEE ALSO
413 .BR lfs-df (1),
414 .BR lfs-hsm (1),
415 .BR lfs-setdirstripe (1),
416 .BR lfs-getdirstripe (1),
417 .BR lfs-mkdir (1),
418 .BR lfs_migrate (1),
419 .BR lfs-migrate (1),
420 .BR lctl (8),
421 .BR lustre (7)