Whamcloud - gitweb
LU-2740 utils: Add support for --version option
[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 df [-i] [-h] [--lazy] [--pool|-p <fsname>[.<pool>] [path]
15 .br
16 .B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
17 .br
18 .B lfs find <directory|filename>
19         \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N]
20         \fB[--maxdepth|-D N] [[!] --mdt|-m <uuid|index,...>] [--name|-n pattern]
21         \fB[[!] --ost|-O <uuid|index,...>] [--print|-p] [--print0|-P]
22         \fB[[!] --size|-s [-+]N[kMGTPE]]
23         \fB[[!] --stripe-count|-c [+-]<stripes>]
24         \fB[[!] --stripe-index|-i <index,...>]
25         \fB[[!] --stripe-size|-S [+-]N[kMG]]
26         \fB[[!] --layout|-L raid0,released]
27         \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
28         \fB[[!] --uid|-u|--user|-U <uname>|<uid>] [[!] --pool <pool>]\fR
29 .br
30 .B lfs getname [-h]|[path ...]
31 .br
32 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
33         \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M]
34         \fB[--stripe-size|-S] [--directory|-d]
35         \fB[--layout|-L]
36         \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
37 .br
38 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
39         \fB[--stripe-index|-i start_ost_index ] [--pool|-p <poolname>]
40         \fB<directory|filename>\fR
41 .br
42 .B lfs setstripe -d <dir>
43 .br
44 .B lfs osts
45 .RB [ path ]
46 .br
47 .B lfs path2fid <path> ...
48 .br
49 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
50 .br
51 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
52 .br
53 .B lfs quota -t <-u|-g> <filesystem>
54 .br
55 .B lfs quotacheck [-ug] <filesystem>
56 .br
57 .B lfs quotaon [-ugf] <filesystem>
58 .br
59 .B lfs quotaoff [-ug] <filesystem>
60 .br
61 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
62              \fB[--block-softlimit <block-softlimit>]
63              \fB[--block-hardlimit <block-hardlimit>]
64              \fB[--inode-softlimit <inode-softlimit>]
65              \fB[--inode-hardlimit <inode-hardlimit>]
66              \fB<filesystem>\fR
67 .br
68 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
69              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
70              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
71              \fB<filesystem>\fR
72 .br
73 .B lfs setquota -t <-u|-g>
74              \fB[--block-grace <block-grace>]
75              \fB[--inode-grace <inode-grace>]
76              \fB<filesystem>\fR
77 .br
78 .B lfs setquota -t <-u|-g>
79              \fB[-b <block-grace>] [-i <inode-grace>]
80              \fB<filesystem>\fR
81 .br
82 .br
83 .B lfs swap_layouts <filename1> <filename2>
84 .br
85 .B lfs data_version [-n] \fB<filename>\fR
86 .br
87 .B lfs --version
88 .br
89 .B lfs help
91 .B lfs
92 can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported. 
94 The various options supported by lfs are listed and explained below:
95 .TP
96 .B changelog
97 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.
98 .TP
99 .B changelog_clear
100 Indicate that changelog records previous to <endrec> are no longer of
101 interest to a particular consumer <id>, potentially allowing the MDT to
102 free up disk space. An <endrec> of 0 indicates the current last record.
103 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
104 .TP
105 .B check 
106 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
107 .TP
108 .B df [-i] [-h] [--lazy] [--pool|-p <fsname>[.<pool>] [path]
109 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
110 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR.  By default
111 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
112 specified print only the usage of that filesystem.  If \fB-h\fR is given, the
113 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
114 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
115 The \fB--lazy\fR/\fB-l\fR option skips any OST that is currently disconnected
116 from the client.  This avoids blocking the \fBdf\fR output if an OST is down,
117 and only returns the space on the OSTs that can currently be accessed.
118 .TP
119 .B find 
120 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.
121 .TP
122 .B getname [-h]|[path ...]
123 Report all the Lustre mount points and the corresponding Lustre filesystem
124 instance. If one or more \fBpath\fR entries are provided, then only the
125 Lustre instance for these mount points is returned. If the path given is not on
126 a Lustre instance 'No such device' is reported.
127 .TP
128 .B osts 
129 .RB [ path ]
130 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
131 that is located on a lustre mounted file system then only the OSTs belonging
132 to that filesystem are displayed.
133 .TP
134 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
135         \fB[--count | -c ] [--index | -i | --offset | -o  ]
136         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
137         \fB[--layout | -L]
138         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
139 .br
140 List the striping information for a given filename or directory tree.
141 By default the stripe count, size, and offset will be returned. If you
142 only want specific striping information then the options of
143 .BR --count ,
144 .BR --size ,
145 .BR --index ,
146 .BR --offset ,
147 .BR --layout ,
148 or
149 .B --pool  
150 can be used to return only the specific fields.
151 .br
152 If the
153 .B --raw
154 option is specified, the stripe information is printed without substituting the
155 filesystem's default values for unspecified fields. If the striping EA is not
156 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
157 respectively.
158 In the case where you only want details about the files' object id
159 information then the
160 .B --quiet
161 option is used. Additional information available about striping can be
162 displayed with
163 .BR --verbose .
164 The default behavior when a directory is specified is to list the striping
165 information for all files within the specified directory (like
166 .RB ' "ls -l" ') .
167 This can be expanded with
168 .B --recursive
169 which will recurse into all subdirectories.
170 If you wish to get striping information for only the specified directory, then
171 .B --directory
172 can be used to limit the information, like
173 .RB ' "ls -d" ').
174 You can limit the returned files to those with objects on a specific OST with
175 .BR --obd .
176 .TP
177 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
178         \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
179         \fB<dirname|filename>\fR
180 .br
181 To create a new file, or set the directory default, with the specified striping parameters.  The
182 .I stripe_count
183 is the number of OSTs to stripe a file over. A
184 .I stripe_count
185 of 0 means to use the filesystem-wide default stripe count (default 1), and a
186 .I stripe_count
187 of -1 means to stripe over all available OSTs.  The
188 .I stripe_size
189 is the number of bytes to store on each OST before moving to the next OST.  A
190 .I stripe_size
191 of 0 means to use the filesystem-wide default stripe_size (default 1MB).  The
192 .I start_ost_index
193 is the OST index (starting at 0) on which to start striping for this file.  A
194 .I start_ost_index
195 of -1 allows the MDS to choose the starting index and it is strongly recommended, as this allows space and load balancing to be done by the MDS as needed.  The
196 .I poolname
197 is the name of a predefined pool of OSTs (see 
198 .B lctl
199 ) that will be used for striping. The 
200 .IR stripe_count ,
201 .IR stripe_size ,
202 and
203 .I start_ost_index
204 will be used as well; the 
205 .I start_ost_index
206 must be part of the pool or an error will be returned. 
207 .TP
208 .B setstripe -d
209 Delete the default striping on the specified directory.
210 .TP
211 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
212 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
213 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
214 hard links, then all of the pathnames for that file are printed, unless
215 \fB--link\fR limits the printing to only the specified link number (starting
216 at 0, in no particular order).  If multiple fids are specified, but only a
217 single pathname is needed for each file, use \fB--link 0\fR.
218 .TP
219 .B path2fid <path> ...
220 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
221 are given, then they will be printed one per line with the path as prefix.
222 .TP
223 .B pool_list
224 .RI { filesystem }[ .poolname "] | {" pathname }
225 List the pools in 
226 .I filesystem
227 or
228 .IR pathname ,
229 or the OSTs in
230 .IR filesystem.pool .
231 .TP
232 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
233 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).
234 .TP
235 .B quota -t <-u|-g> <filesystem>
236 To display block and inode grace times for user (-u) or group (-g) quotas
237 .TP
238 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
239 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.
240 .TP
241 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
242 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>)
243 .TP
244 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
245 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>=""
246 .TP
247 .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>
248 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
249 .TP
250 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
251 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
252 .TP
253 .B swap_layouts <filename1> <filename2>
254 Swap the data (layout and OST objects) of two regular files. The
255 two files have to be in the same filesystem, owned by the same user,
256 reside on the same MDT and writable by the user.
258 Swapping the layout of two directories is not permitted.
259 .TP
260 .B data_version [-n] <filename>
261 Display current version of file data. If -n is specified, data version is read
262 without taking lock. As a consequence, data version could be outdated if there
263 is dirty caches on filesystem clients, but this will not force data flushes and
264 has less impact on filesystem.
266 Even without -n, race conditions are possible and data version should be
267 checked before and after an operation to be confident the data did not change
268 during it.
269 .TP
270 .B mkdir <--index|-i mdt_index> <dir>
271 Allocate a new directory on a specified MDT.  
273 The "lfs mkdir" command is only executable by root unless
274 "mdt.*.enable_remote_dir_gid" is set via "lctl set_param" to be either a
275 non-zero GID to limit it to a single group (e.g. "operator" or "admin"),
276 or "-1" to allow any group to create remote directories.
278 The root of the file system is on MDT0000, and directories and files inherit the
279 MDT of their parent directory unless a different MDT is specified with this
280 command.
282 By default, only directories on MDT0000 can contain directories that are not on
283 the same MDT.  However, if "mdt.*.enable_remote_dir" is set non-zero on an MDT
284 then it will allow creating remote directories that have parents other than
285 MDT0000. This is restricted to avoid creating directory trees that have
286 intermediate path components on a series different MDTs and become unavailable
287 if any of the intermediate MDTs are offline.
288 .TP
289 .B --version
290 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
291 .TP
292 .B help 
293 Provides brief help on the various arguments
294 .TP
295 .B exit/quit 
296 Quit the interactive lfs session
298 .TP
299 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
300 This creates a file striped on two OSTs with 128kB on each stripe.
301 .TP
302 .B $ lfs setstripe -d /mnt/lustre/dir
303 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
304 .TP
305 .B $ lfs getstripe -v /mnt/lustre/file1
306 Lists the detailed object allocation of a given file
307 .TP
308 .B $ lfs find /mnt/lustre
309 Efficiently lists all files in a given directory and its subdirectories
310 .TP
311 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
312 Recursively list all regular files in given directory more than 30 days old
313 .TP
314 .B $ lfs find --obd OST2-UUID /mnt/lustre/
315 Recursively list all files in a given directory that have objects on OST2-UUID.
316 .tP
317 .B $ lfs check servers 
318 Check the status of all servers (MDT, OST)
319 .TP
320 .B $ lfs osts
321 List all the OSTs
322 .TP
323 .B $ lfs df -h 
324 Lists space usage per OST and MDT in human readable format.
325 .TP
326 .B $ lfs df -i 
327 Lists inode usage per OST and MDT
328 .TP
329 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
330 List space or inode usage for a specific OST pool
331 .TP
332 .B $ lfs quota -u bob /mnt/lustre
333 List quotas of user `bob'
334 .TP
335 .B $ lfs quota -t -u /mnt/lustre
336 Show grace times for user quotas on /mnt/lustre
337 .TP
338 .B $ lfs quotachown -i /mnt/lustre
339 Change file owner and group
340 .TP
341 .B $ lfs quotacheck -ug /mnt/lustre
342 Quotacheck for user and group - will turn on quotas after making the check.
343 .TP
344 .B $ lfs quotaon -ug /mnt/lustre
345 Turn quotas of user and group on
346 .TP
347 .B $ lfs quotaoff -ug /mnt/lustre
348 Turn quotas of user and group off
349 .TP
350 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
351 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
352 .TP
353 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
354 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
355 .TP
356 .SH BUGS
357 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
359 The lfs command is part of the Lustre filesystem.
361 .BR lfs-hsm (1),
362 .BR lfs-setdirstripe (1),
363 .BR lfs-getdirstripe (1),
364 .BR lfs-mkdir (1),
365 .BR lctl (8),
366 .BR lustre (7)