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