X-Git-Url: https://git.whamcloud.com/?a=blobdiff_plain;ds=sidebyside;f=lustre%2Fdoc%2Flfs.1;h=ffad3287f7fececa3e402039634db8e3e4e09feb;hb=0652c828c93f266b9999883b1b2967bfaac11c89;hp=27c46572e84b8c33db9c091a40b6e90520bbc1a5;hpb=f50cc4ec013bf0e9777e3ba833c359c921c1fa4f;p=fs%2Flustre-release.git diff --git a/lustre/doc/lfs.1 b/lustre/doc/lfs.1 index 27c4657..ffad328 100644 --- a/lustre/doc/lfs.1 +++ b/lustre/doc/lfs.1 @@ -1,70 +1,96 @@ -.TH lfs 1 "2017 Jan 12" Lustre "user utilities" +.TH lfs 1 "2018-01-24" 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 +lfs \- client utility for Lustre-specific file layout and other attributes .SH SYNOPSIS .br -.B lfs -.br .B lfs changelog [--follow] [startrec [endrec]] .br .B lfs changelog_clear .br -.B lfs check +.B lfs check .br -.B lfs data_version [-n] \fB\fR +.B lfs data_version [-nrw] \fB\fR .br .B lfs df [-ihlv] [--pool|-p [.]] [path] .br .B lfs fid2path [--link ] ... .br -.B lfs find - \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N] - \fB[--maxdepth|-D N] [[!] --mdt|-m ] [--name|-n pattern] - \fB[[!] --ost|-O ] [--print|-p] [--print0|-P] - \fB[[!] --size|-s [-+]N[kMGTPE]] - \fB[[!] --stripe-count|-c [+-]] - \fB[[!] --stripe-index|-i ] - \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 ] - \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G |] - \fB[[!] --uid|-u|--user|-U |] [[!] --pool ]\fR +.B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...> + [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn\fR] +[[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn\fR] + [[\fB!\fR] \fB--component-count|\fB--comp-count\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--component-flags|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>] + [[\fB!\fR] \fB--component-end|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] + [[\fB!\fR] \fB--component-start|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]] + [[\fB!\fR] \fB--mirror-count|\fB-N\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--mirror-state\fR <[^]\fIstate\fR>] + [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>] + [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR] +[\fB--maxdepth\fR|\fB-D\fI n\fR] + [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR <\fIuuid\fR|\fIindex\fR,...>] + [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR] +[[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fI\fR] + [[\fB!\fR] \fB--name\fR|\fB-n \fI\fR] +[[\fB!\fR] \fB--ost\fR|\fB-O\fR <\fIuuid\fR|\fIindex\fR,...>] + [[\fB!\fR] \fB--pool\fR <\fIpool\fR>] +[\fB--print\fR|\fB-P\fR] [\fB--print0\fR|\fB-0\fR] + [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>] +[[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]] + [[\fB!\fR] \fB--stripe-count|\fB-c\fR [\fB+-\fR]\fIn\fR] + [[\fB!\fR] \fB--stripe-index|\fB-i\fR \fIn\fR,...] + [[\fB!\fR] \fB--stripe-size|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]] +[[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}] + [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U +<\fIuname\fR>|<\fIuid>\fR] .br .B lfs getname [-h]|[path ...] .br -.B lfs getstripe [--obd|-O ] [--quiet|-q] [--verbose|-v] - \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M] [--fid|-F] - \fB[--stripe-size|-S] [--directory|-d] [--layout|-L] [--generation|-g] - \fB[--component-id|-I [comp_id]] [--component-flags [comp_flags]] - \fB[--component-count] [--component-start [+-][N][kMGTPE]] - \fB[--component-end|-E [+-][N][kMGTPE]] - \fB[--pool|-p] [--recursive|-r] [--raw|-R] ...\fR -.br -.B lfs migrate \fB-m \fR +.B lfs getstripe +[\fB--component-count\fR|\fB--comp-count\fR] + [\fB--component-end\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]] + [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]] + [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[<\fIcomp_id\fR>]] + [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[kMGTPE]]] + [\fB--directory\fR|\fB-d\fR] +[\fB--fid\fR|\fB-F\fR] +[\fB--generation\fR|\fB-g\fR] + [\fB--layout\fR|\fB-L\fR] +[\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR] +[\fB--ost\fR|\fB-O\fR <\fIuuid\fR>] + [\fB--pool\fR|\fB-p\fR] +[\fB--quiet\fR|\fB-q\fR] +[\fB--recursive\fR|\fB-r\fR] + [\fB--raw\fR|\fB-R\fR] +[\fB--stripe-count\fR|\fB-c\fR] +[\fB--stripe-index\fR|\fB-i\fR] + [\fB--stripe-size\fR|\fB-S\fR] +[\fB--verbose\fR|\fB-v\fR] +[\fB--yaml\fR|\fB-y\fR] + <\fIdirname\fR|\fIfilename\fR> ... +.br +.B lfs migrate { --mdt-index | -m } \fI\fR .IR directory .br .B lfs migrate [\fB-c | --stripe-count \fR] - [\fB-i | --stripe-index \fR] - [\fB-S | --stripe-size \fR] - [\fB-p | --pool \fR] - [\fB-o | --ost-list \fR] - [\fB-b | --block\fR] - [\fB-n | --non-block\fR] + [\fB-i | --stripe-index \fR] + [\fB-S | --stripe-size \fR] + [\fB-p | --pool \fR] + [\fB-o | --ost-list \fR] + [\fB-b | --block\fR] + [\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 + <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR] + \fB...\fR .IR filename .br .B lfs mkdir [\fB-c | --count \fR] - [\fB-i | --index \fR] - [\fB-h | --hash-type \fR] - [\fB-m | --mode \fR] - [\fB-D | --default\fR] + [\fB-i | --index \fR] + [\fB-h | --hash-type \fR] + [\fB-m | --mode \fR] + [\fB-D | --default\fR] .IR directory .br .B lfs osts @@ -77,50 +103,34 @@ lfs \- Lustre utility to create a file with specific striping pattern, find the .br .B lfs pool_list [.] | .br -.B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u | -u |-g | -g ] +.B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u | -u |-g | -g ] [-p ] .br -.B lfs quota -t <-u|-g> +.B lfs quota -t <-u|-g|-p> .br .B lfs quotacheck [-ug] .br +.B lfs quota <-U|-G|-P> +.br .B lfs quotaon [-ugf] .br .B lfs quotaoff [-ug] .br -.B lfs setquota <-u|--user|-g|--group> - \fB[--block-softlimit ] - \fB[--block-hardlimit ] - \fB[--inode-softlimit ] - \fB[--inode-hardlimit ] - \fB\fR -.br -.B lfs setquota <-u|--user|-g|--group> - \fB[-b ] [-B ] - \fB[-i ] [-I ] - \fB\fR -.br -.B lfs setquota -t <-u|-g> - \fB[--block-grace ]\fR - \fB[--inode-grace ]\fR - \fB\fR -.br -.B lfs setquota -t <-u|-g> - \fB[-b ] [-i ]\fR - \fB\fR -.br -.B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count] - \fB[--stripe-index|-i start_ost_index] [--pool|-p ] +.B lfs setstripe [--stripe-size|-S ] [--stripe-count|-c ] + \fB[--stripe-index|-i ] [--pool|-p ] \fB[--ost-list|-o ] \fR .br .B lfs setstripe -d .br -.B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS] - \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... \fR +.B lfs setstripe --component-end|-E [STRIPE_OPTIONS] + [\fB--component-end|-E [STRIPE_OPTIONS]] ... \fR +.br +.B lfs setstripe --component-add --component-end|-E [STRIPE_OPTIONS] + \fB<--component-end|-E > [STRIPE_OPTIONS]] ... \fR .br -.B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS] - \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... \fR +.B lfs setstripe --component-del {--component-id|-I id | + \fB--component-flags } .br -.B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> +.B lfs setstripe --yaml= .br .B lfs --version .br @@ -145,18 +155,28 @@ interest to a particular consumer , potentially allowing the MDT to free up disk space. An 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 -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. +.B check +Display the status of the MGTs, MDTs or OSTs (as specified in the command) or +all the servers (MGTs, MDTs and OSTs). +.TP +.B data_version [-nrw] +Display the current version of file data. If -n is specified, the data version +is read without taking a lock. As a consequence, the data version could be +outdated if there are dirty caches on filesystem clients, but this option will +not force data flushes and has less of an impact on the filesystem. If -r is +specified, the data version is read after dirty pages on clients are flushed. If +-w is specified, the data version is read after all caching pages on clients are +flushed. + +Even with -r or -w, race conditions are possible and the data version should be +checked before and after an operation to be confident the data did not change +during it. + +The data version is the sum of the last committed transaction numbers of all +data objects of a file. It is used by HSM policy engines for verifying that file +data has not been changed during an archive operation or before a release +operation, and by OST migration, primarily for verifying that file data has not +been changed during a data copy, when done in non-blocking mode. .TP .B getname [-h]|[path ...] Report all the Lustre mount points and the corresponding Lustre filesystem @@ -170,72 +190,6 @@ 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 ] [--quiet|-q] [--verbose|-v] - \fB[--count | -c ] [--index | -i | --offset | -o ] - \fB[--pool | -p ] [--size | -s ] [--directory | -d ] - \fB[--layout | -L ] [--fid | -F ] [--generation | -g ] - \fB[--component-id|-I [comp_id]] - \fB[--component-flags [comp_flags]] - \fB[--component-count] [--component-start [+-][N][kMGTPE]] - \fB[--component-end|-E [+-][N][kMGTPE]] - \fB[--recursive | -r ] [--raw | -R ] \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 , -.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. -.br -If the -.B --raw -option is specified, the stripe information is printed without substituting the -filesystem's default values for unspecified fields. If the striping EA is not -set, 0, 0, and -1 will be printed for the stripe count, size, and offset -respectively. -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 . -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 -.B --component-flags -.B --component-start -.B --component-end -options. For example, "--component-id 1" will only display the information -for component 1. -.TP .B fid2path [--link ] ... Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem mounted at \fBrootpath\fR or named \fBfsname\fR. If a file has multiple @@ -260,11 +214,11 @@ or or the OSTs in .IR filesystem.pool . .TP -.B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g |||] -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 ||||] +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> -To display block and inode grace times for user (-u) or group (-g) quotas +.B quota -t <-u|-g|-p> +To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas .TP .B quotacheck [-ugf] (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. @@ -275,12 +229,6 @@ To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) a .B quotaoff [-ugf] (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.="" .TP -.B setquota <-u|-g> ||| [--block-softlimit ] [--block-hardlimit ] [--inode-softlimit ] [--inode-hardlimit ] -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 ] [--inode-grace ] -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 swap_layouts Swap the data (layout and OST objects) of two regular files. The two files have to be in the same filesystem, owned by the same user, @@ -288,16 +236,6 @@ reside on the same MDT and writable by the user. Swapping the layout of two directories is not permitted. .TP -.B data_version [-n] -Display current version of file data. If -n is specified, data version is read -without taking lock. As a consequence, data version could be outdated if there -is dirty caches on filesystem clients, but this will not force data flushes and -has less impact on filesystem. - -Even without -n, race conditions are possible and data version should be -checked before and after an operation to be confident the data did not change -during it. -.TP .B mkdir lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE: .B lfs setdirstripe @@ -328,29 +266,8 @@ Provides brief help on the various arguments Quit the interactive lfs session .SH EXAMPLES .TP -.B $ lfs getstripe -v /mnt/lustre/file1 -Lists the detailed object allocation of a given file -.TP -.B $ lfs getstripe -v --component-id 2 /mnt/lustre/file1 -Lists the detailed information of the component 2 in a given file -.TP -.B $ lfs getstripe -E -64M /mnt/lustre/file1 -Lists the information of the components in a file which has at least 64M extent end -.TP -.B $ lfs find /mnt/lustre -Efficiently lists all files in a given directory and its subdirectories -.TP -.B $ lfs find /mnt/lustre -mtime +30 -type f -print -Recursively list all regular files in given directory more than 30 days old -.TP -.B $ lfs find --obd OST2-UUID /mnt/lustre/ -Recursively list all files in a given directory that have objects on OST2-UUID. -.TP -.B $ lfs find --component-count +3 /mnt/lustre -Recursively list all files that have at most 3 components. -.TP -.B $ lfs check servers -Check the status of all servers (MDT, OST) +.B $ lfs check all +Check the status of all servers (MGT, MDT, OST) .TP .B $ lfs osts List all the OSTs @@ -361,6 +278,9 @@ List all the MDTs .B $ lfs quota -u bob /mnt/lustre List quotas of user `bob' .TP +.B $ lfs quota -U /mnt/lustre +List user quotas of system default setting +.TP .B $ lfs quota -t -u /mnt/lustre Show grace times for user quotas on /mnt/lustre .TP @@ -375,27 +295,25 @@ Turn quotas of user and group on .TP .B $ lfs quotaoff -ug /mnt/lustre Turn quotas of user and group off -.TP -.B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre -Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit -.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 .SH NOTES -The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR, -\fBlfs getdirstripe\fR and \fBlfs mkdir\fR are explained in separated man pages. -.SH BUGS -The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1). +The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR, +\fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR, +\fBlfs setdirstripe\fR, \fBlfs mkdir\fR, and \fBlfs project\fR are explained +in separate man pages. .SH AUTHOR The lfs command is part of the Lustre filesystem. .SH SEE ALSO +.BR lctl (8), .BR lfs-df (1), -.BR lfs-hsm (1), -.BR lfs-setdirstripe (1), +.BR lfs-find (1), +.BR lfs-getstripe (1), .BR lfs-getdirstripe (1), +.BR lfs-hsm (1), .BR lfs-mkdir (1), +.BR lfs-migrate (1), .BR lfs_migrate (1), +.BR lfs-project (1), +.BR lfs-setdirstripe (1), +.BR lfs-setquota (1), .BR lfs-setstripe (1), -.BR lfs-migrate (1), -.BR lctl (8), .BR lustre (7)