1 .TH lfs 1 "2017 Jan 12" Lustre "user utilities"
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
8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
10 .B lfs changelog_clear <mdtname> <id> <endrec>
12 .B lfs check <mds|osts|servers>
14 .B lfs data_version [-n] \fB<filename>\fR
16 .B lfs df [-ihlv] [--pool|-p <fsname>[.<pool>]] [path]
18 .B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
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[[!] --component-count [+-]comp_cnt]
30 \fB[[!] --component-start [+-]N[kMGTPE]]
31 \fB[[!] --component-end|-E [+-]N[kMGTPE]]
32 \fB[[!] --component-flags <comp_flags>]
33 \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
34 \fB[[!] --uid|-u|--user|-U|--projid <uname>|<uid>|<projid>] [[!] --pool <pool>]\fR
36 .B lfs getname [-h]|[path ...]
38 .B lfs getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
39 [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
40 [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
41 [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
42 [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
43 [\fB--generation\fR|\fB-g\fR]
44 [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
45 [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
46 [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
47 [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
48 [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
49 <\fIdirname\fR|\fIfilename\fR> ...
51 .B lfs migrate \fB-m <mdt_index>\fR
54 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
55 [\fB-i | --stripe-index <start_ost_idx>\fR]
56 [\fB-S | --stripe-size <stripe_size>\fR]
57 [\fB-p | --pool <pool_name>\fR]
58 [\fB-o | --ost-list <ost_indices>\fR]
60 [\fB-n | --non-block\fR]
63 .B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR]
64 <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR]
68 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
69 [\fB-i | --index <mdt_idx>\fR]
70 [\fB-h | --hash-type <hash_name>\fR]
71 [\fB-m | --mode <mode>\fR]
72 [\fB-D | --default\fR]
81 .B lfs path2fid [--parents] <path> ...
83 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
85 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] [-p <projid>] <filesystem>
87 .B lfs quota -t <-u|-g|-p> <filesystem>
89 .B lfs quotacheck [-ug] <filesystem>
91 .B lfs quotaon [-ugf] <filesystem>
93 .B lfs quotaoff [-ug] <filesystem>
95 .B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
96 \fB[--block-softlimit <block-softlimit>]
97 \fB[--block-hardlimit <block-hardlimit>]
98 \fB[--inode-softlimit <inode-softlimit>]
99 \fB[--inode-hardlimit <inode-hardlimit>]
102 .B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
103 \fB[-b <block-softlimit>] [-B <block-hardlimit>]
104 \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
107 .B lfs setquota -t <-u|-g|-p>
108 \fB[--block-grace <block-grace>]\fR
109 \fB[--inode-grace <inode-grace>]\fR
112 .B lfs setquota -t <-u|-g|-p>
113 \fB[-b <block-grace>] [-i <inode-grace>]\fR
116 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
117 \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
118 \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
120 .B lfs setstripe -d <dir>
122 .B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS]
123 \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
125 .B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS]
126 \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
128 .B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> <filename>
132 .B lfs --list-commands
137 can be used to create a new file with a specific striping pattern, determine
138 the default striping pattern, gather the extended attributes (object numbers
139 and location) for a specific file. It can be invoked interactively without any
140 arguments or in a non-interactive mode with one of the arguments supported.
142 The various options supported by lfs are listed and explained below:
145 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.
148 Indicate that changelog records previous to <endrec> are no longer of
149 interest to a particular consumer <id>, potentially allowing the MDT to
150 free up disk space. An <endrec> of 0 indicates the current last record.
151 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
154 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
164 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--projid\fR (file has specific numeric project ID), \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 'more than n', while \fB-\fR before a numeric value means 'less than n'.
166 .B getname [-h]|[path ...]
167 Report all the Lustre mount points and the corresponding Lustre filesystem
168 instance. If one or more \fBpath\fR entries are provided, then only the
169 Lustre instance for these mount points is returned. If the path given is not on
170 a Lustre instance 'No such device' is reported.
174 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
175 that is located on a lustre mounted file system then only the OSTs belonging
176 to that filesystem are displayed.
178 .B getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
179 [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
180 [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
181 [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
182 [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
183 [\fB--generation\fR|\fB-g\fR]
184 [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
185 [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
186 [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
187 [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
188 [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
189 <\fIdirname\fR|\fIfilename\fR> ...
191 List the striping information for a given filename or directory tree.
192 By default the stripe count, size, and offset will be returned. If you
193 only want specific striping information then the options of
202 .BR --component-flags ,
203 .BR --component-count ,
204 .BR --component-start ,
205 .BR --component-end ,
208 can be used to return only the specific fields.
212 option is specified, the stripe information is printed without substituting the
213 filesystem's default values for unspecified fields. If the striping EA is not
214 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
216 In the case where you only want details about the files' object id
219 option is used. Additional information available about striping can be
222 The default behavior when a directory is specified is to list the striping
223 information for all files within the specified directory (like
225 This can be expanded with
227 which will recurse into all subdirectories.
228 If you wish to get striping information for only the specified directory, then
230 can be used to limit the information, like
232 You can limit the returned files to those with objects on a specific OST with
234 To show only the FID use
236 The layout generation can be printed with the
239 You can limit the displayed content by specifing argument for
243 .B --component-end|-E
244 options. For example, "--component-id=2" or "-I2" will only display the layout
245 attributes for the component with id equal to 2.
247 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
248 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
249 mounted at \fBrootpath\fR or named \fBfsname\fR. If a file has multiple
250 hard links, then all of the pathnames for that file are printed, unless
251 \fB--link\fR limits the printing to only the specified link number (starting
252 at 0, in no particular order). If multiple fids are specified, but only a
253 single pathname is needed for each file, use \fB--link 0\fR.
255 .B path2fid [--parents] <path> ...
256 Print out the FIDs for the specified \fBpath(s)\fR. If multiple pathnames
257 are given, then they will be printed one per line with the path as prefix.
258 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
259 given entries. If an entry has multiple links, these are displayed on a single
263 .RI { filesystem }[ .poolname "] | {" pathname }
269 .IR filesystem.pool .
271 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
272 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 user group and project are omitted quotas for current uid/gid/projid are shown. -v provides more verbose (with per-obd statistics) output. -q disables printing of additional descriptions (including column titles).
274 .B quota -t <-u|-g|-p> <filesystem>
275 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
277 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
278 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.
280 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
281 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>)
283 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
284 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>=""
286 .B setquota <-u|-g|-p> <uname>|<uid>|<gname>|<gid>|<projid> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
287 To set filesystem quotas for users, groups or project. 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
289 .B setquota -t [-u|-g|-p] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
290 To set filesystem quota grace times for users,groups or project. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES
292 .B swap_layouts <filename1> <filename2>
293 Swap the data (layout and OST objects) of two regular files. The
294 two files have to be in the same filesystem, owned by the same user,
295 reside on the same MDT and writable by the user.
297 Swapping the layout of two directories is not permitted.
299 .B data_version [-n] <filename>
300 Display current version of file data. If -n is specified, data version is read
301 without taking lock. As a consequence, data version could be outdated if there
302 is dirty caches on filesystem clients, but this will not force data flushes and
303 has less impact on filesystem.
305 Even without -n, race conditions are possible and data version should be
306 checked before and after an operation to be confident the data did not change
310 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
312 is an alias of the command
316 lfs mv is deprecated, use lfs
324 See lfs-setstripe(1).
327 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
330 Output a list of the commands supported by the lfs utility
333 Provides brief help on the various arguments
336 Quit the interactive lfs session
339 .B $ lfs getstripe -v /mnt/lustre/file1
340 Lists the detailed object allocation of a given file
342 .B $ lfs getstripe -v -I2 /mnt/lustre/file1
343 Lists the detailed information of the component 2 in a given file
345 .B $ lfs getstripe --component-flags=^init -I /mnt/lustre/file1
346 Print only the component IDs for all the uninstantiated components
348 .B $ lfs getstripe -E-64M /mnt/lustre/file1
349 Lists the information of the components in a file which has less than 64M extent end
351 .B $ lfs getstripe -I3 --component-start /mnt/lustre/file1
352 Print only the component start for the component with ID of 3
354 .B $ lfs find /mnt/lustre
355 Efficiently lists all files in a given directory and its subdirectories
357 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
358 Recursively list all regular files in given directory more than 30 days old
360 .B $ lfs find --obd OST2-UUID /mnt/lustre/
361 Recursively list all files in a given directory that have objects on OST2-UUID.
363 .B $ lfs find --component-count +3 /mnt/lustre
364 Recursively list all files that have more than 3 components.
366 .B $ lfs check servers
367 Check the status of all servers (MDT, OST)
375 .B $ lfs quota -u bob /mnt/lustre
376 List quotas of user `bob'
378 .B $ lfs quota -t -u /mnt/lustre
379 Show grace times for user quotas on /mnt/lustre
381 .B $ lfs quotachown -i /mnt/lustre
382 Change file owner and group
384 .B $ lfs quotacheck -ug /mnt/lustre
385 Quotacheck for user and group - will turn on quotas after making the check.
387 .B $ lfs quotaon -ug /mnt/lustre
388 Turn quotas of user and group on
390 .B $ lfs quotaoff -ug /mnt/lustre
391 Turn quotas of user and group off
393 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
394 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
396 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
397 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
399 The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR,
400 \fBlfs getdirstripe\fR and \fBlfs mkdir\fR are explained in separated man pages.
402 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
404 The lfs command is part of the Lustre filesystem.
408 .BR lfs-setdirstripe (1),
409 .BR lfs-getdirstripe (1),
412 .BR lfs-setstripe (1),