lustre/doc/lfs.1

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