Whamcloud - gitweb
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2009 Jan 29" 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
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 [-i] [-h] [--lazy] [--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]
36         \fB[--stripe-size|-S] [--directory|-d]
37         \fB[--layout|-L]
38         \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
39 .br
40 .B lfs migrate \fB-m <mdt_index>\fR
41 .IR directory
42 .br
43 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
44                [\fB-i | --stripe-index <start_ost_idx>\fR]
45                [\fB-S | --stripe-size <stripe_size>\fR]
46                [\fB-p | --pool <pool_name>\fR]
47                [\fB-o | --ost-list <ost_indices>\fR]
48                [\fB-b | --block\fR]
49                [\fB-n | --non-block\fR]
50 .IR file|directory
51 .br
52 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
53              [\fB-i | --index <mdt_idx>\fR]
54              [\fB-h | --hash-type <hash_name>\fR]
55              [\fB-m | --mode <mode>\fR]
56              [\fB-D | --default\fR]
57 .IR directory
58 .br
59 .B lfs osts
60 .RB [ path ]
61 .br
62 .B lfs path2fid [--parents] <path> ...
63 .br
64 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
65 .br
66 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
67 .br
68 .B lfs quota -t <-u|-g> <filesystem>
69 .br
70 .B lfs quotacheck [-ug] <filesystem>
71 .br
72 .B lfs quotaon [-ugf] <filesystem>
73 .br
74 .B lfs quotaoff [-ug] <filesystem>
75 .br
76 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
77              \fB[--block-softlimit <block-softlimit>]
78              \fB[--block-hardlimit <block-hardlimit>]
79              \fB[--inode-softlimit <inode-softlimit>]
80              \fB[--inode-hardlimit <inode-hardlimit>]
81              \fB<filesystem>\fR
82 .br
83 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
84              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
85              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
86              \fB<filesystem>\fR
87 .br
88 .B lfs setquota -t <-u|-g>
89              \fB[--block-grace <block-grace>]\fR
90              \fB[--inode-grace <inode-grace>]\fR
91              \fB<filesystem>\fR
92 .br
93 .B lfs setquota -t <-u|-g>
94              \fB[-b <block-grace>] [-i <inode-grace>]\fR
95              \fB<filesystem>\fR
96 .br
97 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
98         \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
99         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
100 .br
101 .B lfs setstripe -d <dir>
102 .br
103 .B lfs --version
104 .br
105 .B lfs help
107 .B lfs
108 can be used to create a new file with a specific striping pattern, determine
109 the default striping pattern, gather the extended attributes (object numbers
110 and location) for a specific file. It can be invoked interactively without any
111 arguments or in a non-interactive mode with one of the arguments supported.
113 The various options supported by lfs are listed and explained below:
114 .TP
115 .B changelog
116 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.
117 .TP
118 .B changelog_clear
119 Indicate that changelog records previous to <endrec> are no longer of
120 interest to a particular consumer <id>, potentially allowing the MDT to
121 free up disk space. An <endrec> of 0 indicates the current last record.
122 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
123 .TP
124 .B check
125 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
126 .TP
127 .B df [-i] [-h] [--lazy] [--pool|-p <fsname>[.<pool>] [path]
128 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
129 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR.  By default
130 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
131 specified print only the usage of that filesystem.  If \fB-h\fR is given, the
132 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
133 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
134 The \fB--lazy\fR/\fB-l\fR option skips any OST that is currently disconnected
135 from the client.  This avoids blocking the \fBdf\fR output if an OST is down,
136 and only returns the space on the OSTs that can currently be accessed.
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]
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 or
168 .B --pool
169 can be used to return only the specific fields.
170 .br
171 If the
172 .B --raw
173 option is specified, the stripe information is printed without substituting the
174 filesystem's default values for unspecified fields. If the striping EA is not
175 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
176 respectively.
177 In the case where you only want details about the files' object id
178 information then the
179 .B --quiet
180 option is used. Additional information available about striping can be
181 displayed with
182 .BR --verbose .
183 The default behavior when a directory is specified is to list the striping
184 information for all files within the specified directory (like
185 .RB ' "ls -l" ') .
186 This can be expanded with
187 .B --recursive
188 which will recurse into all subdirectories.
189 If you wish to get striping information for only the specified directory, then
190 .B --directory
191 can be used to limit the information, like
192 .RB ' "ls -d" ').
193 You can limit the returned files to those with objects on a specific OST with
194 .BR --obd .
195 .TP
196 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
197         \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
198         \fB[--ost-index|-o <ost_indices>] <dirname|filename>\fR
199 .br
200 To create a new file, or set the directory default, with the specified striping
201 parameters.  The
202 .I stripe_count
203 is the number of OSTs to stripe a file over. A
204 .I stripe_count
205 of 0 means to use the filesystem-wide default stripe count (default 1), and a
206 .I stripe_count
207 of -1 means to stripe over all available OSTs.  The
208 .I stripe_size
209 is the number of bytes to store on each OST before moving to the next OST.  A
210 .I stripe_size
211 of 0 means to use the filesystem-wide default stripe_size (default 1MB).  The
212 .I start_ost_index
213 is the OST index (starting at 0) on which to start striping for this file.  A
214 .I start_ost_index
215 of -1 allows the MDS to choose the starting index and it is strongly
216 recommended, as this allows space and load balancing to be done by the MDS as
217 needed. The
218 .B -o
219 option is used to specify the exact stripe layout on the file system.
220 .I ost_indices
221 is a list of OSTs referenced by their indices, which are specified in decimal
222 or hex form and can be obtained using the
223 .B lfs osts
224 command. The list format consists of individual OST indices and index ranges
225 separated by commas, e.g. 1,2-4,7. The
226 .B -o
227 option may be specified multiple times to stripe across the union of all listed
228 OSTs. If the
229 .B -c
230 option is combined with
231 .B -o
232 the
233 .I stripe_count
234 must agree with the number of OSTs in
235 .IR ost_indices .
236 If the
237 .B -i
238 option is combined with
239 .B -o
240 the
241 .I start_ost_index
242 must be in the OST list, and it will be used as the index on which to start
243 striping the file. Otherwise the striping will occur in the order specified in
244 .IR ost_indices .
245 The
246 .I poolname
247 is the name of a predefined pool of OSTs (see
248 .BR lctl (8))
249 that will be used for striping. The
250 .IR stripe_count ,
251 .IR stripe_size ,
252 and
253 .I start_ost_index
254 will be used as well; the
255 .I start_ost_index
256 must be part of the pool or an error will be returned.
257 .TP
258 .B setstripe -d
259 Delete the default striping on the specified directory.
260 .TP
261 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
262 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
263 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
264 hard links, then all of the pathnames for that file are printed, unless
265 \fB--link\fR limits the printing to only the specified link number (starting
266 at 0, in no particular order).  If multiple fids are specified, but only a
267 single pathname is needed for each file, use \fB--link 0\fR.
268 .TP
269 .B path2fid [--parents] <path> ...
270 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
271 are given, then they will be printed one per line with the path as prefix.
272 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
273 given entries. If an entry has multiple links, these are displayed on a single
274 line, tab-separated.
275 .TP
276 .B pool_list
277 .RI { filesystem }[ .poolname "] | {" pathname }
278 List the pools in
279 .I filesystem
280 or
281 .IR pathname ,
282 or the OSTs in
283 .IR filesystem.pool .
284 .TP
285 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
286 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).
287 .TP
288 .B quota -t <-u|-g> <filesystem>
289 To display block and inode grace times for user (-u) or group (-g) quotas
290 .TP
291 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
292 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.
293 .TP
294 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
295 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>)
296 .TP
297 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
298 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>=""
299 .TP
300 .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>
301 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
302 .TP
303 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
304 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
305 .TP
306 .B swap_layouts <filename1> <filename2>
307 Swap the data (layout and OST objects) of two regular files. The
308 two files have to be in the same filesystem, owned by the same user,
309 reside on the same MDT and writable by the user.
311 Swapping the layout of two directories is not permitted.
312 .TP
313 .B data_version [-n] <filename>
314 Display current version of file data. If -n is specified, data version is read
315 without taking lock. As a consequence, data version could be outdated if there
316 is dirty caches on filesystem clients, but this will not force data flushes and
317 has less impact on filesystem.
319 Even without -n, race conditions are possible and data version should be
320 checked before and after an operation to be confident the data did not change
321 during it.
322 .TP
323 .B mkdir
324 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
325 .B lfs setdirstripe
326 is an alias of the command
327 .B lfs mkdir
328 .TP
329 .B mv
330 lfs mv is deprecated, use lfs
331 .B migrate
332 instead.
333 .TP
334 .B migrate
335 See lfs-migrate(1).
336 .TP
337 .B --version
338 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
339 .TP
340 .B help
341 Provides brief help on the various arguments
342 .TP
343 .B exit/quit
344 Quit the interactive lfs session
346 .TP
347 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
348 This creates a file striped on two OSTs with 128kB on each stripe.
349 .TP
350 .B $ lfs setstripe -d /mnt/lustre/dir
351 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
352 .TP
353 .B $ lfs getstripe -v /mnt/lustre/file1
354 Lists the detailed object allocation of a given file
355 .TP
356 .B $ lfs find /mnt/lustre
357 Efficiently lists all files in a given directory and its subdirectories
358 .TP
359 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
360 Recursively list all regular files in given directory more than 30 days old
361 .TP
362 .B $ lfs find --obd OST2-UUID /mnt/lustre/
363 Recursively list all files in a given directory that have objects on OST2-UUID.
364 .tP
365 .B $ lfs check servers
366 Check the status of all servers (MDT, OST)
367 .TP
368 .B $ lfs osts
369 List all the OSTs
370 .TP
371 .B $ lfs df -h
372 Lists space usage per OST and MDT in human readable format.
373 .TP
374 .B $ lfs df -i
375 Lists inode usage per OST and MDT
376 .TP
377 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
378 List space or inode usage for a specific OST pool
379 .TP
380 .B $ lfs quota -u bob /mnt/lustre
381 List quotas of user `bob'
382 .TP
383 .B $ lfs quota -t -u /mnt/lustre
384 Show grace times for user quotas on /mnt/lustre
385 .TP
386 .B $ lfs quotachown -i /mnt/lustre
387 Change file owner and group
388 .TP
389 .B $ lfs quotacheck -ug /mnt/lustre
390 Quotacheck for user and group - will turn on quotas after making the check.
391 .TP
392 .B $ lfs quotaon -ug /mnt/lustre
393 Turn quotas of user and group on
394 .TP
395 .B $ lfs quotaoff -ug /mnt/lustre
396 Turn quotas of user and group off
397 .TP
398 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
399 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
400 .TP
401 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
402 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
403 .TP
404 .SH BUGS
405 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
407 The lfs command is part of the Lustre filesystem.
409 .BR lfs-hsm (1),
410 .BR lfs-setdirstripe (1),
411 .BR lfs-getdirstripe (1),
412 .BR lfs-mkdir (1),
413 .BR lfs_migrate (1),
414 .BR lfs-migrate (1),
415 .BR lctl (8),
416 .BR lustre (7)