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 unlink_foreign
 131 .IR path \fR[\fIpath\fR ...]
 132 .br
 133 .B lfs --version
 134 .br
 135 .B lfs --list-commands
 136 .br
 137 .B lfs help
 138 .SH DESCRIPTION
 139 .B lfs
 140 can be used to create a new file with a specific striping pattern, determine
 141 the default striping pattern, gather the extended attributes (object numbers
 142 and location) for a specific file. It can be invoked interactively without any
 143 arguments or in a non-interactive mode with one of the arguments supported.
 144 .SH COMMANDS
 145 A number of sub-commands supported by lfs are listed below.  Other commands
 146 are described in separate man pages of the form
 147 .BI lfs- command
 148 as listed in the
 149 .B SEE ALSO
 150 section at the end.
 151 .TP
 152 .B changelog
 153 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.
 154 .TP
 155 .B changelog_clear
 156 Indicate that changelog records previous to <endrec> are no longer of
 157 interest to a particular consumer <id>, potentially allowing the MDT to
 158 free up disk space. An <endrec> of 0 indicates the current last record.
 159 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
 160 .TP
 161 .B check <mgts|mdts|osts|all>
 162 Display the status of the MGTs, MDTs or OSTs (as specified in the command) or
 163 all the servers (MGTs, MDTs and OSTs).
 164 .TP
 165 .B data_version [-nrw] <filename>
 166 Display the current version of file data. If -n is specified, the data version
 167 is read without taking a lock. As a consequence, the data version could be
 168 outdated if there are dirty caches on filesystem clients, but this option will
 169 not force data flushes and has less of an impact on the filesystem. If -r is
 170 specified, the data version is read after dirty pages on clients are flushed. If
 171 -w is specified, the data version is read after all caching pages on clients are
 172 flushed.
 173
 174 Even with -r or -w, race conditions are possible and the data version should be
 175 checked before and after an operation to be confident the data did not change
 176 during it.
 177
 178 The data version is the sum of the last committed transaction numbers of all
 179 data objects of a file. It is used by HSM policy engines for verifying that file
 180 data has not been changed during an archive operation or before a release
 181 operation, and by OST migration, primarily for verifying that file data has not
 182 been changed during a data copy, when done in non-blocking mode.
 183 .TP
 184 .B flushctx
 185 See lfs-flushctx(1).
 186 .TP
 187 .B osts
 188 .RB [ path ]
 189 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 190 that is located on a lustre mounted file system then only the OSTs belonging
 191 to that filesystem are displayed.
 192 .TP
 193 .B pool_list
 194 .RI { filesystem }[ .poolname "] | {" pathname }
 195 List the pools in
 196 .I filesystem
 197 or
 198 .IR pathname ,
 199 or the OSTs in
 200 .IR filesystem.pool .
 201 .TP
 202 .B swap_layouts <filename1> <filename2>
 203 Swap the data (layout and OST objects) of two regular files. The
 204 two files have to be in the same filesystem, owned by the same user,
 205 reside on the same MDT and writable by the user.
 206
 207 Swapping the layout of two directories is not permitted.
 208 .TP
 209 .B mkdir
 210 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 211 .B lfs setdirstripe
 212 is an alias of the command
 213 .B lfs mkdir
 214 .TP
 215 .B mv
 216 lfs mv is deprecated, use lfs
 217 .B migrate
 218 instead.
 219 .TP
 220 .B migrate
 221 See lfs-migrate(1).
 222 .TP
 223 .B setstripe
 224 See lfs-setstripe(1).
 225 .TP
 226 .B unlink_foreign
 227 Remove the foreign files/dirs that are prevented to be using regular unlink/rmdir commands/syscalls. Works also for regular files/dirs.
 228 .TP
 229 .B --version
 230 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 231 .TP
 232 .B --list-commands
 233 Output a list of the commands supported by the lfs utility
 234 .TP
 235 .B help
 236 Provides brief help on the various arguments
 237 .TP
 238 .B exit/quit
 239 Quit the interactive lfs session
 240 .SH EXAMPLES
 241 .TP
 242 .B $ lfs check all
 243 Check the status of all servers (MGT, MDT, OST)
 244 .TP
 245 .B $ lfs osts
 246 List all the OSTs
 247 .TP
 248 .B $ lfs mdts
 249 List all the MDTs
 250 .TP
 251 .B $ lfs quotaoff -ug /mnt/lustre
 252 Turn quotas of user and group off
 253 .SH NOTES
 254 The usage of \fBlfs find\fR, \fBlfs getstripe\fR, \fBlfs hsm_*\fR,
 255 \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs getdirstripe\fR,
 256 \fBlfs setdirstripe\fR, \fBlfs mkdir\fR, \fBlfs flushctx\fR
 257 and \fBlfs project\fR are explained in separate man pages.
 258 .SH AUTHOR
 259 The lfs command is part of the Lustre filesystem.
 260 .SH SEE ALSO
 261 .BR lctl (8),
 262 .BR lfs-df (1),
 263 .BR lfs-fid2path (1),
 264 .BR lfs-find (1),
 265 .BR lfs-flushctx (1),
 266 .BR lfs-getdirstripe (1),
 267 .BR lfs-getname (1),
 268 .BR lfs-getstripe (1),
 269 .BR lfs-hsm (1),
 270 .BR lfs-mkdir (1),
 271 .BR lfs-migrate (1),
 272 .BR lfs_migrate (1),
 273 .BR lfs-project (1),
 274 .BR lfs-path2fid (1),
 275 .BR lfs-quota (1),
 276 .BR lfs-setdirstripe (1),
 277 .BR lfs-setquota (1),
 278 .BR lfs-setstripe (1),
 279 .BR lfs-pcc (1),
 280 .BR lustre (7)