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
8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
10 .B lfs changelog_clear <mdtname> <id> <endrec>
12 .B lfs check <mds|osts|servers>
14 .B lfs df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
16 .B lfs find <directory|filename>
17 \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N]
18 \fB[--maxdepth|-D N] [[!] --mdt|-m <uuid|index,...>] [--name|-n pattern]
19 \fB[[!] --ost|-O <uuid|index,...>] [--print|-p] [--print0|-P]
20 \fB[[!] --size|-s [-+]N[kMGTPE]]
21 \fB[[!] --stripe-count|-c [+-]<stripes>]
22 \fB[[!] --stripe-index|-i <index,...>]
23 \fB[[!] --stripe-size|-S [+-]N[kMG]]
24 \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
25 \fB[[!] --uid|-u|--user|-U <uname>|<uid>] [[!] --pool <pool>]\fR
27 .B lfs getname [-h]|[path ...]
29 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
30 \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M]
31 \fB[--stripe-size|-S] [--directory|-d]
32 \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
34 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
35 \fB[--stripe-index|-i start_ost_index ] [--pool|-p <poolname>]
36 \fB<directory|filename>\fR
38 .B lfs setstripe -d <dir>
43 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
45 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
47 .B lfs quota -t <-u|-g> <filesystem>
49 .B lfs quotacheck [-ug] <filesystem>
51 .B lfs quotaon [-ugf] <filesystem>
53 .B lfs quotaoff [-ug] <filesystem>
55 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
56 \fB[--block-softlimit <block-softlimit>]
57 \fB[--block-hardlimit <block-hardlimit>]
58 \fB[--inode-softlimit <inode-softlimit>]
59 \fB[--inode-hardlimit <inode-hardlimit>]
62 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
63 \fB[-b <block-softlimit>] [-B <block-hardlimit>]
64 \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
67 .B lfs setquota -t <-u|-g>
68 \fB[--block-grace <block-grace>]
69 \fB[--inode-grace <inode-grace>]
72 .B lfs setquota -t <-u|-g>
73 \fB[-b <block-grace>] [-i <inode-grace>]
76 .B lfs data_version [-n] \fB<filename>\fR
81 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.
83 The various options supported by lctl are listed and explained below:
86 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.
89 Indicate that changelog records previous to <endrec> are no longer of
90 interest to a particular consumer <id>, potentially allowing the MDT to
91 free up disk space. An <endrec> of 0 indicates the current last record.
92 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
95 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
97 .B df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
98 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
99 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR. By default
100 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
101 specified print only the usage of that filesystem. If \fB-h\fR is given, the
102 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
103 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
106 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.
108 .B getname [-h]|[path ...]
109 Report all the Lustre mount points and the corresponding Lustre filesystem
110 instance. If one or more \fBpath\fR entries are provided, then only the
111 Lustre instance for these mount points is returned. If the path given is not on
112 a Lustre instance 'No such device' is reported.
116 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
117 that is located on a lustre mounted file system then only the OSTs belonging
118 to that filesystem are displayed.
120 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
121 \fB[--count | -c ] [--index | -i | --offset | -o ]
122 \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
123 \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
125 List the striping information for a given filename or directory tree.
126 By default the stripe count, size, and offset will be returned. If you
127 only want specific striping information then the options of
134 can be used to return only the specific fields.
138 option is specified, the stripe information is printed without substituting the
139 filesystem's default values for unspecified fields. If the striping EA is not
140 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
142 In the case where you only want details about the files' object id
145 option is used. Additional information available about striping can be
148 The default behavior when a directory is specified is to list the striping
149 information for all files within the specified directory (like
151 This can be expanded with
153 which will recurse into all subdirectories.
154 If you wish to get striping information for only the specified directory, then
156 can be used to limit the information, like
158 You can limit the returned files to those with objects on a specific OST with
161 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
162 \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
163 \fB<dirname|filename>\fR
165 To create a new file, or set the directory default, with the specified striping parameters. The
167 is the number of OSTs to stripe a file over. A
169 of 0 means to use the filesystem-wide default stripe count (default 1), and a
171 of -1 means to stripe over all available OSTs. The
173 is the number of bytes to store on each OST before moving to the next OST. A
175 of 0 means to use the filesystem-wide default stripe_size (default 1MB). The
177 is the OST index (starting at 0) on which to start striping for this file. A
179 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
181 is the name of a predefined pool of OSTs (see
183 ) that will be used for striping. The
188 will be used as well; the
190 must be part of the pool or an error will be returned.
193 Delete the default striping on the specified directory.
196 .RI { filesystem }[ .poolname "] | {" pathname }
202 .IR filesystem.pool .
204 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
205 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).
207 .B quota -t <-u|-g> <filesystem>
208 To display block and inode grace times for user (-u) or group (-g) quotas
210 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
211 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). Not useful anymore with servers >= 2.4.0 since space accounting is always turned on.
213 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
214 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement must be enabled via conf_param (e.g. lctl conf_param ${FSNAME}.quota.<ost|mdt>=<u|g|ug>)
216 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
217 To turn filesystem quotas off. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement can be turned off (for inode or block) by running the following command on the MGS: lctl conf_param ${FSNAME}.quota.<ost|mdt>=""
219 .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>
220 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
222 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
223 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
225 .B data_version [-n] <filename>
226 Display current version of file data. If -n is specified, data version is read
227 without taking lock. As a consequence, data version could be outdated if there
228 is dirty caches on filesystem clients, but this will not force data flushes and
229 has less impact on filesystem.
231 Even without -n, race conditions are possible and data version should be
232 checked before and after an operation to be confident the data did not change
236 Provides brief help on the various arguments
239 Quit the interactive lfs session
242 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
243 This creates a file striped on two OSTs with 128kB on each stripe.
245 .B $ lfs setstripe -d /mnt/lustre/dir
246 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
248 .B $ lfs getstripe -v /mnt/lustre/file1
249 Lists the detailed object allocation of a given file
251 .B $ lfs find /mnt/lustre
252 Efficiently lists all files in a given directory and its subdirectories
254 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
255 Recursively list all regular files in given directory more than 30 days old
257 .B $ lfs find --obd OST2-UUID /mnt/lustre/
258 Recursively list all files in a given directory that have objects on OST2-UUID.
260 .B $ lfs check servers
261 Check the status of all servers (MDT, OST)
267 Lists space usage per OST and MDT in human readable format.
270 Lists inode usage per OST and MDT
272 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
273 List space or inode usage for a specific OST pool
275 .B $ lfs quota -u bob /mnt/lustre
276 List quotas of user `bob'
278 .B $ lfs quota -t -u /mnt/lustre
279 Show grace times for user quotas on /mnt/lustre
281 .B $ lfs quotachown -i /mnt/lustre
282 Change file owner and group
284 .B $ lfs quotacheck -ug /mnt/lustre
285 Quotacheck for user and group - will turn on quotas after making the check.
287 .B $ lfs quotaon -ug /mnt/lustre
288 Turn quotas of user and group on
290 .B $ lfs quotaoff -ug /mnt/lustre
291 Turn quotas of user and group off
293 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
294 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
296 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
297 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
299 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
300 Report bugs using http://bugzilla.lustre.org.
302 The lfs command is part of the Lustre filesystem. Contact http://www.lustre.org/