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