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