Whamcloud - gitweb
[fs/lustre-release.git] / lustre / doc / lfs.1
1 .TH lfs 1 "2009 Jan 29" Lustre "user utilities"
3 lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of existing files
5 .br
6 .B lfs
7 .br
8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
9 .br
10 .B lfs changelog_clear <mdtname> <id> <endrec>
11 .br
12 .B lfs check <mds|osts|servers>
13 .br
14 .B lfs df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
15 .br
16 .B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
17         \fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
18         \fB[--print|-p] \fB[--print0|-P] [[!] --obd|-O <uuid[s]>]
19         \fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
20         \fB[[!] --gid|-g|--group|-G <gname>|<gid>]
21         \fB[[!] --uid|-u|--user|-U <uname>|<uid>]
22         \fB<dirname|filename>\fR
23 .br
24 .B lfs osts
25 .br
26 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
27         \fB[--count | -c ] [--index | -i | --offset | -o ]
28         \fB[--size | -s ] [--pool | -p ] [--directory | -d ]
29         \fB[--recursive|-r] <dirname|filename> ...\fR
30 .br
31 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
32         \fB[--index|-i|--offset|-o start_ost_index ] [--pool|-p <pool>]
33         \fB<dirname|filename>\fR
34 .br
35 .B lfs setstripe -d <dir>
36 .br
37 .B lfs poollist <filesystem>[.<pool>] | <pathname>
38 .br
39 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
40 .br
41 .B lfs quota -t <-u|-g> <filesystem>
42 .br
43 .B lfs quotacheck [-ug] <filesystem>
44 .br
45 .B lfs quotachown [-i] <filesystem>
46 .br
47 .B lfs quotaon [-ugf] <filesystem>
48 .br
49 .B lfs quotaoff [-ug] <filesystem>
50 .br
51 .B lfs quotainv [-ug] [-f] <filesystem>
52 .br
53 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
54              \fB[--block-softlimit <block-softlimit>]
55              \fB[--block-hardlimit <block-hardlimit>]
56              \fB[--inode-softlimit <inode-softlimit>]
57              \fB[--inode-hardlimit <inode-hardlimit>]
58              \fB<filesystem>\fR
59 .br
60 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
61              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
62              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
63              \fB<filesystem>\fR
64 .br
65 .B lfs setquota -t <-u|-g>
66              \fB[--block-grace <block-grace>]
67              \fB[--inode-grace <inode-grace>]
68              \fB<filesystem>\fR
69 .br
70 .B lfs setquota -t <-u|-g>
71              \fB[-b <block-grace>] [-i <inode-grace>]
72              \fB<filesystem>\fR
73 .br
74 .B lfs help
76 .B lfs
77 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. 
79 The various options supported by lctl are listed and explained below:
80 .TP
81 .B changelog
82 Show the metadata changes on an MDT.  Start and end points are optional.  The --follow option will block on new changes; this option is only valid when run direclty on the MDT node.
83 .TP
84 .B changelog_clear
85 Indicate that changelog records previous to <endrec> are no longer of
86 interest to a particular consumer <id>, potentially allowing the MDT to
87 free up disk space. An <endrec> of 0 indicates the current last record.
88 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
89 .TP
90 .B check 
91 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
92 .TP
93 .B df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
94 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
95 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR.  By default
96 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
97 specified print only the usage of that filesystem.  If \fB-h\fR is given, the
98 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
99 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
100 .TP
101 .B find 
102 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.
103 .TP
104 .B osts 
105 List all the OSTs for the filesystem
106 .TP
107 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v] 
108         \fB[--count | -c ] [--index | -i | --offset | -o  ]
109         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
110         \fB[--recursive|-r] <dirname|filename>\fR
111 .br
112 To list the striping information for a given filename or directory. By default the stripe count, size, and offset will be returned. If you only want specific striping information then the options of \fB--count\fR,\fB--size\fR,\fB--index\fR or \fB--offset\fR plus various combinations of these options can be used to retrieve only what you want. What pools a file belong to can also be obtained with \fB--pool\fR. In the case where you only want details about the files object id information then the \fB--quiet\fR option is used. Additional information available about striping can be displayed with \fB--verbose\fR. The default behavior of lfs getstripe used to retrieve data about a directory is to list all the contents of that directory. If you wish to inquire only about that directory then \fB--directory\fR,can be used to list directory entries instead of its contents in the same manner as ls -d. This can be expanded with \fB--recursive\fR which will recurse into all subdirectories. You can filter the search to return only files that has a object on a specific OST with \fB--obd\fR.
113 .TP
114 .B setstripe [--count|-c stripe_cnt] [--size|-s stripe_size]
115         \fB[--index|-i|--offset|-o start_ost_index] [--pool <pool>]
116         \fB<dirname|filename>\fR
117 .br
118 To create a new file, or set the directory default, with the specified striping parameters.  The
119 .I stripe_count
120 is the number of OSTs to stripe a file over. A
121 .I stripe_count
122 of 0 means to use the filesystem-wide default stripe count (default 1), and a
123 .I stripe_count
124 of -1 means to stripe over all available OSTs.  The
125 .I stripe_size
126 is the number of bytes to store on each OST before moving to the next OST.  A
127 .I stripe_size
128 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
129 .I start_ost_index
130 is the OST index (starting at 0) on which to start striping for this file.  A
131 .I start_ost_index
132 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
133 .I pool
134 is the name of a predefined pool of OSTs (see 
135 .B lctl
136 ) that will be used for striping. The 
137 .I stripe_count, stripe_size, and start_ost_index
138 will be used as well; the 
139 .I start_ost_index
140 must be part of the pool or an error will be returned. 
141 .TP
142 .B setstripe -d
143 Delete the default striping on the specified directory.
144 .TP
145 .B poollist <filesystem>[.<pool>] | <pathname>
146 List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
147 .TP
148 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
149 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name or an ID 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. -q disables printing of additional descriptions (including column titles).
150 .TP
151 .B quota -t <-u|-g> <filesystem>
152 To display block and inode grace times for user (-u) or group (-g) quotas
153 .TP
154 .B quotachown
155 To change files' owner and group on OSTs of the specified filesystem
156 .TP
157 .B quotacheck [-ugf] <filesystem>
158 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)
159 .TP
160 .B quotaon [-ugf] <filesystem>
161 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
162 .TP
163 .B quotaoff [-ugf] <filesystem>
164 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
165 .TP
166 .B quotainv [-ug] [-f] <filesystem>
167 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.
168 .TP
169 .B setquota  <-u|-g> <uname>|<uid>|<gname>|<gid> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
170 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
171 .TP
172 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
173 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
174 .TP
175 .B help 
176 Provides brief help on the various arguments
177 .TP
178 .B exit/quit 
179 Quit the interactive lfs session
181 .TP
182 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
183 This creates a file striped on two OSTs with 128kB on each stripe.
184 .TP
185 .B $ lfs setstripe -d /mnt/lustre/dir
186 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
187 .TP
188 .B $ lfs getstripe -v /mnt/lustre/file1
189 Lists the detailed object allocation of a given file
190 .TP
191 .B $ lfs find /mnt/lustre
192 Efficiently lists all files in a given directory and its subdirectories
193 .TP
194 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
195 Recursively list all regular files in given directory more than 30 days old
196 .TP
197 .B $ lfs find --obd OST2-UUID /mnt/lustre/
198 Recursively list all files in a given directory that have objects on OST2-UUID.
199 .tP
200 .B $ lfs check servers 
201 Check the status of all servers (MDT, OST)
202 .TP
203 .B $ lfs osts
204 List all the OSTs
205 .TP
206 .B $ lfs df -h 
207 Lists space usage per OST and MDT in human readable format.
208 .TP
209 .B $ lfs df -i 
210 Lists inode usage per OST and MDT
211 .TP
212 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
213 List space or inode usage for a specific OST pool
214 .TP
215 .B $ lfs quota -u bob /mnt/lustre
216 List quotas of user `bob'
217 .TP
218 .B $ lfs quota -t -u /mnt/lustre
219 Show grace times for user quotas on /mnt/lustre
220 .TP
221 .B $ lfs quotachown -i /mnt/lustre
222 Change file owner and group
223 .TP
224 .B $ lfs quotacheck -ug /mnt/lustre
225 Quotacheck for user and group - will turn on quotas after making the check.
226 .TP
227 .B $ lfs quotaon -ug /mnt/lustre
228 Turn quotas of user and group on
229 .TP
230 .B $ lfs quotaoff -ug /mnt/lustre
231 Turn quotas of user and group off
232 .TP
233 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
234 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
235 .TP
236 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
237 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
238 .SH BUGS
239 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
240 Report bugs using http://bugzilla.lustre.org.
242 The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
244 .BR lctl (8),
245 .BR lustre (7)