1 .TH lfs-find 1 "2018-01-24" Lustre "user utilities"
3 lfs-find \- Lustre client utility to list files with specific attributes
5 .B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...>
6 [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn[smhdwy]\fR]
7 [[\fB!\fR] \fB--blocks\fR|\fB-b\fR [\fB+-\fR]\fIn\fR]
8 [[\fB!\fR] \fB--btime\fR|\fB-B\fR [\fB+-\fR]\fIn[smhdwy]\fR]
9 [[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn[smhdwy]\fR]
10 [[\fB!\fR] \fB--component-count|\fB--comp-count\fR [\fB+-\fR]\fIn\fR]
11 [[\fB!\fR] \fB--component-end|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
12 [[\fB!\fR] \fB--component-flags|\fB--comp-flags\fR [^]\fIFLAG\fB,\fR...]
13 [[\fB!\fR] \fB--component-start|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
14 [[\fB!\fR] \fB--extension-size|\fB-z\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
15 [[\fB!\fR] \fB--foreign\fR [\fITYPE\fR]]
16 [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR \fIGNAME\fR|\fIGID\fR>]
17 [\fB--help\fR|\fB-h\fR]
18 [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR]
20 [\fB--maxdepth\fR|\fB-D\fI n\fR]
21 [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR \fIUUID\fR|\fIINDEX\fR,...]
22 [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR]
23 [[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fR<[^]\fIHASHFLAG\fR,[^]\fIHASHTYPE\fR,...>]
24 [[\fB!\fR] \fB--mirror-count|\fB-N\fR [\fB+-\fR]\fIn\fR]
25 [[\fB!\fR] \fB--mirror-state\fR [^]\fISTATE\fR]
26 [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn[smhdwy]\fR]
27 [[\fB!\fR] \fB--name\fR|\fB-n \fIPATTERN\fR]
28 [[\fB!\fR] \fB--newer\fR[\fBXY\fR] \fIREFERENCE\fR]
29 [[\fB!\fR] \fB--ost\fR|\fB-O\fR \fIINDEX\fR,...]
30 [[\fB!\fR] \fB--perm\fR [\fB/-\fR]\fIMODE\fR ]
31 [[\fB!\fR] \fB--pool\fR \fIPOOL\fR]
32 [\fB--print\fR|\fB-P\fR]
33 [\fB--print0\fR|\fB-0\fR]
34 [\fB--printf\fR \fIFORMAT\fR]
35 [[\fB!\fR] \fB--projid\fR \fIPROJID\fR]
36 [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]]
37 [[\fB!\fR] \fB--stripe-count|\fB-c\fR [\fB+-\fR]\fIn\fR]
38 [[\fB!\fR] \fB--stripe-index|\fB-i\fR \fIn\fR,...]
39 [[\fB!\fR] \fB--stripe-size|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
40 [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
41 [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U \fIUNAME\fR|\fIUID\fR]
44 is similar to the standard
46 utility and is used to list files and directories with specific attributes,
47 both regular POSIX attributes such as ownership, timestamps, and size using
50 as well as Lustre-specific attributes such as stripe count and size,
51 OST and MDT location, and composite layout attributes.
55 File was last accessed \fIn\fR*24 hours ago (if no units are given),
56 or \fIn\fR*\fBs\fReconds, \fBm\fRinutes, \fBh\fRours, \fBd\fRays,
57 \fBw\fReeks, or \fBy\fRears ago within a margin of error of 24h
58 if no unit is specified. Multiple units can be specified,
59 for example \fB8h20m\fR is equivalent to \fB500m\fR. If multiple units
60 are specified, the margin of error is based on the smallest unit used, so
62 has a margin of error of one day, while
64 has a margin of error of one hour.
67 Blocks allocated by the file is \fIn\fR Kibibytes (if no units are given),
68 \fIn\fR 512-byte \fBb\fRlocks, or \fBK\fRibi-, \fBM\fRebi-, \fBG\fRibi-,
69 \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-bytes if that suffix is given.
71 .BR --btime | --Btime | -B
72 File was created \fIn\fR*24 hours ago, see
74 for full details and options.
77 File's status was last changed \fIn\fR*24 hours ago, see
79 for full details and options.
81 .BR --component-count | --comp-count
82 The file has \fIn\fR components in its layout.
84 .BR --component-end | --comp-end
85 The file has component end offset \fIn\fR (in bytes) for any component.
87 .BR --component-flags | --comp-flags
88 The file has components with the specified
92 is used, print only components not matching
94 Multiple flags can be specified, separated by commas. Valid flag names are:
98 Component has been initialized (has allocated OST objects).
101 Replicated (mirrored) components that do not have up-to-date data. Stale
102 components will not be used for read or write operations, and need to be
105 before they can be accessed again.
108 Replicated (mirrored) components that are preferred for read or write.
109 For example, because they are located on SSD-based OSTs, or are more
110 local on the network to clients.
113 .BR --component-start | --comp-start
114 The file has component start offset \fIn\fR (in bytes) for any component.
117 File has a foreign (non-Lustre/free format) layout and is of the given
119 if specified. Presently only
123 are defined types, though 32-bit numeric types can also be used.
126 File has specified numeric group ID.
129 File belongs to specified group, numeric group ID allowed.
135 File has a layout of the given type, one of:
139 Traditional Lustre RAID-0 striping format.
142 HSM-archived files that are not resident in the filesystem.
145 Files that have the first data component on an MDT.
149 Use file size and blocks from MDT, if available, to avoid extra RPCs.
152 Limits find to decend at most \fIn\fR levels of directory tree.
154 .BR --mdt | --mdt-index | -m
155 File or directory inode is located on the specified MDT(s).
158 DNE striped directory uses the given filename hashing function, one of:
162 The CRUSH consistent hash function, added in Lustre 2.14, minimizes
163 entry migration if the directory stripe count changes during migration.
166 The Fowler\-Noll\-Vo hash function, which is a simple and efficient hash.
169 Simple hash function that sums all of the characters in the filename.
170 This is mostly for testing, or if it is known that filenames will use
171 sequential filenames.
173 This implicitly selects only directories to be matched, like
175 and not other file types.
178 The DNE striped directory has the given number of MDT shards. This
179 implicitly selects only directories to be matched, like
181 and not other file types.
183 .BR --mirror-count | -N
184 The file has \fIn\fR mirrors in its layout.
187 The file has a state of
191 is used, print only files not matching
193 Only one state can be specified. Valid state name is:
197 The mirrored file is in read-only state. All of the mirrors contain
201 The mirrored file is in a state of being written.
204 The mirrored file is in a state of being resynchronized.
208 File's data was last modified \fIn\fR*24 hours ago, see
210 for full details and options.
213 Filename matches the given filename, or regular expression using
216 file name regular expressions and wildcards.
218 .BR --newer [ XY "] " \fIreference
219 Succeeds if timestamp \fIX\fR of the file being considered is newer
220 than timestamp \fIY\fR of the file
222 The letters \fIX\fR and \fIY\fR can be any of the following letters:
230 a The access time of the file \fIreference\fR
231 b|B The birth time of the file \fIreference\fR
232 c The inode status change time of \fIreference\fR
233 m The modification time of the file \fIreference\fR
234 t \fIreference\fR is interpreted directly as a time
237 Some combinations are invalid; for example, it is invalid for
247 is interpreted directly as a time, currently it must be in one of the
248 following formats: "%Y-%m-%d %H:%M:%S", "%Y-%m-%d %H:%M", "%Y-%m-%d",
249 "%H:%M:%S", "%H:%M", to represent year, month, day, hour, minute, seconds,
250 with unspecified times at the start of that minute or day, unspecified dates
251 being "today", and "@%s" or "%s" the seconds since the Unix epoch (see
253 for details of the time formats). Otherwise, it will report an error.
254 If you try to use the birth time of a reference file, and the birth
255 time cannot be determined, a fatal error message results. If you
256 specify a test which refers to the birth time of files being examined,
257 this test will fail for any files where the birth time is unknown.
260 File has an object on the specified OST(s). The OST names can be specified
261 using the whole OST target name, or just the OST index number. If multiple
262 OSTs are given in a comma-separated list, the file may have an object on
263 any of the given OSTs. Specifying multiple OSTs allows scanning the
264 filesystem only once when migrating objects off multiple OSTs for evacuation
265 and replacement using
268 .BR "--perm \fImode\fR"
269 File's permission are exactly \fImode\fR (octal or symbolic).
271 .BR "--perm /\fImode\fR"
272 All of the permission bits \fImode\fR are set for the file.
274 .BR "--perm -\fImode\fR"
275 Any of the permission bits \fImode\fR are set for the file. If no permission
276 bits in \fImode\fR are set, this test matches any file.
279 Layout was created with the specified
281 name. For composite files, this may match the pool of any component.
283 Prints the file or directory name to standard output if it matches
284 all specified parameters, one file per line with a trailing linefeed.
285 This is the default behaviour for any matching files.
288 Print full file name to standard output if it matches the specified
289 parameters, followed by a NUL character. This is for use together with
293 option to handle filenames with embedded spaces or other special characters.
295 .BR "--printf \fIformat\fR"
296 Print \fIformat\fR to standard output for each matching file, interpreting
297 `\' escapes and `%' directives. Unlike \fB--print\fR, the \fB--printf\fR option
298 does not automatically add a newline to the end of the string. The escapes and
312 A literal percent sign.
315 File\'s last access time in the format returned by the C \`ctime\' function.
318 File\'s last access time in seconds since Jan. 1, 1970, 00:00 GMT.
321 The amount of disk space used for the file (in 512-byte blocks).
324 File\'s last status change time in the format returned by the C \`ctime\' function.
327 File\'s last status change time in seconds since Jan. 1, 1970, 00:00 GMT.
330 File\'s numeric group ID.
333 File permission bits (in octal).
342 File\'s last modification time in the format returned by the C \`ctime\' function.
345 File\'s last modification time in seconds since Jan. 1, 1970, 00:00 GMT.
348 File's numeric user ID.
351 File\'s birth time in the format returned by the C \`ctime\' function.
354 File\'s birth time in seconds since Jan. 1, 1970, 00:00 GMT.
357 File's type (f=file, d=directory, p=pipe, b=block device, c=character device,
358 s=socket l=symbolic link)
360 Lustre-specific information about a file can be printed using these directives:
363 File\'s stripe count. For a composite file, this is the stripe count of the last
364 instantiated component.
367 File Identifier (FID) associated with the file.
370 Directory's hash type (or \`none\' for an unstriped directory).
373 File\'s starting OST index (or starting MDT index for a directory).
374 For a composite file, this is the starting OST index of the last instantiated
378 List of all OST/MDT indices associated with a file or directory.
381 File\'s OST pool name. For a composite file, this is the pool associated
382 with the last instantiated component. (NOTE: This can also be used for
383 directories, but since MDT pools are not currently implemented, nothing will
387 Numeric project ID assigned to the file or directory.
390 File's stripe size. For a composite file, this is the stripe size of the last
391 instantiated component.
395 File has specified numeric project ID.
398 File size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
399 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-bytes if a
402 .BR --stripe-count | -c
403 File has \fIn\fR stripes allocated. For composite files, this
404 matches the stripe count of the last initialized component.
406 .BR --stripe-index | -i
407 File has stripe on OST index \fIn\fR. Multiple OST indices can be
408 specified in a comma-separated list, which indicates that the file
409 has a stripe on \fIany\fR of the specified OSTs. This allows a
410 single namespace scan for files on multiple different OSTs, if there
411 are multiple OSTs that are being replaced.
413 .BR --stripe-size | -S
414 Stripe size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
415 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-abytes if a
416 suffix is given. For composite files, this matches the stripe
417 size of the last initialized non-extension component.
419 .BR --extension-size | --ext-size | -z
420 Extension size is \fIn\fR bytes, or \fBK\fRibi-, \fBM\fRebi-,
421 \fBG\fRibi-, \fBT\fRebi-, \fBP\fRebi-, or \fBE\fRbi-abytes if a
422 suffix is given. For composite files, this matches the extension
423 size of any extension component.
426 File has type: \fBb\fRlock, \fBc\fRharacter, \fBd\fRirectory,
427 \fBf\fRile, \fBp\fRipe, sym\fBl\fRink, or \fBs\fRocket.
430 File has specified numeric user ID.
433 File owned by specified user, numeric user ID also allowed.
435 Specifying \fB!\fR before an option negates its meaning (\fIfiles
436 NOT matching the parameter\fR). Using \fB+\fR before a numeric
437 value means 'more than \fIn\fR', while \fB-\fR before a numeric value
438 means 'less than \fIn\fR'. If neither is used, it means 'equal to
439 \fIn\fR', within the bounds of the unit specified (if any).
441 Numeric suffixes are in binary SI (power-of-two) units.
443 For compatibility with
445 it is possible to specify long options with either a single or double
448 The order of parameters does not affect how the files are matched.
450 will first scan the directory for any specified filename, and then fetch
451 MDT inode attributes for each matching filename. If it can make a
452 positive or negative decision for a file based only on the MDT attributes
453 (e.g. newer than specified time, user/group/project ID) it will not fetch
454 the OST object attributes for that file.
457 .B $ lfs find /mnt/lustre
458 Efficiently lists all files in a given directory and its subdirectories,
459 without fetching any file attributes.
461 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
462 Recursively list all regular files in given directory more than 30 days old.
464 .B $ lfs find /mnt/lustre/test -o OST0002,OST0003 -print0 | lfs_migrate -y
465 Recursively find all files in
467 that have objects on OST0002 or OST0003 and migrate them to other OSTs. See
471 .B $ lfs find -name "*.mpg" --component-count +3 /mnt/lustre
472 Recursively list all files ending with
474 that have more than 3 components.
476 .B $ lfs find --component-flags=init,prefer,^stale /mnt/lustre
477 Recursively list all files that have at least one component with both 'init'
478 and 'prefer' flags set, and doesn't have flag 'stale' set.
480 .B $ lfs find --mirror-count +2 /mnt/lustre
481 Recursively list all mirrored files that have more than 2 mirrors.
483 .B $ lfs find ! --mirror-state=ro /mnt/lustre
484 Recursively list all out-of-sync mirrored files.
486 .B $ lfs find ! --foreign=symlink /mnt/lustre
487 Recursively list all but foreign files/dirs of
493 command isn't as comprehensive as
495 In particular, it doesn't support complex boolean expressions with
497 (logical OR), only logical AND of all expressions. The order that parameters
498 are specified does not affect how the files are matched.
502 command is part of the Lustre filesystem.
505 .BR lfs-getstripe (1),
506 .BR lfs-getdirstripe (1),