Whamcloud - gitweb
b=3244
[fs/lustre-release.git] / lustre / doc / lfs.lyx
1 #LyX 1.3 created this file. For more info see http://www.lyx.org/
2 \lyxformat 221
3 \textclass amsart
4 \language english
5 \inputencoding auto
6 \fontscheme times
7 \graphics default
8 \paperfontsize default
9 \spacing single 
10 \papersize letterpaper
11 \paperpackage a4
12 \use_geometry 0
13 \use_amsmath 0
14 \use_natbib 0
15 \use_numerical_citations 0
16 \paperorientation portrait
17 \secnumdepth 3
18 \tocdepth 3
19 \paragraph_separation skip
20 \defskip medskip
21 \quotes_language english
22 \quotes_times 2
23 \papercolumns 1
24 \papersides 1
25 \paperpagestyle default
26
27 \layout Section
28
29 LFS
30 \layout Subsection
31
32 NAME
33 \layout Description
34
35 lfs Lustre utility to create a file with specific striping pattern and manipulat
36 e disk quotas
37 \layout Subsection
38
39 SYNOPSIS
40 \layout Standard
41
42
43 \series bold 
44 lfs
45 \layout Standard
46
47
48 \series bold 
49 lfs\SpecialChar ~
50 find [--atime|-A N] [--mtime|-M N] [--ctime|-C N] [--maxdepth|-D N] [--print0
51 |-P] [--print|-p] [--obd|-O <uuid>] <dir/file>
52 \layout Standard
53
54
55 \series bold 
56 lfs\SpecialChar ~
57 find [--quiet|-q] [--verbose|-v] [--recursive|-r] <dir/file>
58 \layout Standard
59
60
61 \series bold 
62 lfs\SpecialChar ~
63 getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] [--recursive|-r]
64  <dir/file>
65 \layout Standard
66
67
68 \series bold 
69 lfs\SpecialChar ~
70 setstripe <filename|dirname> <stripe_size> <start_ost> <stripe_cnt>
71 \layout Standard
72
73
74 \series bold 
75 lfs\SpecialChar ~
76 setstripe -d <dirname>
77 \layout Standard
78
79
80 \series bold 
81 lfs\SpecialChar ~
82 check <mds| osts| servers>
83 \layout Standard
84
85
86 \series bold 
87 lfs\SpecialChar ~
88 quotachog [-i] <filesystem>
89 \layout Standard
90
91
92 \series bold 
93 lfs\SpecialChar ~
94 quotacheck [-ug] <filesystem>
95 \layout Standard
96
97
98 \series bold 
99 lfs\SpecialChar ~
100 quotaon [-ugf] <filesystem>
101 \layout Standard
102
103
104 \series bold 
105 lfs\SpecialChar ~
106 quotaoff [-ug] <filesystem>
107 \layout Standard
108
109
110 \series bold 
111 lfs\SpecialChar ~
112 setquota [-u|-g] <name> <block-softlimit> <block-hardlimit> <inode-softlimit>
113  <inode-hardlimit> <filesystem>
114 \layout Standard
115
116
117 \series bold 
118 lfs\SpecialChar ~
119 quota [-o obd_uuid] [-u|-g] <name> <filesystem>
120 \layout Standard
121
122
123 \series bold 
124 lfs\SpecialChar ~
125 df [-i] [-h] [path]
126 \layout Standard
127
128
129 \series bold 
130 lfs\SpecialChar ~
131 help
132 \layout Subsection
133
134 DESCRIPTION
135 \layout Standard
136
137 This utility can be used to create a new file with a specific striping pattern,
138  determine the default striping pattern, gather the extended attributes
139  (object numbers and location) for a specific file, and manipulate disk
140  quotas.
141  It can be invoked interactively without any arguments or in a non-interactive
142  mode with one of the arguements listed and explained below:
143 \layout List
144 \labelwidthstring 00.00.0000
145
146
147 \series bold 
148 setstripe
149 \series default 
150  To create a new file with a specific striping pattern
151 \layout List
152 \labelwidthstring 00.00.0000
153
154
155 \series bold 
156 find
157 \series default 
158  To search the directory tree rooted at the given dir/file name for the
159  files that match the given parameters: --atime (file was last accessed
160  N*24 hours ago), --ctime (file's status was last changed N*24 hours ago),
161  --mtime (file's data was last modified N*24 hours ago), --obd (file has
162  an object on a specific OST).
163  The option --maxdepth allows find to decend at most N levels of directory
164  tree.
165  The options --print and --print0 print full file name, followed by a newline
166  and null character correspondingly.
167 \layout List
168 \labelwidthstring 00.00.0000
169
170
171 \series bold 
172 find
173 \series default 
174  To list the striping info for a given filename or files in a directory
175  or recursively for all files in a directory tree use one of the following
176  options: [--quiet|-q] [--verbose|-v] [--recursive|-r].
177  If one of these options is given find works in old (obsolete, please use
178  getstripe instead) mode.
179  
180 \layout List
181 \labelwidthstring 00.00.0000
182
183
184 \series bold 
185 getstripe
186 \series default 
187  To list the striping info for given filename or files in a directory or
188  recursively for all files in a directory tree.
189  It can also be used to list the files that have objects on a specific OST.
190 \layout List
191 \labelwidthstring 00.00.0000
192
193
194 \series bold 
195 check 
196 \series default 
197 Display the status of MDS or OSTs (as specified in the command) or all the
198  servers (MDS and OSTs)
199 \layout List
200 \labelwidthstring 00.00.0000
201
202
203 \series bold 
204 osts
205 \series default 
206  List all the OSTs for the filesystem
207 \layout List
208 \labelwidthstring 00.00.0000
209
210
211 \series bold 
212 quotachog
213 \series default 
214  Change files' owner and group on OSTs of the specified filesystem
215 \layout List
216 \labelwidthstring 00.00.0000
217
218
219 \series bold 
220 quotacheck
221 \series default 
222  Scan the specified filesystem for disk usage, and create or update quota
223  files
224 \layout List
225 \labelwidthstring 00.00.0000
226
227
228 \series bold 
229 quotaon
230 \series default 
231  Turn filesystem quotas on
232 \layout List
233 \labelwidthstring 00.00.0000
234
235
236 \series bold 
237 quotaoff
238 \series default 
239  Turn filesystem quotas off
240 \layout List
241 \labelwidthstring 00.00.0000
242
243
244 \series bold 
245 setquota
246 \series default 
247  Set filesystem quotas
248 \layout List
249 \labelwidthstring 00.00.0000
250
251
252 \series bold 
253 quota
254 \series default 
255  Display disk usage and limits
256 \layout List
257 \labelwidthstring 00.00.0000
258
259
260 \series bold 
261 df
262 \series default 
263  Report filesystem disk space usage or inodes usage of each MDS/OSD.
264 \layout List
265 \labelwidthstring 00.00.0000
266
267
268 \series bold 
269 help
270 \series default 
271  Provides brief help on the various arguments
272 \layout List
273 \labelwidthstring 00.00.0000
274
275
276 \series bold 
277 exit/quit
278 \series default 
279  Quit the interactive lfs session
280 \layout Subsection
281
282 EXAMPLES
283 \layout Description
284
285 This creates a file striped on one OST
286 \layout LyX-Code
287
288    $ lfs setstripe /mnt/lustre/file1 131072 0 1
289 \layout Description
290
291 This creates a default stripe pattern on and existing dir for all new files
292  created therein.
293 \layout LyX-Code
294
295    $ lfs setstripe /mnt/lustre/dir 131072 0 1
296 \layout Description
297
298 This deletes a default stripe pattern on dir.
299   New files will use the default striping pattern.
300  created therein.
301 \layout LyX-Code
302
303    $ lfs setstripe -d /mnt/lustre/dir
304 \layout Description
305
306 Listing the extended attributes of a given file
307 \layout LyX-Code
308
309    $ lfs find /mnt/lustre/foo1
310 \layout LyX-Code
311
312    OBDS:    
313 \layout LyX-Code
314
315       0: OST_localhost_UUID 
316 \layout LyX-Code
317
318    /mnt/lustre/foo1         
319 \layout LyX-Code
320
321    obdidx           objid          objid            group              
322 \layout LyX-Code
323
324    0                 1            0x1                0 
325 \layout Description
326
327 Listing the extended attributes of all files in a given directory
328 \layout LyX-Code
329
330    $ lfs find /mnt/lustre/
331 \layout Description
332
333 Recursively list the extended attributes of all files in a given directory
334  tree
335 \layout LyX-Code
336
337    $ lfs find -r /mnt/lustre/
338 \layout Description
339
340 List all the files that have objects on a specific OST
341 \layout LyX-Code
342
343    $ lfs find -r --obd OST2_UUID /mnt/lustre/
344 \layout Description
345
346 Check the status of all servers(mds, osts)
347 \layout LyX-Code
348
349    $ lfs check servers 
350 \layout LyX-Code
351
352    OSC_localhost.localdomain_OST_localhost_mds1 active.
353  
354 \layout LyX-Code
355
356    OSC_localhost.localdomain_OST_localhost_MNT_localhost active.
357  
358 \layout LyX-Code
359
360    MDC_localhost.localdomain_mds1_MNT_localhost active.
361 \layout LyX-Code
362
363    $
364 \layout Description
365
366 List all the OSTs
367 \layout LyX-Code
368
369    $ lfs osts 
370 \layout LyX-Code
371
372    OBDS:    
373 \layout LyX-Code
374
375    0: OST_localhost_UUID   
376 \layout LyX-Code
377
378    $
379 \layout Description
380
381 Change\SpecialChar ~
382 file\SpecialChar ~
383 owner\SpecialChar ~
384 and\SpecialChar ~
385 group
386 \layout LyX-Code
387
388    $lfs quotachog -i /mnt/lustre
389 \layout Description
390
391 Quotacheck\SpecialChar ~
392 for\SpecialChar ~
393 user\SpecialChar ~
394 and\SpecialChar ~
395 group
396 \layout LyX-Code
397
398    $lfs quotacheck -ug /mnt/lustre
399 \layout Description
400
401 Turn\SpecialChar ~
402 quotas\SpecialChar ~
403 of\SpecialChar ~
404 user\SpecialChar ~
405 and\SpecialChar ~
406 group\SpecialChar ~
407 on
408 \layout LyX-Code
409
410    $lfs quotaon -ug /mnt/lustre
411 \layout Description
412
413 Turn\SpecialChar ~
414 quotas\SpecialChar ~
415 of\SpecialChar ~
416 user\SpecialChar ~
417 and\SpecialChar ~
418 group\SpecialChar ~
419 off
420 \layout LyX-Code
421
422    $lfs quotaoff -ug /mnt/lustre
423 \layout Description
424
425 Set\SpecialChar ~
426 quotas\SpecialChar ~
427 of\SpecialChar ~
428 user\SpecialChar ~
429 `bob':\SpecialChar ~
430 1GB\SpecialChar ~
431 block\SpecialChar ~
432 quota\SpecialChar ~
433 and\SpecialChar ~
434 10,000\SpecialChar ~
435 file\SpecialChar ~
436 quota
437 \layout LyX-Code
438
439    $lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
440 \layout Description
441
442 List\SpecialChar ~
443 quotas\SpecialChar ~
444 of\SpecialChar ~
445 user\SpecialChar ~
446 `bob'
447 \layout LyX-Code
448
449    $lfs quota -u bob /mnt/lustre
450 \layout Subsection
451
452 BUGS
453 \layout Standard
454
455 None are known.
456 \the_end