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