Whamcloud - gitweb
LU-3363 api: HSM import uses new released pattern
[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[[!] --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] [--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 .TP
114 .B find 
115 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.
116 .TP
117 .B getname [-h]|[path ...]
118 Report all the Lustre mount points and the corresponding Lustre filesystem
119 instance. If one or more \fBpath\fR entries are provided, then only the
120 Lustre instance for these mount points is returned. If the path given is not on
121 a Lustre instance 'No such device' is reported.
122 .TP
123 .B osts 
124 .RB [ path ]
125 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
126 that is located on a lustre mounted file system then only the OSTs belonging
127 to that filesystem are displayed.
128 .TP
129 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
130         \fB[--count | -c ] [--index | -i | --offset | -o  ]
131         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
132         \fB[--layout | -L]
133         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
134 .br
135 List the striping information for a given filename or directory tree.
136 By default the stripe count, size, and offset will be returned. If you
137 only want specific striping information then the options of
138 .BR --count ,
139 .BR --size ,
140 .BR --index ,
141 .BR --offset ,
142 .BR --layout ,
143 or
144 .B --pool  
145 can be used to return only the specific fields.
146 .br
147 If the
148 .B --raw
149 option is specified, the stripe information is printed without substituting the
150 filesystem's default values for unspecified fields. If the striping EA is not
151 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
152 respectively.
153 In the case where you only want details about the files' object id
154 information then the
155 .B --quiet
156 option is used. Additional information available about striping can be
157 displayed with
158 .BR --verbose .
159 The default behavior when a directory is specified is to list the striping
160 information for all files within the specified directory (like
161 .RB ' "ls -l" ') .
162 This can be expanded with
163 .B --recursive
164 which will recurse into all subdirectories.
165 If you wish to get striping information for only the specified directory, then
166 .B --directory
167 can be used to limit the information, like
168 .RB ' "ls -d" ').
169 You can limit the returned files to those with objects on a specific OST with
170 .BR --obd .
171 .TP
172 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
173         \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
174         \fB<dirname|filename>\fR
175 .br
176 To create a new file, or set the directory default, with the specified striping parameters.  The
177 .I stripe_count
178 is the number of OSTs to stripe a file over. A
179 .I stripe_count
180 of 0 means to use the filesystem-wide default stripe count (default 1), and a
181 .I stripe_count
182 of -1 means to stripe over all available OSTs.  The
183 .I stripe_size
184 is the number of bytes to store on each OST before moving to the next OST.  A
185 .I stripe_size
186 of 0 means to use the filesystem-wide default stripe_size (default 1MB).  The
187 .I start_ost_index
188 is the OST index (starting at 0) on which to start striping for this file.  A
189 .I start_ost_index
190 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
191 .I poolname
192 is the name of a predefined pool of OSTs (see 
193 .B lctl
194 ) that will be used for striping. The 
195 .IR stripe_count ,
196 .IR stripe_size ,
197 and
198 .I start_ost_index
199 will be used as well; the 
200 .I start_ost_index
201 must be part of the pool or an error will be returned. 
202 .TP
203 .B setstripe -d
204 Delete the default striping on the specified directory.
205 .TP
206 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
207 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
208 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
209 hard links, then all of the pathnames for that file are printed, unless
210 \fB--link\fR limits the printing to only the specified link number (starting
211 at 0, in no particular order).  If multiple fids are specified, but only a
212 single pathname is needed for each file, use \fB--link 0\fR.
213 .TP
214 .B path2fid <path> ...
215 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
216 are given, then they will be printed one per line with the path as prefix.
217 .TP
218 .B pool_list
219 .RI { filesystem }[ .poolname "] | {" pathname }
220 List the pools in 
221 .I filesystem
222 or
223 .IR pathname ,
224 or the OSTs in
225 .IR filesystem.pool .
226 .TP
227 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
228 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).
229 .TP
230 .B quota -t <-u|-g> <filesystem>
231 To display block and inode grace times for user (-u) or group (-g) quotas
232 .TP
233 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
234 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.
235 .TP
236 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
237 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>)
238 .TP
239 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
240 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>=""
241 .TP
242 .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>
243 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
244 .TP
245 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
246 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
247 .TP
248 .B swap_layouts <filename1> <filename2>
249 Swap the data (layout and OST objects) of two regular files. The
250 two files have to be in the same filesystem, owned by the same user,
251 reside on the same MDT and writable by the user.
253 Swapping the layout of two directories is not permitted.
254 .TP
255 .B data_version [-n] <filename>
256 Display current version of file data. If -n is specified, data version is read
257 without taking lock. As a consequence, data version could be outdated if there
258 is dirty caches on filesystem clients, but this will not force data flushes and
259 has less impact on filesystem.
261 Even without -n, race conditions are possible and data version should be
262 checked before and after an operation to be confident the data did not change
263 during it.
264 .TP
265 .B help 
266 Provides brief help on the various arguments
267 .TP
268 .B exit/quit 
269 Quit the interactive lfs session
271 .TP
272 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
273 This creates a file striped on two OSTs with 128kB on each stripe.
274 .TP
275 .B $ lfs setstripe -d /mnt/lustre/dir
276 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
277 .TP
278 .B $ lfs getstripe -v /mnt/lustre/file1
279 Lists the detailed object allocation of a given file
280 .TP
281 .B $ lfs find /mnt/lustre
282 Efficiently lists all files in a given directory and its subdirectories
283 .TP
284 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
285 Recursively list all regular files in given directory more than 30 days old
286 .TP
287 .B $ lfs find --obd OST2-UUID /mnt/lustre/
288 Recursively list all files in a given directory that have objects on OST2-UUID.
289 .tP
290 .B $ lfs check servers 
291 Check the status of all servers (MDT, OST)
292 .TP
293 .B $ lfs osts
294 List all the OSTs
295 .TP
296 .B $ lfs df -h 
297 Lists space usage per OST and MDT in human readable format.
298 .TP
299 .B $ lfs df -i 
300 Lists inode usage per OST and MDT
301 .TP
302 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
303 List space or inode usage for a specific OST pool
304 .TP
305 .B $ lfs quota -u bob /mnt/lustre
306 List quotas of user `bob'
307 .TP
308 .B $ lfs quota -t -u /mnt/lustre
309 Show grace times for user quotas on /mnt/lustre
310 .TP
311 .B $ lfs quotachown -i /mnt/lustre
312 Change file owner and group
313 .TP
314 .B $ lfs quotacheck -ug /mnt/lustre
315 Quotacheck for user and group - will turn on quotas after making the check.
316 .TP
317 .B $ lfs quotaon -ug /mnt/lustre
318 Turn quotas of user and group on
319 .TP
320 .B $ lfs quotaoff -ug /mnt/lustre
321 Turn quotas of user and group off
322 .TP
323 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
324 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
325 .TP
326 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
327 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
328 .SH BUGS
329 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
331 The lfs command is part of the Lustre filesystem.
333 .BR lfs-hsm (1),
334 .BR lctl (8),
335 .BR lustre (7)