Whamcloud - gitweb
b31f5ffd61d28319161a6f0f785ed6b90434ca2a
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2003 Oct 29" Lustre "configuration utilities"
2 .SH NAME
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
4 .SH SYNOPSIS
5 .br
6 .B lfs
7 .br
8 .B lfs find [--obd <uuid>] [--quiet | --verbose] [--recursive] <dir|file>
9 .br
10 .B lfs getstripe <filename> 
11 .br
12 .B lfs setstripe <filename> <stripe-size> <start-ost> <stripe-cnt>
13 .br
14 .B lfs quotachown [-i] <filesystem>
15 .br
16 .B lfs quotacheck [-ug] <filesystem>
17 .br
18 .B lfs quotaon [-ugf] <filesystem>
19 .br
20 .B lfs quotaoff [-ug] <filesystem>
21 .br
22 .B lfs setquota [-u|-g] <name> <block-softlimit> <block-hardlimit> <inode-softlimit> <inode-hardlimit> <filesystem>
23 .br
24 .B lfs quota [-o obd_uuid] [-u|-g] <name> <filesystem>
25 .br
26 .B lfs setstripe <filename> <stripe-size> <start-ost> <stripe-cnt>
27 .br
28 .B lfs check <mds| osts| servers>
29 .SH DESCRIPTION
30 .B lfs
31 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 
32 location) for a specific file. It can be invoked interactively without any 
33 arguments or in a non-interactive mode with one of the arguements supported. 
34 .SH OPTIONS
35 The various options supported by lctl are listed and explained below:
36 .TP
37 .B setstripe 
38 To create a new file with a specific striping pattern
39 .TP
40 .B find 
41 To list the extended attributes for a given filename or files in a directory or recursively for all files in a directory tree. It can also be used to list the files that have objects on a specific OST. 
42 .TP
43 .B getstripe 
44 To list the striping pattern for given filename
45 .TP
46 .B quotachown
47 To change files' owner and group on OSTs of the specified filesystem
48 .TP
49 .B quotacheck
50 To scan the specified filesystem for disk usage, and create or update quota files
51 .TP
52 .B quotaon
53 To turn filesystem quotas on
54 .TP
55 .B quotaoff
56 To turn filesystem quotas off
57 .TP
58 .B setquota
59 To set filesystem quotas
60 .TP
61 .B quota
62 To display disk usage and limits
63 .TP
64 .B check 
65 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
66 .TP
67 .B osts 
68 List all the OSTs for the filesystem
69 .TP
70 .B help 
71 Provides brief help on the various arguments
72 .TP
73 .B exit/quit 
74 Quit the interactive lfs session
75 .SH EXAMPLES
76 .TP
77 .B $lfs setstripe /mnt/lustre/file1 131072 0 1
78 This creats a file striped on one OST
79 .TP
80 .B $lfs find /mnt/lustre/file1
81 Lists the extended attributes of a given file
82 .TP
83 .B $lfs find /mnt/lustre/
84 Lists the extended attributes of all files in a given directory
85 .TP
86 .B $lfs find -r /mnt/lustre/
87 Recursively list the extended attributes of all files in a given directory tree
88 .TP
89 .B $lfs find -r --obd OST2-UUID /mnt/lustre/
90 List all the files that have objects on a specific OST
91 .TP
92 .B $lfs quotachown -i /mnt/lustre
93 Change file owner and group
94 .TP
95 .B $lfs quotacheck -ug /mnt/lustre
96 Quotacheck for user and group
97 .TP
98 .B $lfs quotaon -ug /mnt/lustre
99 Turn quotas of user and group on
100 .TP
101 .B $lfs quotaoff -ug /mnt/lustre
102 Turn quotas of user and group off
103 .TP
104 .B $lfs setquota -u bob 0 1000000 0 10000 /mnt/lustre
105 Set quotas of user `bob': 1GB block quota and 10,000 file quota
106 .TP
107 .B $lfs quota -u bob /mnt/lustre
108 List quotas of user `bob'
109 .TP
110 .B $ lfs find -r --obd OST2-UUID /mnt/lustre/
111 .TP
112 .B $lfs check servers 
113 Check the status of all servers(mds, osts)
114 .TP
115 .B $lfs osts
116 List all the OSTs
117 .SH BUGS
118 None are known.