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