lustre/doc/lfs.1

   1 .TH lfs 1 "2018-01-24" Lustre "user utilities"
   2 .SH NAME
   3 lfs \- client utility for Lustre-specific file layout and other attributes
   4 .SH SYNOPSIS
   5 .br
   6 .B lfs changelog \fR[\fB--follow\fR] <\fImdtname\fR> [\fIstartrec \fR[\fIendrec\fR]]
   7 .br
   8 .B lfs changelog_clear <\fImdtname\fR> <\fIid\fR> <\fIendrec\fR>
   9 .br
  10 .B lfs check \fR<\fBmgts\fR|\fBmdts\fR|\fBosts\fR|\fBall\fR>
  11 .br
  12 .B lfs data_version \fR[\fB-nrw\fR] \fB<\fIfilename\fR>
  13 .br
  14 .B lfs df \fR[\fB-ihlv\fR] [\fB--pool\fR|\fB-p \fR<\fIfsname\fR>[.<\fIpool\fR>]] [\fIpath\fR]
  15 .br
  16 .B lfs fid2path \fR[\fB--link \fR<\fIlinkno\fR>] <\fIfsname\fR|\fIrootpath\fR> <fid\fR> ...
  17 .br
  18 .B lfs find \fR<\fIdirectory\fR|\fIfilename \fR...>
  19       [[\fB!\fR] \fB--atime\fR|\fB-A\fR [\fB-+\fR]\fIn\fR]
  20 [[\fB!\fR] \fB--ctime\fR|\fB-C\fR [\fB+-\fR]\fIn\fR]
  21       [[\fB!\fR] \fB--mtime\fR|\fB-M\fR [\fB-+\fR]\fIn\fR]
  22       [[\fB!\fR] \fB--component-count\fR|\fB--comp-count\fR [\fB+-\fR]\fIn\fR]
  23       [[\fB!\fR] \fB--component-flags\fR|\fB--comp-flags\fR <[\fB^\fR]\fIflag\fB,\fR...>]
  24       [[\fB!\fR] \fB--component-end\fR|\fB--comp-end\fR|\fB-E\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  25       [[\fB!\fR] \fB--component-start\fR|\fB--comp-start\fR [\fB+-\fR]\fIn\fR[\fBKMGTPE\fR]]
  26       [[\fB!\fR] \fB--mirror-count\fR|\fB-N\fR [\fB+-\fR]\fIn\fR]
  27       [[\fB!\fR] \fB--mirror-state\fR <[^]\fIstate\fR>]
  28       [[\fB!\fR] \fB--gid\fR|\fB-g\fR|\fB--group\fR|\fB-G\fR <\fIgname\fR>|<\fIgid\fR>]
  29       [[\fB!\fR] \fB--layout\fR|\fB-L mdt\fR,\fBraid0\fR,\fBreleased\fR]
  30 [\fB--maxdepth\fR|\fB-D\fI n\fR]
  31       [[\fB!\fR] \fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR <\fIuuid\fR|\fIindex\fR,...>]
  32       [[\fB!\fR] \fB--mdt-count\fR|\fB-T\fR [\fB+-\fR]\fIn\fR]
  33 [[\fB!\fR] \fB--mdt-hash\fR|\fB-H \fI<hashtype>\fR]
  34       [[\fB!\fR] \fB--name\fR|\fB-n \fI<pattern>\fR]
  35 [[\fB!\fR] \fB--ost\fR|\fB-O\fR <\fIuuid\fR|\fIindex\fR,...>]
  36       [[\fB!\fR] \fB--pool\fR <\fIpool\fR>]
  37 [\fB--print\fR|\fB-P\fR] [\fB--print0\fR|\fB-0\fR]
  38       [[\fB!\fR] \fB--projid\fR |<\fIprojid\fR>]
  39 [[\fB!\fR] \fB--size|\fB-s\fR [\fB-+\fR]\fIn\fR[\fBKMGTPE\fR]]
  40       [[\fB!\fR] \fB--stripe-count\fR|\fB-c\fR [\fB+-\fR]\fIn\fR]
  41       [[\fB!\fR] \fB--stripe-index\fR|\fB-i\fR \fIn\fR,...]
  42       [[\fB!\fR] \fB--extension-size\fR|\fB-ext-size\fR|\fB-z\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
  43       [[\fB!\fR] \fB--stripe-size\fR|\fB-S\fR [\fB+-\fR]\fIn\fR[\fBKMG\fR]]
  44 [[\fB!\fR] \fB--type\fR|\fB-t\fR {\fBbcdflps\fR}]
  45       [[\fB!\fR] \fB--uid\fR|\fB-u\fR|\fB--user\fR|\fB-U
  46 \fR<\fIuname\fR>|<\fIuid\fR>]
  47 .br
  48 .B lfs flushctx
  49 .RB [ --help | -h "] [" -k "] [" -r "] [" \fIrootpath\fR "]"
  50 .br
  51 .B lfs getname
  52 .RB [ --help | -h "] [" --instance | -i "] [" --fsname | -n "] ["
  53 .IR path ...]
  54 .br
  55 .B lfs getstripe
  56 [\fB--component-count\fR|\fB--comp-count\fR]
  57         [\fB--component-end\fR|\fB-E\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]
  58         [\fB--component-flags\fR[=[\fB^\fR]\fIflag\fB,\fR...]]
  59         [\fB--component-id\fR|\fB-I \fR[=\fIcomp_id\fR]]
  60         [\fB--component-start\fR[=[\fB+-\fR]\fIN\fR[\fBKMGTPE\fR]]]
  61         [\fB--directory\fR|\fB-d\fR]
  62 [\fB--fid\fR|\fB-F\fR]
  63 [\fB--generation\fR|\fB-g\fR]
  64         [\fB--layout\fR|\fB-L\fR]
  65 [\fB--mdt\fR|\fB--mdt-index\fR|\fB-m\fR]
  66 [\fB--ost\fR|\fB-O\fR <\fIuuid\fR>]
  67         [\fB--pool\fR|\fB-p\fR]
  68 [\fB--quiet\fR|\fB-q\fR]
  69 [\fB--recursive\fR|\fB-r\fR]
  70         [\fB--raw\fR|\fB-R\fR]
  71 [\fB--stripe-count\fR|\fB-c\fR]
  72 [\fB--stripe-index\fR|\fB-i\fR]
  73         [\fB--stripe-size\fR|\fB-S\fR]
  74 [\fB--extension-size\fR|\fB--ext-size\fR|\fB-z\fR]
  75         [\fB--verbose\fR|\fB-v\fR]
  76 [\fB--yaml\fR|\fB-y\fR]
  77         <\fIdirname\fR|\fIfilename\fR> ...
  78 .br
  79 .B lfs migrate \fR{\fB--mdt-index\fR|\fB-m\fR} <\fImdt_index\fR> \fIdirectory\fR
  80 .br
  81 .B lfs migrate \fR[\fB--stripe-count\fR|\fB-c\fR \fR<\fIstripe_count\fR>]
  82             [\fB--stripe-index\fR|\fB-i\fR \fR<\fIstart_ost_idx\fR>]
  83             [\fB--stripe-size\fR|\fB-S\fR \fR<\fIstripe_size\fR>]
  84 [\fB--pool\fR|\fB-p\fR \fR<\fIpool_name\fR>]
  85             [\fB-o\fR|\fB--ost-list \fR<\fIost_indices\fR>]
  86 [\fB--block\fR|\fB-b\fR]
  87             [\fB--non-block\fR|\fB-n\fR] <\fIfile\fR|\fIdirectory\fR>
  88 .br
  89 .B lfs migrate \fR<\fB--component-end\fR|\fB-E\fR \fIcomp_end1\fR>
  90 [\fISTRIPE_OPTIONS\fR]
  91             <\fB--component-end\fR|\fB-E\fR \fIcomp_end2\fR>
  92 [\fISTRIPE_OPTIONS\fR]
  93             ... \fIfilename\fR
  94 .br
  95 .B lfs mkdir \fR[\fB-c\fR|\fB--count \fR<\fIstripe_count\fR>]
  96 [\fB-i\fR|\fB--index \fR<\fImdt_idx\fR>]
  97           [\fB-h\fR|\fB--hash-type \fR<\fIhash_name\fR>]
  98 [\fB-m\fR|\fB--mode \fR<\fImode\fR>]
  99           [\fB-D\fR|\fB--default\fR] \fIdirectory\fR
 100 .br
 101 .B lfs osts \fR[<\fIpath\fR>]
 102 .br
 103 .B lfs mdts \fR[<\fIpath\fR>]
 104 .br
 105 .B lfs path2fid \fR[\fB--parents\fR] <\fIpath\fR> ...
 106 .br
 107 .B lfs pool_list \fR<\fIfilesystem\fR>[\fB.\fR<\fIpool\fR>] | <\fIpathname\fR>
 108 .br
 109 .B lfs setstripe \fR[\fB--stripe-size\fR|\fB-S <\fIsize\fR>] [\fB--stripe-count\fR|-c <\fIcount\fR>]
 110         [\fB--stripe-index\fR|\fB-i <\fIstart_ost_index\fR>] [\fB--pool\fR|\fB-p \fR<\fIpoolname\fR>]
 111         [\fB--extension-size\fR|\fB--ext-size\fR|\fB-z <\fIext_size\fR>]
 112         [\fB--ost-list\fR|\fB-o <\fIost_indices\fR>] <\fIdirectory\fR|\fIfilename\fR>
 113 .br
 114 .B lfs setstripe -d \fR<\fIdir\fR>
 115 .br
 116 .B lfs setstripe --component-end\fR|\fB-E <\fIend1> [\fISTRIPE_OPTIONS\fR]
 117              [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
 118              ... <\fIfilename>\fR
 119 .br
 120 .B lfs setstripe --component-add \fB-E\fR <\fIend1> [\fISTRIPE_OPTIONS]
 121              [\fB--component-end\fR|\fB-E \fR<\fIend2\fR> [\fISTRIPE_OPTIONS\fR]]
 122              ... <\fIfilename\fR>
 123 .br
 124 .B lfs setstripe --component-del \fR{\fB--component-id\fR|\fB-I \fR<\fIid\fR> |
 125                                \fB--component-flags \fR<\fIflags\fR>}
 126 <\fIfilename\fR>
 127 .br
 128 .B lfs setstripe --yaml=\fR<\fIyaml_template_file\fR> <\fIfilename\fR>
 129 .br
 130 .B lfs --version
 131 .br
 132 .B lfs --list-commands
 133 .br
 134 .B lfs help
 135 .SH DESCRIPTION
 136 .B lfs
 137 can be used to create a new file with a specific striping pattern, determine
 138 the default striping pattern, gather the extended attributes (object numbers
 139 and location) for a specific file. It can be invoked interactively without any
 140 arguments or in a non-interactive mode with one of the arguments supported.
 141 .SH COMMANDS
 142 A number of sub-commands supported by lfs are listed below.  Other commands
 143 are described in separate man pages of the form
 144 .BI lfs- command
 145 as listed in the
 146 .B SEE ALSO
 147 section at the end.
 148 .TP
 149 .B changelog
 150 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.
 151 .TP
 152 .B changelog_clear
 153 Indicate that changelog records previous to <endrec> are no longer of
 154 interest to a particular consumer <id>, potentially allowing the MDT to
 155 free up disk space. An <endrec> of 0 indicates the current last record.
 156 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
 157 .TP
 158 .B check <mgts|mdts|osts|all>
 159 Display the status of the MGTs, MDTs or OSTs (as specified in the command) or
 160 all the servers (MGTs, MDTs and OSTs).
 161 .TP
 162 .B data_version [-nrw] <filename>
 163 Display the current version of file data. If -n is specified, the data version
 164 is read without taking a lock. As a consequence, the data version could be
 165 outdated if there are dirty caches on filesystem clients, but this option will
 166 not force data flushes and has less of an impact on the filesystem. If -r is
 167 specified, the data version is read after dirty pages on clients are flushed. If
 168 -w is specified, the data version is read after all caching pages on clients are
 169 flushed.
 170
 171 Even with -r or -w, race conditions are possible and the data version should be
 172 checked before and after an operation to be confident the data did not change
 173 during it.
 174
 175 The data version is the sum of the last committed transaction numbers of all
 176 data objects of a file. It is used by HSM policy engines for verifying that file
 177 data has not been changed during an archive operation or before a release
 178 operation, and by OST migration, primarily for verifying that file data has not
 179 been changed during a data copy, when done in non-blocking mode.
 180 .TP
 181 .B flushctx
 182 See lfs-flushctx(1).
 183 .TP
 184 .B osts
 185 .RB [ path ]
 186 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 187 that is located on a lustre mounted file system then only the OSTs belonging
 188 to that filesystem are displayed.
 189 .TP
 190 .B pool_list
 191 .RI { filesystem }[ .poolname "] | {" pathname }
 192 List the pools in
 193 .I filesystem
 194 or
 195 .IR pathname ,
 196 or the OSTs in
 197 .IR filesystem.pool .
 198 .TP
 199 .B swap_layouts <filename1> <filename2>
 200 Swap the data (layout and OST objects) of two regular files. The
 201 two files have to be in the same filesystem, owned by the same user,
 202 reside on the same MDT and writable by the user.
 203
 204 Swapping the layout of two directories is not permitted.
 205 .TP
 206 .B mkdir
 207 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 208 .B lfs setdirstripe
 209 is an alias of the command
 210 .B lfs mkdir
 211 .TP
 212 .B mv
 213 lfs mv is deprecated, use lfs
 214 .B migrate
 215 instead.
 216 .TP
 217 .B migrate
 218 See lfs-migrate(1).
 219 .TP
 220 .B setstripe
 221 See lfs-setstripe(1).
 222 .TP
 223 .B --version
 224 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 225 .TP
 226 .B --list-commands
 227 Output a list of the commands supported by the lfs utility
 228 .TP
 229 .B help
 230 Provides brief help on the various arguments
 231 .TP
 232 .B exit/quit
 233 Quit the interactive lfs session
 234 .SH EXAMPLES
 235 .TP
 236 .B $ lfs check all
 237 Check the status of all servers (MGT, MDT, OST)
 238 .TP
 239 .B $ lfs osts
 240 List all the OSTs
 241 .TP
 242 .B $ lfs mdts
 243 List all the MDTs
 244 .TP
 245 .B $ lfs quotaoff -ug /mnt/lustre
 246 Turn quotas of user and group off
 247 .SH NOTES
 248 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
 249 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
 250 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, \fBlfs flushctx\fR
 251 and \fBlfs project\fR are explained in separate man pages.
 252 .SH AUTHOR
 253 The lfs command is part of the Lustre filesystem.
 254 .SH SEE ALSO
 255 .BR lctl (8),
 256 .BR lfs-df (1),
 257 .BR lfs-fid2path (1),
 258 .BR lfs-find (1),
 259 .BR lfs-flushctx (1),
 260 .BR lfs-getdirstripe (1),
 261 .BR lfs-getname (1),
 262 .BR lfs-getstripe (1),
 263 .BR lfs-hsm (1),
 264 .BR lfs-mkdir (1),
 265 .BR lfs-migrate (1),
 266 .BR lfs_migrate (1),
 267 .BR lfs-project (1),
 268 .BR lfs-path2fid (1),
 269 .BR lfs-quota (1),
 270 .BR lfs-setdirstripe (1),
 271 .BR lfs-setquota (1),
 272 .BR lfs-setstripe (1),
 273 .BR lfs-pcc (1),
 274 .BR lustre (7)