lustre/doc/lfs.1

   1 .TH lfs 1 "2017 Jan 12" Lustre "user utilities"
   2 .SH NAME
   3 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
   4 .SH SYNOPSIS
   5 .br
   6 .B lfs
   7 .br
   8 .B lfs changelog [--follow] <mdtname> [startrec [endrec]]
   9 .br
  10 .B lfs changelog_clear <mdtname> <id> <endrec>
  11 .br
  12 .B lfs check <mds|osts|servers>
  13 .br
  14 .B lfs data_version [-n] \fB<filename>\fR
  15 .br
  16 .B lfs df [-ihlv] [--pool|-p <fsname>[.<pool>]] [path]
  17 .br
  18 .B lfs fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
  19 .br
  20 .B lfs find <directory|filename>
  21         \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N]
  22         \fB[--maxdepth|-D N] [[!] --mdt|-m <uuid|index,...>] [--name|-n pattern]
  23         \fB[[!] --ost|-O <uuid|index,...>] [--print|-p] [--print0|-P]
  24         \fB[[!] --size|-s [-+]N[kMGTPE]]
  25         \fB[[!] --stripe-count|-c [+-]<stripes>]
  26         \fB[[!] --stripe-index|-i <index,...>]
  27         \fB[[!] --stripe-size|-S [+-]N[kMG]]
  28         \fB[[!] --layout|-L raid0,released]
  29         \fB[[!] --component-count [+-]comp_cnt]
  30         \fB[[!] --component-start [+-]N[kMGTPE]]
  31         \fB[[!] --component-end|-E [+-]N[kMGTPE]]
  32         \fB[[!] --component-flags <comp_flags>]
  33         \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
  34         \fB[[!] --uid|-u|--user|-U|--projid <uname>|<uid>|<projid>] [[!] --pool <pool>]\fR
  35 .br
  36 .B lfs getname [-h]|[path ...]
  37 .br
  38 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
  39         \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M] [--fid|-F]
  40         \fB[--stripe-size|-S] [--directory|-d] [--layout|-L] [--generation|-g]
  41         \fB[--component-id|-I [comp_id]] [--component-flags [comp_flags]]
  42         \fB[--component-count] [--component-start [+-][N][kMGTPE]]
  43         \fB[--component-end|-E [+-][N][kMGTPE]]
  44         \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
  45 .br
  46 .B lfs migrate \fB-m <mdt_index>\fR
  47 .IR directory
  48 .br
  49 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
  50                [\fB-i | --stripe-index <start_ost_idx>\fR]
  51                [\fB-S | --stripe-size <stripe_size>\fR]
  52                [\fB-p | --pool <pool_name>\fR]
  53                [\fB-o | --ost-list <ost_indices>\fR]
  54                [\fB-b | --block\fR]
  55                [\fB-n | --non-block\fR]
  56 .IR file|directory
  57 .br
  58 .B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR]
  59                <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR]
  60                \fB...\fR
  61 .IR filename
  62 .br
  63 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
  64              [\fB-i | --index <mdt_idx>\fR]
  65              [\fB-h | --hash-type <hash_name>\fR]
  66              [\fB-m | --mode <mode>\fR]
  67              [\fB-D | --default\fR]
  68 .IR directory
  69 .br
  70 .B lfs osts
  71 .RB [ path ]
  72 .br
  73 .B lfs mdts
  74 .RB [ path ]
  75 .br
  76 .B lfs path2fid [--parents] <path> ...
  77 .br
  78 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
  79 .br
  80 .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>
  81 .br
  82 .B lfs quota -t <-u|-g|-p> <filesystem>
  83 .br
  84 .B lfs quotacheck [-ug] <filesystem>
  85 .br
  86 .B lfs quotaon [-ugf] <filesystem>
  87 .br
  88 .B lfs quotaoff [-ug] <filesystem>
  89 .br
  90 .B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
  91              \fB[--block-softlimit <block-softlimit>]
  92              \fB[--block-hardlimit <block-hardlimit>]
  93              \fB[--inode-softlimit <inode-softlimit>]
  94              \fB[--inode-hardlimit <inode-hardlimit>]
  95              \fB<filesystem>\fR
  96 .br
  97 .B lfs setquota <-u|--user|-g|--group|-p|--projid> <uname|uid|gname|gid|projid>
  98              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
  99              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
 100              \fB<filesystem>\fR
 101 .br
 102 .B lfs setquota -t <-u|-g|-p>
 103              \fB[--block-grace <block-grace>]\fR
 104              \fB[--inode-grace <inode-grace>]\fR
 105              \fB<filesystem>\fR
 106 .br
 107 .B lfs setquota -t <-u|-g|-p>
 108              \fB[-b <block-grace>] [-i <inode-grace>]\fR
 109              \fB<filesystem>\fR
 110 .br
 111 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
 112         \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
 113         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
 114 .br
 115 .B lfs setstripe -d <dir>
 116 .br
 117 .B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS]
 118        \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
 119 .br
 120 .B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS]
 121        \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
 122 .br
 123 .B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> <filename>
 124 .br
 125 .B lfs --version
 126 .br
 127 .B lfs --list-commands
 128 .br
 129 .B lfs help
 130 .SH DESCRIPTION
 131 .B lfs
 132 can be used to create a new file with a specific striping pattern, determine
 133 the default striping pattern, gather the extended attributes (object numbers
 134 and location) for a specific file. It can be invoked interactively without any
 135 arguments or in a non-interactive mode with one of the arguments supported.
 136 .SH OPTIONS
 137 The various options supported by lfs are listed and explained below:
 138 .TP
 139 .B changelog
 140 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.
 141 .TP
 142 .B changelog_clear
 143 Indicate that changelog records previous to <endrec> are no longer of
 144 interest to a particular consumer <id>, potentially allowing the MDT to
 145 free up disk space. An <endrec> of 0 indicates the current last record.
 146 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
 147 .TP
 148 .B check
 149 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
 150 .TP
 151 .B df
 152 See
 153 .BR lfs-df (1)
 154 for details of
 155 .B lfs df
 156 usage.
 157 .TP
 158 .B find
 159 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 \fIfiles with the parameter OR MORE\fR, while \fB-\fR before a numeric value means \fIfiles with the parameter OR LESS\fR.
 160 .TP
 161 .B getname [-h]|[path ...]
 162 Report all the Lustre mount points and the corresponding Lustre filesystem
 163 instance. If one or more \fBpath\fR entries are provided, then only the
 164 Lustre instance for these mount points is returned. If the path given is not on
 165 a Lustre instance 'No such device' is reported.
 166 .TP
 167 .B osts
 168 .RB [ path ]
 169 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 170 that is located on a lustre mounted file system then only the OSTs belonging
 171 to that filesystem are displayed.
 172 .TP
 173 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
 174         \fB[--count | -c ] [--index | -i | --offset | -o  ]
 175         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
 176         \fB[--layout | -L ] [--fid | -F ] [--generation | -g ]
 177         \fB[--component-id|-I [comp_id]]
 178         \fB[--component-flags [comp_flags]]
 179         \fB[--component-count] [--component-start [+-][N][kMGTPE]]
 180         \fB[--component-end|-E [+-][N][kMGTPE]]
 181         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
 182 .br
 183 List the striping information for a given filename or directory tree.
 184 By default the stripe count, size, and offset will be returned. If you
 185 only want specific striping information then the options of
 186 .BR --count ,
 187 .BR --size ,
 188 .BR --index ,
 189 .BR --offset ,
 190 .BR --layout ,
 191 .BR --fid ,
 192 .BR --generation ,
 193 .BR --component-id ,
 194 .BR --component-flags ,
 195 .BR --component-count ,
 196 .BR --component-start ,
 197 .BR --component-end ,
 198 or
 199 .B --pool
 200 can be used to return only the specific fields.
 201 .br
 202 If the
 203 .B --raw
 204 option is specified, the stripe information is printed without substituting the
 205 filesystem's default values for unspecified fields. If the striping EA is not
 206 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
 207 respectively.
 208 In the case where you only want details about the files' object id
 209 information then the
 210 .B --quiet
 211 option is used. Additional information available about striping can be
 212 displayed with
 213 .BR --verbose .
 214 The default behavior when a directory is specified is to list the striping
 215 information for all files within the specified directory (like
 216 .RB ' "ls -l" ') .
 217 This can be expanded with
 218 .B --recursive
 219 which will recurse into all subdirectories.
 220 If you wish to get striping information for only the specified directory, then
 221 .B --directory
 222 can be used to limit the information, like
 223 .RB ' "ls -d" ').
 224 You can limit the returned files to those with objects on a specific OST with
 225 .BR --obd .
 226 To show only the FID use
 227 .BR --fid .
 228 The layout generation can be printed with the
 229 .B --generation
 230 option.
 231 You can limit the displayed content by specifing argument for
 232 .B --component-id
 233 .B --component-flags
 234 .B --component-start
 235 .B --component-end
 236 options. For example, "--component-id 1" will only display the information
 237 for component 1.
 238 .TP
 239 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
 240 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
 241 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
 242 hard links, then all of the pathnames for that file are printed, unless
 243 \fB--link\fR limits the printing to only the specified link number (starting
 244 at 0, in no particular order).  If multiple fids are specified, but only a
 245 single pathname is needed for each file, use \fB--link 0\fR.
 246 .TP
 247 .B path2fid [--parents] <path> ...
 248 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
 249 are given, then they will be printed one per line with the path as prefix.
 250 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
 251 given entries. If an entry has multiple links, these are displayed on a single
 252 line, tab-separated.
 253 .TP
 254 .B pool_list
 255 .RI { filesystem }[ .poolname "] | {" pathname }
 256 List the pools in
 257 .I filesystem
 258 or
 259 .IR pathname ,
 260 or the OSTs in
 261 .IR filesystem.pool .
 262 .TP
 263 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
 264 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).
 265 .TP
 266 .B quota -t <-u|-g|-p> <filesystem>
 267 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
 268 .TP
 269 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
 270 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.
 271 .TP
 272 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
 273 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f). Not used anymore in lustre 2.4.0 where quota enforcement must be enabled via conf_param (e.g. lctl conf_param ${FSNAME}.quota.<ost|mdt>=<u|g|ug>)
 274 .TP
 275 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
 276 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>=""
 277 .TP
 278 .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>
 279 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
 280 .TP
 281 .B setquota -t [-u|-g|-p] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 282 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
 283 .TP
 284 .B swap_layouts <filename1> <filename2>
 285 Swap the data (layout and OST objects) of two regular files. The
 286 two files have to be in the same filesystem, owned by the same user,
 287 reside on the same MDT and writable by the user.
 288
 289 Swapping the layout of two directories is not permitted.
 290 .TP
 291 .B data_version [-n] <filename>
 292 Display current version of file data. If -n is specified, data version is read
 293 without taking lock. As a consequence, data version could be outdated if there
 294 is dirty caches on filesystem clients, but this will not force data flushes and
 295 has less impact on filesystem.
 296
 297 Even without -n, race conditions are possible and data version should be
 298 checked before and after an operation to be confident the data did not change
 299 during it.
 300 .TP
 301 .B mkdir
 302 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 303 .B lfs setdirstripe
 304 is an alias of the command
 305 .B lfs mkdir
 306 .TP
 307 .B mv
 308 lfs mv is deprecated, use lfs
 309 .B migrate
 310 instead.
 311 .TP
 312 .B migrate
 313 See lfs-migrate(1).
 314 .TP
 315 .B setstripe
 316 See lfs-setstripe(1).
 317 .TP
 318 .B --version
 319 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 320 .TP
 321 .B --list-commands
 322 Output a list of the commands supported by the lfs utility
 323 .TP
 324 .B help
 325 Provides brief help on the various arguments
 326 .TP
 327 .B exit/quit
 328 Quit the interactive lfs session
 329 .SH EXAMPLES
 330 .TP
 331 .B $ lfs getstripe -v /mnt/lustre/file1
 332 Lists the detailed object allocation of a given file
 333 .TP
 334 .B $ lfs getstripe -v --component-id 2 /mnt/lustre/file1
 335 Lists the detailed information of the component 2 in a given file
 336 .TP
 337 .B $ lfs getstripe -E -64M /mnt/lustre/file1
 338 Lists the information of the components in a file which has at least 64M extent end
 339 .TP
 340 .B $ lfs find /mnt/lustre
 341 Efficiently lists all files in a given directory and its subdirectories
 342 .TP
 343 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 344 Recursively list all regular files in given directory more than 30 days old
 345 .TP
 346 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 347 Recursively list all files in a given directory that have objects on OST2-UUID.
 348 .TP
 349 .B $ lfs find --component-count +3 /mnt/lustre
 350 Recursively list all files that have at most 3 components.
 351 .TP
 352 .B $ lfs check servers
 353 Check the status of all servers (MDT, OST)
 354 .TP
 355 .B $ lfs osts
 356 List all the OSTs
 357 .TP
 358 .B $ lfs mdts
 359 List all the MDTs
 360 .TP
 361 .B $ lfs quota -u bob /mnt/lustre
 362 List quotas of user `bob'
 363 .TP
 364 .B $ lfs quota -t -u /mnt/lustre
 365 Show grace times for user quotas on /mnt/lustre
 366 .TP
 367 .B $ lfs quotachown -i /mnt/lustre
 368 Change file owner and group
 369 .TP
 370 .B $ lfs quotacheck -ug /mnt/lustre
 371 Quotacheck for user and group - will turn on quotas after making the check.
 372 .TP
 373 .B $ lfs quotaon -ug /mnt/lustre
 374 Turn quotas of user and group on
 375 .TP
 376 .B $ lfs quotaoff -ug /mnt/lustre
 377 Turn quotas of user and group off
 378 .TP
 379 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 380 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 381 .TP
 382 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 383 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 384 .SH NOTES
 385 The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR,
 386 \fBlfs getdirstripe\fR and \fBlfs mkdir\fR are explained in separated man pages.
 387 .SH BUGS
 388 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 389 .SH AUTHOR
 390 The lfs command is part of the Lustre filesystem.
 391 .SH SEE ALSO
 392 .BR lfs-df (1),
 393 .BR lfs-hsm (1),
 394 .BR lfs-setdirstripe (1),
 395 .BR lfs-getdirstripe (1),
 396 .BR lfs-mkdir (1),
 397 .BR lfs_migrate (1),
 398 .BR lfs-setstripe (1),
 399 .BR lfs-migrate (1),
 400 .BR lctl (8),
 401 .BR lustre (7)