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 setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
96 \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
97 \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
99 .B lfs setstripe -d <dir>
101 .B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS]
102 \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
104 .B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS]
105 \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
107 .B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> <filename>
111 .B lfs --list-commands
116 can be used to create a new file with a specific striping pattern, determine
117 the default striping pattern, gather the extended attributes (object numbers
118 and location) for a specific file. It can be invoked interactively without any
119 arguments or in a non-interactive mode with one of the arguments supported.
121 The various options supported by lfs are listed and explained below:
124 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.
127 Indicate that changelog records previous to <endrec> are no longer of
128 interest to a particular consumer <id>, potentially allowing the MDT to
129 free up disk space. An <endrec> of 0 indicates the current last record.
130 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
133 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
143 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'.
145 .B getname [-h]|[path ...]
146 Report all the Lustre mount points and the corresponding Lustre filesystem
147 instance. If one or more \fBpath\fR entries are provided, then only the
148 Lustre instance for these mount points is returned. If the path given is not on
149 a Lustre instance 'No such device' is reported.
153 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
154 that is located on a lustre mounted file system then only the OSTs belonging
155 to that filesystem are displayed.
157 .B getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
158 [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
159 [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
160 [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
161 [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
162 [\fB--generation\fR|\fB-g\fR]
163 [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
164 [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
165 [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
166 [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
167 [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
168 <\fIdirname\fR|\fIfilename\fR> ...
170 List the striping information for a given filename or directory tree.
171 By default the stripe count, size, and offset will be returned. If you
172 only want specific striping information then the options of
181 .BR --component-flags ,
182 .BR --component-count ,
183 .BR --component-start ,
184 .BR --component-end ,
187 can be used to return only the specific fields.
191 option is specified, the stripe information is printed without substituting the
192 filesystem's default values for unspecified fields. If the striping EA is not
193 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
195 In the case where you only want details about the files' object id
198 option is used. Additional information available about striping can be
201 The default behavior when a directory is specified is to list the striping
202 information for all files within the specified directory (like
204 This can be expanded with
206 which will recurse into all subdirectories.
207 If you wish to get striping information for only the specified directory, then
209 can be used to limit the information, like
211 You can limit the returned files to those with objects on a specific OST with
213 To show only the FID use
215 The layout generation can be printed with the
218 You can limit the displayed content by specifing argument for
222 .B --component-end|-E
223 options. For example, "--component-id=2" or "-I2" will only display the layout
224 attributes for the component with id equal to 2.
226 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
227 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
228 mounted at \fBrootpath\fR or named \fBfsname\fR. If a file has multiple
229 hard links, then all of the pathnames for that file are printed, unless
230 \fB--link\fR limits the printing to only the specified link number (starting
231 at 0, in no particular order). If multiple fids are specified, but only a
232 single pathname is needed for each file, use \fB--link 0\fR.
234 .B path2fid [--parents] <path> ...
235 Print out the FIDs for the specified \fBpath(s)\fR. If multiple pathnames
236 are given, then they will be printed one per line with the path as prefix.
237 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
238 given entries. If an entry has multiple links, these are displayed on a single
242 .RI { filesystem }[ .poolname "] | {" pathname }
248 .IR filesystem.pool .
250 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
251 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).
253 .B quota -t <-u|-g|-p> <filesystem>
254 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
256 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
257 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.
259 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
260 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>)
262 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
263 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>=""
265 .B swap_layouts <filename1> <filename2>
266 Swap the data (layout and OST objects) of two regular files. The
267 two files have to be in the same filesystem, owned by the same user,
268 reside on the same MDT and writable by the user.
270 Swapping the layout of two directories is not permitted.
272 .B data_version [-n] <filename>
273 Display current version of file data. If -n is specified, data version is read
274 without taking lock. As a consequence, data version could be outdated if there
275 is dirty caches on filesystem clients, but this will not force data flushes and
276 has less impact on filesystem.
278 Even without -n, race conditions are possible and data version should be
279 checked before and after an operation to be confident the data did not change
283 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
285 is an alias of the command
289 lfs mv is deprecated, use lfs
297 See lfs-setstripe(1).
300 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
303 Output a list of the commands supported by the lfs utility
306 Provides brief help on the various arguments
309 Quit the interactive lfs session
312 .B $ lfs getstripe -v /mnt/lustre/file1
313 Lists the detailed object allocation of a given file
315 .B $ lfs getstripe -v -I2 /mnt/lustre/file1
316 Lists the detailed information of the component 2 in a given file
318 .B $ lfs getstripe --component-flags=^init -I /mnt/lustre/file1
319 Print only the component IDs for all the uninstantiated components
321 .B $ lfs getstripe -E-64M /mnt/lustre/file1
322 Lists the information of the components in a file which has less than 64M extent end
324 .B $ lfs getstripe -I3 --component-start /mnt/lustre/file1
325 Print only the component start for the component with ID of 3
327 .B $ lfs find /mnt/lustre
328 Efficiently lists all files in a given directory and its subdirectories
330 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
331 Recursively list all regular files in given directory more than 30 days old
333 .B $ lfs find --obd OST2-UUID /mnt/lustre/
334 Recursively list all files in a given directory that have objects on OST2-UUID.
336 .B $ lfs find --component-count +3 /mnt/lustre
337 Recursively list all files that have more than 3 components.
339 .B $ lfs check servers
340 Check the status of all servers (MDT, OST)
348 .B $ lfs quota -u bob /mnt/lustre
349 List quotas of user `bob'
351 .B $ lfs quota -t -u /mnt/lustre
352 Show grace times for user quotas on /mnt/lustre
354 .B $ lfs quotachown -i /mnt/lustre
355 Change file owner and group
357 .B $ lfs quotacheck -ug /mnt/lustre
358 Quotacheck for user and group - will turn on quotas after making the check.
360 .B $ lfs quotaon -ug /mnt/lustre
361 Turn quotas of user and group on
363 .B $ lfs quotaoff -ug /mnt/lustre
364 Turn quotas of user and group off
366 The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR,
367 \fBlfs getdirstripe\fR and \fBlfs mkdir\fR are explained in separated man pages.
369 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
371 The lfs command is part of the Lustre filesystem.
375 .BR lfs-setdirstripe (1),
376 .BR lfs-getdirstripe (1),
379 .BR lfs-setstripe (1),
381 .BR lfs-setquota (1),