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 quota [-o obd_uuid] [-u|-g] <name> <filesystem>
148 \end_layout
149
150 \begin_layout Standard
151
152 \series bold
153 lfs\InsetSpace ~
154 df [-i] [-h] [path]
155 \end_layout
156
157 \begin_layout Standard
158
159 \series bold
160 lfs\InsetSpace ~
161 help
162 \end_layout
163
164 \begin_layout Subsection
165 DESCRIPTION
166 \end_layout
167
168 \begin_layout Standard
169 This utility can be used to create a new file with a specific striping pattern,
170  determine the default striping pattern, gather the extended attributes
171  (object numbers and location) for a specific file, and manipulate disk
172  quotas.
173  It can be invoked interactively without any arguments or in a non-interactive
174  mode with one of the arguements listed and explained below:
175 \end_layout
176
177 \begin_layout List
178 \labelwidthstring 00.00.0000
179
180 \series bold
181 setstripe
182 \series default
183  To create a new file with a specific striping pattern
184 \end_layout
185
186 \begin_layout List
187 \labelwidthstring 00.00.0000
188
189 \series bold
190 find
191 \series default
192  To search the directory tree rooted at the given dir/file name for the
193  files that match the given parameters: --atime (file was last accessed
194  N*24 hours ago), --ctime (file's status was last changed N*24 hours ago),
195  --mtime (file's data was last modified N*24 hours ago), --obd (file has
196  an object on a specific OST).
197  The option --maxdepth allows find to decend at most N levels of directory
198  tree.
199  The options --print and --print0 print full file name, followed by a newline
200  and null character correspondingly.
201 \end_layout
202
203 \begin_layout List
204 \labelwidthstring 00.00.0000
205
206 \series bold
207 find
208 \series default
209  To list the striping info for a given filename or files in a directory
210  or recursively for all files in a directory tree use one of the following
211  options: [--quiet|-q] [--verbose|-v] [--recursive|-r].
212  If one of these options is given find works in old (obsolete, please use
213  getstripe instead) mode.
214  
215 \end_layout
216
217 \begin_layout List
218 \labelwidthstring 00.00.0000
219
220 \series bold
221 getstripe
222 \series default
223  To list the striping info for given filename or files in a directory or
224  recursively for all files in a directory tree.
225  It can also be used to list the files that have objects on a specific OST.
226 \end_layout
227
228 \begin_layout List
229 \labelwidthstring 00.00.0000
230
231 \series bold
232 check 
233 \series default
234 Display the status of MDS or OSTs (as specified in the command) or all the
235  servers (MDS and OSTs)
236 \end_layout
237
238 \begin_layout List
239 \labelwidthstring 00.00.0000
240
241 \series bold
242 osts
243 \series default
244  List all the OSTs for the filesystem
245 \end_layout
246
247 \begin_layout List
248 \labelwidthstring 00.00.0000
249
250 \series bold
251 quotachog
252 \series default
253  Change files' owner and group on OSTs of the specified filesystem
254 \end_layout
255
256 \begin_layout List
257 \labelwidthstring 00.00.0000
258
259 \series bold
260 quotacheck
261 \series default
262  Scan the specified filesystem for disk usage, and create or update quota
263  files
264 \end_layout
265
266 \begin_layout List
267 \labelwidthstring 00.00.0000
268
269 \series bold
270 quotaon
271 \series default
272  Turn filesystem quotas on
273 \end_layout
274
275 \begin_layout List
276 \labelwidthstring 00.00.0000
277
278 \series bold
279 quotaoff
280 \series default
281  Turn filesystem quotas off
282 \end_layout
283
284 \begin_layout List
285 \labelwidthstring 00.00.0000
286
287 \series bold
288 setquota
289 \series default
290  Set filesystem quotas
291 \end_layout
292
293 \begin_layout List
294 \labelwidthstring 00.00.0000
295
296 \series bold
297 quota
298 \series default
299  Display disk usage and limits
300 \end_layout
301
302 \begin_layout List
303 \labelwidthstring 00.00.0000
304
305 \series bold
306 df
307 \series default
308  Report filesystem disk space usage or inodes usage of each MDS/OSD.
309 \end_layout
310
311 \begin_layout List
312 \labelwidthstring 00.00.0000
313
314 \series bold
315 help
316 \series default
317  Provides brief help on the various arguments
318 \end_layout
319
320 \begin_layout List
321 \labelwidthstring 00.00.0000
322
323 \series bold
324 exit/quit
325 \series default
326  Quit the interactive lfs session
327 \end_layout
328
329 \begin_layout Subsection
330 EXAMPLES
331 \end_layout
332
333 \begin_layout Description
334 This creates a file striped on one OST
335 \end_layout
336
337 \begin_layout LyX-Code
338    $ lfs setstripe /mnt/lustre/file1 131072 0 1
339 \end_layout
340
341 \begin_layout Description
342 This creates a default stripe pattern on and existing dir for all new files
343  created therein.
344 \end_layout
345
346 \begin_layout LyX-Code
347    $ lfs setstripe /mnt/lustre/dir 131072 0 1
348 \end_layout
349
350 \begin_layout Description
351 This deletes a default stripe pattern on dir.
352   New files will use the default striping pattern.
353  created therein.
354 \end_layout
355
356 \begin_layout LyX-Code
357    $ lfs setstripe -d /mnt/lustre/dir
358 \end_layout
359
360 \begin_layout Description
361 Listing the extended attributes of a given file
362 \end_layout
363
364 \begin_layout LyX-Code
365    $ lfs find /mnt/lustre/foo1
366 \end_layout
367
368 \begin_layout LyX-Code
369    OBDS:    
370 \end_layout
371
372 \begin_layout LyX-Code
373       0: OST_localhost_UUID 
374 \end_layout
375
376 \begin_layout LyX-Code
377    /mnt/lustre/foo1         
378 \end_layout
379
380 \begin_layout LyX-Code
381    obdidx           objid          objid            group              
382 \end_layout
383
384 \begin_layout LyX-Code
385    0                 1            0x1                0 
386 \end_layout
387
388 \begin_layout Description
389 Listing the extended attributes of all files in a given directory
390 \end_layout
391
392 \begin_layout LyX-Code
393    $ lfs find /mnt/lustre/
394 \end_layout
395
396 \begin_layout Description
397 Recursively list the extended attributes of all files in a given directory
398  tree
399 \end_layout
400
401 \begin_layout LyX-Code
402    $ lfs find -r /mnt/lustre/
403 \end_layout
404
405 \begin_layout Description
406 List all the files that have objects on a specific OST
407 \end_layout
408
409 \begin_layout LyX-Code
410    $ lfs find -r --obd OST2_UUID /mnt/lustre/
411 \end_layout
412
413 \begin_layout Description
414 Check the status of all servers(mds, osts)
415 \end_layout
416
417 \begin_layout LyX-Code
418    $ lfs check servers 
419 \end_layout
420
421 \begin_layout LyX-Code
422    OSC_localhost.localdomain_OST_localhost_mds1 active.
423  
424 \end_layout
425
426 \begin_layout LyX-Code
427    OSC_localhost.localdomain_OST_localhost_MNT_localhost active.
428  
429 \end_layout
430
431 \begin_layout LyX-Code
432    MDC_localhost.localdomain_mds1_MNT_localhost active.
433 \end_layout
434
435 \begin_layout LyX-Code
436    $
437 \end_layout
438
439 \begin_layout Description
440 List all the OSTs
441 \end_layout
442
443 \begin_layout LyX-Code
444    $ lfs osts 
445 \end_layout
446
447 \begin_layout LyX-Code
448    OBDS:    
449 \end_layout
450
451 \begin_layout LyX-Code
452    0: OST_localhost_UUID   
453 \end_layout
454
455 \begin_layout LyX-Code
456    $
457 \end_layout
458
459 \begin_layout Description
460 Change\InsetSpace ~
461 file\InsetSpace ~
462 owner\InsetSpace ~
463 and\InsetSpace ~
464 group
465 \end_layout
466
467 \begin_layout LyX-Code
468    $lfs quotachog -i /mnt/lustre
469 \end_layout
470
471 \begin_layout Description
472 Quotacheck\InsetSpace ~
473 for\InsetSpace ~
474 user\InsetSpace ~
475 and\InsetSpace ~
476 group
477 \end_layout
478
479 \begin_layout LyX-Code
480    $lfs quotacheck -ug /mnt/lustre
481 \end_layout
482
483 \begin_layout Description
484 Turn\InsetSpace ~
485 quotas\InsetSpace ~
486 of\InsetSpace ~
487 user\InsetSpace ~
488 and\InsetSpace ~
489 group\InsetSpace ~
490 on
491 \end_layout
492
493 \begin_layout LyX-Code
494    $lfs quotaon -ug /mnt/lustre
495 \end_layout
496
497 \begin_layout Description
498 Turn\InsetSpace ~
499 quotas\InsetSpace ~
500 of\InsetSpace ~
501 user\InsetSpace ~
502 and\InsetSpace ~
503 group\InsetSpace ~
504 off
505 \end_layout
506
507 \begin_layout LyX-Code
508    $lfs quotaoff -ug /mnt/lustre
509 \end_layout
510
511 \begin_layout Description
512 Set\InsetSpace ~
513 quotas\InsetSpace ~
514 of\InsetSpace ~
515 user\InsetSpace ~
516 `bob':\InsetSpace ~
517 1GB\InsetSpace ~
518 block\InsetSpace ~
519 quota\InsetSpace ~
520 and\InsetSpace ~
521 10,000\InsetSpace ~
522 file\InsetSpace ~
523 quota
524 \end_layout
525
526 \begin_layout LyX-Code
527    $lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
528 \end_layout
529
530 \begin_layout Description
531 List\InsetSpace ~
532 quotas\InsetSpace ~
533 of\InsetSpace ~
534 user\InsetSpace ~
535 `bob'
536 \end_layout
537
538 \begin_layout LyX-Code
539    $lfs quota -u bob /mnt/lustre
540 \end_layout
541
542 \begin_layout Subsection
543 BUGS
544 \end_layout
545
546 \begin_layout Standard
547 None are known.
548 \end_layout
549
550 \end_body
551 \end_document