Whamcloud - gitweb
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2008 Mar 15" Lustre "user utilities"
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
5 .br
6 .B lfs
7 .br
8 .B lfs check <mds|osts|servers>
9 .br
10 .B lfs df [-i] [-h] [path]
11 .br
12 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
13         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
14         \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid[s]>]
15         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
16         \fB[[!] --gid|-g N] [[!] --group|-G <name>]
17         \fB[[!] --uid|-u N] [[!] --user|-U <name>]
18         \fB<dirname|filename>\fR
19 .br
20 .B lfs osts
21 .br
22 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
23         \fB[--recursive|-r] <dirname|filename>\fR
24 .br
25 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
26         \fB[--offset|-o start-ost] [--pool|-p pool-name]
27         \fB<dir|filename>\fR
28 .br
29 .B lfs setstripe -d <dir>
30 .br
31 .B lfs poollist <filesystem>[.<pool>] | <pathname>
32 .br
33 .B lfs quota [-v] [-o obd_uuid] [-u|-g] <username|groupname> <filesystem>
34 .br
35 .B lfs quota <filesystem>
36 .br
37 .B lfs quota -t [-u|-g] <filesystem>
38 .br
39 .B lfs quotacheck [-ug] <filesystem>
40 .br
41 .B lfs quotachown [-i] <filesystem>
42 .br
43 .B lfs quotaon [-ugf] <filesystem>
44 .br
45 .B lfs quotaoff [-ug] <filesystem>
46 .br
47 .B lfs quotainv [-ug] [-f] <filesystem>
48 .br
49 .B lfs setquota [-u|--user|-g|--group] <username|groupname>
50              \fB[--block-softlimit <block-softlimit>]
51              \fB[--block-hardlimit <block-hardlimit>]
52              \fB[--inode-softlimit <inode-softlimit>]
53              \fB[--inode-hardlimit <inode-hardlimit>]
54              \fB<filesystem>\fR
55 .br
56 .B lfs setquota [-u|--user|-g|--group] <username|groupname>
57              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
58              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
59              \fB<filesystem>\fR
60 .br
61 .B lfs setquota -t [-u|-g]
62              \fB[--block-grace <block-grace>]
63              \fB[--inode-grace <inode-grace>]
64              \fB<filesystem>\fR
65 .br
66 .B lfs setquota -t [-u|-g]
67              \fB[-b <block-grace>] [-i <inode-grace>]
68              \fB<filesystem>\fR
69 .br
71 .B lfs quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g] <username|groupname> <filesystem>
72 .br
73 .B lfs quota <filesystem>
74 .br
75 .B lfs quota -t [-u|-g] <filesystem>
76 .br
77 .B lfs help
79 .B lfs
80 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. 
82 The various options supported by lctl are listed and explained below:
83 .TP
84 .B check 
85 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
86 .TP
87 .B df
88 Report filesystem disk space usage or inodes usage of each MDT/OST.
89 .TP
90 .B find 
91 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.
92 .TP
93 .B osts 
94 List all the OSTs for the filesystem
95 .TP
96 .B getstripe
97 To list the striping info for a given filename or files in a directory, optionally recursively, for all files in a directory tree: \fB--quiet\fR (don't print object IDs), \fB--verbose\fR (print striping parameters), \fB--recursive\fR (recurse into subdirectories).
98 .TP
99 .B setstripe [--size stripe-size] [--count stripe-cnt] 
100         \fB[--offset start-ost] [--pool pool-name]\fR
101 .br
102 To create a new file, or set the directory default, with the specified striping parameters.  The
103 .I stripe-count
104 is the number of OSTs to stripe a file over. A
105 .I stripe-count
106 of 0 means to use the filesystem-wide default stripe count (default 1), and a
107 .I stripe-count
108 of -1 means to stripe over all available OSTs.  The
109 .I stripe-size
110 is the number of bytes to store on each OST before moving to the next OST.  A
111 .I stripe-size
112 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
113 .I start-ost
114 is the OST index (base 10, starting at 0) on which to start striping for this file.  A
115 .I start-ost
116 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
117 .I pool-name
118 is the name of a predefined pool of OSTs (see 
119 .I lctl
120 ) that will be used for striping. The 
121 .I stripe-count, stripe-size, start-ost
122 will be used as well; the 
123 .I start-ost
124 must be part of the pool or an error will be returned. 
125 .TP
126 .B setstripe -d
127 Delete the default striping on the specified directory.
128 .TP
129 .B poollist <filesystem>[.<pool>] | <pathname>
130 List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
131 .TP
132 .B quotachown
133 To change files' owner and group on OSTs of the specified filesystem
134 .TP
135 .B quotacheck [-ugf] <filesystem>
136 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)
137 .TP
138 .B quotaon [-ugf] <filesystem>
139 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
140 .TP
141 .B quotaoff [-ugf] <filesystem>
142 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
143 .TP
144 .B quotainv [-ug] [-f] <filesystem>
145 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.
146 .TP
147 .B setquota  [-u|-g] <name> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
148 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
149 .TP
150 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
151 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
152 .TP
153 .B quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g] <username|groupname> <filesystem>
154 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name 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.
155 .TP
156 .B quota -t [-u|-g] <filesystem>
157 To display block and inode grace times for user (-u) or group (-g) quotas
158 .TP
159 .B help 
160 Provides brief help on the various arguments
161 .TP
162 .B exit/quit 
163 Quit the interactive lfs session
165 .TP
166 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
167 This creates a file striped on two OSTs with 128kB on each stripe.
168 .TP
169 .B $ lfs setstripe -d /mnt/lustre/dir
170 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
171 .TP
172 .B $ lfs getstripe -v /mnt/lustre/file1
173 Lists the detailed object allocation of a given file
174 .TP
175 .B $ lfs find /mnt/lustre
176 Efficiently lists all files in a given directory and its subdirectories
177 .TP
178 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
179 Recursively list all regular files in given directory more than 30 days old
180 .TP
181 .B $ lfs find --obd OST2-UUID /mnt/lustre/
182 Recursively list all files in a given directory that have objects on OST2-UUID.
183 .tP
184 .B $ lfs check servers 
185 Check the status of all servers (MDT, OST)
186 .TP
187 .B $ lfs osts
188 List all the OSTs
189 .TP
190 .B $ lfs df -h 
191 Lists space usage per OST and MDT in human readable format.
192 .TP
193 .B $ lfs df -i 
194 Lists inode usage per OST and MDT
195 .TP
196 .B $ lfs quotachown -i /mnt/lustre
197 Change file owner and group
198 .TP
199 .B $ lfs quotacheck -ug /mnt/lustre
200 Quotacheck for user and group - will turn on quotas after making the check.
201 .TP
202 .B $ lfs quotaon -ug /mnt/lustre
203 Turn quotas of user and group on
204 .TP
205 .B $ lfs quotaoff -ug /mnt/lustre
206 Turn quotas of user and group off
207 .TP
208 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
209 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
210 .TP
211 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
212 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
213 .TP
214 .B $ lfs quota -u bob /mnt/lustre
215 List quotas of user `bob'
216 .TP
217 .B $ lfs quota -t -u /mnt/lustre
218 Show grace times for user quotas on /mnt/lustre
219 .SH BUGS
220 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
221 Report bugs using http://bugzilla.lustre.org.
223 The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
225 .BR lctl (8),
226 .BR lustre (7)