-.TH lfs 1 "2009 Jan 29" Lustre "user utilities"
+.TH lfs 1 "2017 Jan 12" Lustre "user utilities"
.SH NAME
lfs \- Lustre utility to create a file with specific striping pattern, find the striping pattern of existing files, do certain quota operations, and manage distributed namespace options for directories
.SH SYNOPSIS
.br
.B lfs data_version [-n] \fB<filename>\fR
.br
-.B lfs df [-i] [-h] [--lazy] [--pool|-p <fsname>[.<pool>] [path]
+.B lfs df [-ihlv] [--pool|-p <fsname>[.<pool>]] [path]
.br
.B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
.br
\fB[[!] --stripe-index|-i <index,...>]
\fB[[!] --stripe-size|-S [+-]N[kMG]]
\fB[[!] --layout|-L raid0,released]
+ \fB[[!] --component-count [+-]comp_cnt]
+ \fB[[!] --component-start [+-]N[kMGTPE]]
+ \fB[[!] --component-end|-E [+-]N[kMGTPE]]
+ \fB[[!] --component-flags <comp_flags>]
\fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
- \fB[[!] --uid|-u|--user|-U
<uname>|<uid>] [[!] --pool <pool>]\fR
+ \fB[[!] --uid|-u|--user|-U
|--projid <uname>|<uid>|<projid>] [[!] --pool <pool>]\fR
.br
.B lfs getname [-h]|[path ...]
.br
-.B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
- \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M]
- \fB[--stripe-size|-S] [--directory|-d]
- \fB[--layout|-L]
- \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
+.B lfs getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
+ [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
+ [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
+ [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
+ [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
+ [\fB--generation\fR|\fB-g\fR]
+ [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
+ [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
+ [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
+ [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
+ [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
+ <\fIdirname\fR|\fIfilename\fR> ...
.br
.B lfs migrate \fB-m <mdt_index>\fR
.IR directory
[\fB-n | --non-block\fR]
.IR file|directory
.br
+.B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR]
+ <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR]
+ \fB...\fR
+.IR filename
+.br
.B lfs mkdir [\fB-c | --count <stripe_count>\fR]
[\fB-i | --index <mdt_idx>\fR]
[\fB-h | --hash-type <hash_name>\fR]
.br
.B lfs pool_list <filesystem>[.<pool>] | <pathname>
.br
-.B lfs quota [-q] [-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>] [-p <projid>] <filesystem>
.br
-.B lfs quota -t <-u|-g> <filesystem>
+.B lfs quota -t <-u|-g|-p> <filesystem>
.br
.B lfs quotacheck [-ug] <filesystem>
.br
.br
.B lfs quotaoff [-ug] <filesystem>
.br
-.B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
+.B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
\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> <uname|uid|gname|gid>
+.B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
\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|-p>
\fB[--block-grace <block-grace>]\fR
\fB[--inode-grace <inode-grace>]\fR
\fB<filesystem>\fR
.br
-.B lfs setquota -t <-u|-g>
+.B lfs setquota -t <-u|-g|-p>
\fB[-b <block-grace>] [-i <inode-grace>]\fR
\fB<filesystem>\fR
.br
.br
.B lfs setstripe -d <dir>
.br
+.B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS]
+ \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
+.br
+.B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS]
+ \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
+.br
+.B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> <filename>
+.br
.B lfs --version
.br
+.B lfs --list-commands
+.br
.B lfs help
.SH DESCRIPTION
.B lfs
.B check
Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
.TP
-.B df [-i] [-h] [--lazy] [--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.
-The \fB--lazy\fR/\fB-l\fR option skips any OST that is currently disconnected
-from the client. This avoids blocking the \fBdf\fR output if an OST is down,
-and only returns the space on the OSTs that can currently be accessed.
+.B df
+See
+.BR lfs-df (1)
+for details of
+.B lfs df
+usage.
.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), \fB--layout\fR (file has a raid0 layout or is released). 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.
+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),\fB--projid\fR (file has specific numeric project ID), \fB--layout\fR (file has a raid0 layout or is released). 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 'more than n', while \fB-\fR before a numeric value means 'less than n'.
.TP
.B getname [-h]|[path ...]
Report all the Lustre mount points and the corresponding Lustre filesystem
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[--layout | -L]
- \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
+.B getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
+ [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
+ [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
+ [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
+ [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
+ [\fB--generation\fR|\fB-g\fR]
+ [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
+ [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
+ [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
+ [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
+ [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
+ <\fIdirname\fR|\fIfilename\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
.BR --index ,
.BR --offset ,
.BR --layout ,
+.BR --fid ,
+.BR --generation ,
+.BR --component-id ,
+.BR --component-flags ,
+.BR --component-count ,
+.BR --component-start ,
+.BR --component-end ,
or
.B --pool
can be used to return only the specific fields.
.RB ' "ls -d" ').
You can limit the returned files to those with objects on a specific OST with
.BR --obd .
-.TP
-.B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
- \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
- \fB[--ost-index|-o <ost_indices>] <dirname|filename>\fR
-.br
-To create a new file, or set the directory default, with the specified striping
-parameters. The
-.I stripe_count
-is the number of OSTs to stripe a file over. A
-.I stripe_count
-of 0 means to use the filesystem-wide default stripe count (default 1), and a
-.I stripe_count
-of -1 means to stripe over all available OSTs. The
-.I stripe_size
-is the number of bytes to store on each OST before moving to the next OST. A
-.I stripe_size
-of 0 means to use the filesystem-wide default stripe_size (default 1MB). The
-.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
-.B -o
-option is used to specify the exact stripe layout on the file system.
-.I ost_indices
-is a list of OSTs referenced by their indices, which are specified in decimal
-or hex form and can be obtained using the
-.B lfs osts
-command. The list format consists of individual OST indices and index ranges
-separated by commas, e.g. 1,2-4,7. The
-.B -o
-option may be specified multiple times to stripe across the union of all listed
-OSTs. If the
-.B -c
-option is combined with
-.B -o
-the
-.I stripe_count
-must agree with the number of OSTs in
-.IR ost_indices .
-If the
-.B -i
-option is combined with
-.B -o
-the
-.I start_ost_index
-must be in the OST list, and it will be used as the index on which to start
-striping the file. Otherwise the striping will occur in the order specified in
-.IR ost_indices .
-The
-.I poolname
-is the name of a predefined pool of OSTs (see
-.BR lctl (8))
-that will be used for striping. The
-.IR stripe_count ,
-.IR stripe_size ,
-and
-.I start_ost_index
-will be used as well; the
-.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.
+To show only the FID use
+.BR --fid .
+The layout generation can be printed with the
+.B --generation
+option.
+You can limit the displayed content by specifing argument for
+.B --component-id|-I
+.B --component-flags
+.B --component-start
+.B --component-end|-E
+options. For example, "--component-id=2" or "-I2" will only display the layout
+attributes for the component with id equal to 2.
.TP
.B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
or the OSTs in
.IR filesystem.pool .
.TP
-.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).
+.B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <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 user group and project are omitted quotas for current uid/gid/projid 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 quota -t <-u|-g|-p> <filesystem>
+To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
.TP
.B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
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.
.B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
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>=""
.TP
-.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
+.B setquota <-u|-g|-p> <uname>|<uid>|<gname>|<gid>|<projid> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
+To set filesystem quotas for users, groups or project. 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>
-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
+.B setquota -t [-u|-g|-p] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
+To set filesystem quota grace times for users,groups or project. Grace time is specified in "XXwXXdXXhXXmXXs" format or as an integer seconds value, see EXAMPLES
.TP
.B swap_layouts <filename1> <filename2>
Swap the data (layout and OST objects) of two regular files. The
.B migrate
See lfs-migrate(1).
.TP
+.B setstripe
+See lfs-setstripe(1).
+.TP
.B --version
Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
.TP
+.B --list-commands
+Output a list of the commands supported by the lfs utility
+.TP
.B help
Provides brief help on the various arguments
.TP
Quit the interactive lfs session
.SH EXAMPLES
.TP
-.B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
-This creates a file striped on two OSTs with 128kB on each stripe.
-.TP
-.B $ lfs setstripe -d /mnt/lustre/dir
-This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
-.TP
.B $ lfs getstripe -v /mnt/lustre/file1
Lists the detailed object allocation of a given file
.TP
+.B $ lfs getstripe -v -I2 /mnt/lustre/file1
+Lists the detailed information of the component 2 in a given file
+.TP
+.B $ lfs getstripe --component-flags=^init -I /mnt/lustre/file1
+Print only the component IDs for all the uninstantiated components
+.TP
+.B $ lfs getstripe -E-64M /mnt/lustre/file1
+Lists the information of the components in a file which has less than 64M extent end
+.TP
+.B $ lfs getstripe -I3 --component-start /mnt/lustre/file1
+Print only the component start for the component with ID of 3
+.TP
.B $ lfs find /mnt/lustre
Efficiently lists all files in a given directory and its subdirectories
.TP
.TP
.B $ lfs find --obd OST2-UUID /mnt/lustre/
Recursively list all files in a given directory that have objects on OST2-UUID.
-.tP
+.TP
+.B $ lfs find --component-count +3 /mnt/lustre
+Recursively list all files that have more than 3 components.
+.TP
.B $ lfs check servers
Check the status of all servers (MDT, OST)
.TP
.B $ lfs mdts
List all the MDTs
.TP
-.B $ lfs df -h
-Lists space usage per OST and MDT in human readable format.
-.TP
-.B $ lfs df -i
-Lists inode usage per OST and MDT
-.TP
-.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
List quotas of user `bob'
.TP
.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
+.SH NOTES
+The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR,
+\fBlfs getdirstripe\fR, \fBlfs mkdir\fR and \fBlfs project\fR are explained in separate
+man pages.
.SH BUGS
The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
.SH AUTHOR
The lfs command is part of the Lustre filesystem.
.SH SEE ALSO
-.BR lfs-hsm (1),
-.BR lfs-setdirstripe (1),
+.BR lctl (8),
+.BR lfs-df (1),
.BR lfs-getdirstripe (1),
+.BR lfs-hsm (1),
.BR lfs-mkdir (1),
-.BR lfs_migrate (1),
.BR lfs-migrate (1),
-.BR lctl (8),
+.BR lfs-project (1),
+.BR lfs-setdirstripe (1),
+.BR lfs-setquota (1),
+.BR lfs-setstripe (1),
.BR lustre (7)
git://git.whamcloud.com / fs / lustre-release.git / blobdiff