-.TH lfs 1 "2009 Jan 29" Lustre "user utilities"
+.TH lfs 1 "2008 Mar 15" 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 changelog [--follow] <mdtname> [startrec [endrec]]
-.br
-.B lfs changelog_clear <mdtname> <id> <endrec>
-.br
.B lfs check <mds|osts|servers>
.br
-.B lfs df [-i] [-h] [path]
+.B lfs df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
.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 N] [[!] --group|-G <name>]
- \fB[[!] --uid|-u N] [[!] --user|-U <name>]
- \fB<dirname|filename>\fR
+ \fB[[!] --gid|-g|--group|-G <gname>|<gid>]
+ \fB[[!] --uid|-u|--user|-U <uname>|<uid>]
+ \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] <dirname|filename> ...\fR
.br
.B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
- \fB[--offset|-o start-ost] [--pool|-p pool-name]
- \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|-g] <username|groupname> <filesystem>
-.br
-.B lfs quota <filesystem>
+.B lfs quota [-q] [-v] [-o obd_uuid] [<-u|-g> <uname>|<uid>|<gname><gid>] <filesystem>
.br
-.B lfs quota -t [-u|-g] <filesystem>
+.B lfs quota -t <-u|-g> <filesystem>
.br
.B lfs quotacheck [-ug] <filesystem>
.br
.br
.B lfs quotainv [-ug] [-f] <filesystem>
.br
-.B lfs setquota [-u|--user|-g|--group] <username|groupname>
+.B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
\fB[--block-softlimit <block-softlimit>]
\fB[--block-hardlimit <block-hardlimit>]
\fB[--inode-softlimit <inode-softlimit>]
\fB[--inode-hardlimit <inode-hardlimit>]
\fB<filesystem>\fR
.br
-.B lfs setquota [-u|--user|-g|--group] <username|groupname>
+.B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
\fB[-b <block-softlimit>] [-B <block-hardlimit>]
\fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
\fB<filesystem>\fR
.br
-.B lfs setquota -t [-u|-g]
+.B lfs setquota -t <-u|-g>
\fB[--block-grace <block-grace>]
\fB[--inode-grace <inode-grace>]
\fB<filesystem>\fR
.br
-.B lfs setquota -t [-u|-g]
+.B lfs setquota -t <-u|-g>
\fB[-b <block-grace>] [-i <inode-grace>]
\fB<filesystem>\fR
.br
.B lfs help
.SH DESCRIPTION
.B lfs
-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.
+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, find files with specific attributes, list OST information, or set quota limits. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported.
.SH OPTIONS
The various options supported by lctl are listed and explained below:
.TP
-.B changelog
-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.
-.TP
-.B changelog_clear
-Indicate that changelog records previous to <endrec> are no longer of
-interest to a particular consumer <id>, potentially allowing the MDT to
-free up disk space. An <endrec> of 0 indicates the current last record.
-Changelog consumers must be registered on the MDT node using \fBlctl\fR.
-.TP
.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.
+.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).
+.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 ] [--size | -s ] [--index | -i ]
+ \fB[--offset | -o ] [--pool | -p ] [--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 [--size stripe-size] [--count stripe-cnt]
- \fB[--offset start-ost] [--pool pool-name]\fR
+ \fB[--offset start-ost] [--pool <pool>] {directory|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-name
+.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
-.TP
-.B quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g] <username|groupname> <filesystem>
-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.
-.TP
-.B quota -t [-u|-g] <filesystem>
-To display block and inode grace times for user (-u) or group (-g) quotas
+.B poollist
+.RI { filesystem }[ .poolname "] | {" pathname }
+List the pools in
+.I filesystem
+or
+.IR pathname ,
+or the OSTs in
+.IR filesystem.pool .
.TP
.B quotachown
To change files' owner and group on OSTs of the specified filesystem
.B quotainv [-ug] [-f] <filesystem>
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.
.TP
-.B setquota [-u|-g] <name> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
+.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>
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
.TP
-.B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
+.B setquota -t <-u|-g> [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
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
.TP
+.B quota [-q] [-v] [-o obd_uuid] [ -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
+.TP
.B help
Provides brief help on the various arguments
.TP
.B $ lfs df -i
Lists inode usage per OST and MDT
.TP
-.B $ lfs quota -u bob /mnt/lustre
-List quotas of user `bob'
-.TP
-.B $ lfs quota -t -u /mnt/lustre
-Show grace times for user quotas on /mnt/lustre
+.B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
+List space or inode usage for a specific OST pool
.TP
.B $ lfs quotachown -i /mnt/lustre
Change file owner and group
.TP
.B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
+.TP
+.B $ lfs quota -u bob /mnt/lustre
+List quotas of user `bob'
+.TP
+.B $ lfs quota -t -u /mnt/lustre
+Show grace times for user quotas on /mnt/lustre
.SH BUGS
The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
Report bugs using http://bugzilla.lustre.org.
git://git.whamcloud.com / fs / lustre-release.git / blobdiff