.TH lfs 1 "2009 Jan 29" Lustre "user utilities"
.SH NAME
-lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of exiting files
+lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of existing files
.SH SYNOPSIS
.br
.B lfs
.br
.B lfs find [[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N]
\fB[[!] --ctime|-C [-+]N] [--maxdepth|-D N] [--name|-n pattern]
- \fB[--print|-p] \fB[--print0|-P] [--obd|-O <uuid[s]>]
+ \fB[--print|-p] \fB[--print0|-P] [[!] --obd|-O <uuid[s]>]
\fB[[!] --size|-S [-+]N[kMGTPE]] [--type |-t {bcdflpsD}]
\fB[[!] --gid|-g|--group|-G <gname>|<gid>]
\fB[[!] --uid|-u|--user|-U <uname>|<uid>]
- \fB<dirname|filename>\fR
+ \fB<directory|filename>\fR
.br
.B lfs osts
+.RB [ path ]
.br
.B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
- \fB[--recursive|-r] <dirname|filename>\fR
+ \fB[--count | -c ] [--index | -i | --offset | -o ]
+ \fB[--size | -s ] [--pool | -p ] [--directory | -d ]
+ \fB[--recursive | -r] <directory|filename> ...\fR
.br
.B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
- \fB[--offset|-o start-ost] [--pool|-p <pool>]
- \fB<dir|filename>\fR
+ \fB[--index|-i|--offset|-o start_ost_index ] [--pool|-p <pool>]
+ \fB<directory|filename>\fR
.br
.B lfs setstripe -d <dir>
.br
.B lfs poollist <filesystem>[.<pool>] | <pathname>
.br
-.B lfs quota [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
+.B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
.br
.B lfs quota -t <-u|-g> <filesystem>
.br
.B check
Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
.TP
-.B df
-Report filesystem disk space usage or inodes usage of each MDT/OST. Can limit
-the scope to a specific OST pool
+.B df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
+Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
+MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR. By default
+print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
+specified print only the usage of that filesystem. If \fB-h\fR is given, the
+output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
+for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
.TP
.B find
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.
.TP
.B osts
-List all the OSTs for the filesystem
-.TP
-.B getstripe
-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).
-.TP
-.B setstripe [--size stripe-size] [--count stripe-cnt]
- \fB[--offset start-ost] [--pool <pool>]\fR
+.RB [ path ]
+List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
+that is located on a lustre mounted file system then only the OSTs belonging
+to that filesystem are displayed.
+.TP
+.B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
+ \fB[--count | -c ] [--index | -i | --offset | -o ]
+ \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
+ \fB[--recursive|-r] <dirname|filename>\fR
+.br
+List the striping information for a given filename or directory tree.
+By default the stripe count, size, and offset will be returned. If you
+only want specific striping information then the options of
+.BR --count ,
+.BR --size ,
+.BR --index ,
+.BR --offset ,
+or
+.B --pool
+can be used to return only the specific fields.
+.br
+In the case where you only want details about the files' object id
+information then the
+.B --quiet
+option is used. Additional information available about striping can be
+displayed with
+.BR --verbose .
+The default behavior when a directory is specified is to list the striping
+information for all files within the specified directory (like
+.RB ' "ls -l" ') .
+This can be expanded with
+.B --recursive
+which will recurse into all subdirectories.
+If you wish to get striping information for only the specified directory, then
+.B --directory
+can be used to limit the information, like
+.RB ' "ls -d" ').
+You can limit the returned files to those with objects on a specific OST with
+.BR --obd .
+.TP
+.B setstripe [--count|-c stripe_cnt] [--size|-s stripe_size]
+ \fB[--index|-i|--offset|-o start_ost_index] [--pool <pool>]
+ \fB<dirname|filename>\fR
.br
To create a new file, or set the directory default, with the specified striping parameters. The
-.I stripe-count
+.I stripe_count
is the number of OSTs to stripe a file over. A
-.I stripe-count
+.I stripe_count
of 0 means to use the filesystem-wide default stripe count (default 1), and a
-.I stripe-count
+.I stripe_count
of -1 means to stripe over all available OSTs. The
-.I stripe-size
+.I stripe_size
is the number of bytes to store on each OST before moving to the next OST. A
-.I stripe-size
+.I stripe_size
of 0 means to use the filesystem-wide default stripe size (default 1MB). The
-.I start-ost
-is the OST index (base 10, starting at 0) on which to start striping for this file. A
-.I start-ost
+.I start_ost_index
+is the OST index (starting at 0) on which to start striping for this file. A
+.I start_ost_index
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
-.I pool
+.I poolname
is the name of a predefined pool of OSTs (see
-.I lctl
+.B lctl
) that will be used for striping. The
-.I stripe-count, stripe-size, start-ost
+.IR stripe_count ,
+.IR stripe_size ,
+and
+.I start_ost_index
will be used as well; the
-.I start-ost
+.I start_ost_index
must be part of the pool or an error will be returned.
.TP
.B setstripe -d
Delete the default striping on the specified directory.
.TP
-.B poollist <filesystem>[.<pool>] | <pathname>
-List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
+.B poollist
+.RI { filesystem }[ .poolname "] | {" pathname }
+List the pools in
+.I filesystem
+or
+.IR pathname ,
+or the OSTs in
+.IR filesystem.pool .
.TP
-.B quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
-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.
+.B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
+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).
.TP
.B quota -t <-u|-g> <filesystem>
To display block and inode grace times for user (-u) or group (-g) quotas
.B $ lfs df -i
Lists inode usage per OST and MDT
.TP
-.B lfs df --pool <filesystem>[.<pool>] | <pathname>
+.B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
List space or inode usage for a specific OST pool
.TP
.B $ lfs quota -u bob /mnt/lustre