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 [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
  39         [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
  40         [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
  41         [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
  42         [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
  43         [\fB--generation\fR|\fB-g\fR]
  44         [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
  45         [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
  46         [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
  47         [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
  48         [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
  49         <\fIdirname\fR|\fIfilename\fR> ...
  50 .br
  51 .B lfs migrate \fB-m <mdt_index>\fR
  52 .IR directory
  53 .br
  54 .B lfs migrate [\fB-c | --stripe-count <stripe_count>\fR]
  55                [\fB-i | --stripe-index <start_ost_idx>\fR]
  56                [\fB-S | --stripe-size <stripe_size>\fR]
  57                [\fB-p | --pool <pool_name>\fR]
  58                [\fB-o | --ost-list <ost_indices>\fR]
  59                [\fB-b | --block\fR]
  60                [\fB-n | --non-block\fR]
  61 .IR file|directory
  62 .br
  63 .B lfs migrate <\fB-E | --component-end comp_end1\fR> [\fBSTRIPE_OPTIONS\fR]
  64                <\fB-E | --component-end comp_end2\fR> [\fBSTRIPE_OPTIONS\fR]
  65                \fB...\fR
  66 .IR filename
  67 .br
  68 .B lfs mkdir [\fB-c | --count <stripe_count>\fR]
  69              [\fB-i | --index <mdt_idx>\fR]
  70              [\fB-h | --hash-type <hash_name>\fR]
  71              [\fB-m | --mode <mode>\fR]
  72              [\fB-D | --default\fR]
  73 .IR directory
  74 .br
  75 .B lfs osts
  76 .RB [ path ]
  77 .br
  78 .B lfs mdts
  79 .RB [ path ]
  80 .br
  81 .B lfs path2fid [--parents] <path> ...
  82 .br
  83 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
  84 .br
  85 .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>
  86 .br
  87 .B lfs quota -t <-u|-g|-p> <filesystem>
  88 .br
  89 .B lfs quotacheck [-ug] <filesystem>
  90 .br
  91 .B lfs quotaon [-ugf] <filesystem>
  92 .br
  93 .B lfs quotaoff [-ug] <filesystem>
  94 .br
  95 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
  96         \fB[--stripe-index|-i start_ost_index] [--pool|-p <poolname>]
  97         \fB[--ost-list|-o <ost_indices>] <directory|filename>\fR
  98 .br
  99 .B lfs setstripe -d <dir>
 100 .br
 101 .B lfs setstripe <--component-end|-E end1> [STRIPE_OPTIONS]
 102        \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
 103 .br
 104 .B lfs setstripe --component-add <--component-end|-E end1> [STRIPE_OPTIONS]
 105        \fB<--component-end|-E end2> [STRIPE_OPTIONS] ... <filename>\fR
 106 .br
 107 .B lfs setstripe --component-del <--component-id|-I id | --component-flags flags> <filename>
 108 .br
 109 .B lfs --version
 110 .br
 111 .B lfs --list-commands
 112 .br
 113 .B lfs help
 114 .SH DESCRIPTION
 115 .B lfs
 116 can be used to create a new file with a specific striping pattern, determine
 117 the default striping pattern, gather the extended attributes (object numbers
 118 and location) for a specific file. It can be invoked interactively without any
 119 arguments or in a non-interactive mode with one of the arguments supported.
 120 .TP
 121 .B Component Flags
 122 .br
 123 Component flags can be set by option \fB--component-flags\fR<=\fIflags\fR>.
 124
 125 .br
 126 The following component flags are supported so far:
 127 .RS
 128 .TP
 129 .B init
 130 indicates the object(s) of this component has been instantiated.
 131 .TP
 132 .B stale
 133 means the data contained in this component is stale. Data in a stale component
 134 won't be returned by reading. Used only by FLR.
 135 .TP
 136 .B prefer
 137 is a hint to Lustre that means this components will likely be chosen for read
 138 and write. Used only by FLR.
 139 .LP
 140 The same set of flag can be set in \fBgetstripe\fR to list the component(s)
 141 that matches the \fIflags\fR, or doesn't match the \fIflags\fR if it has a caret '^'
 142 in front. It can also be applied to \fBfind\fR so that only the files that have
 143 the components described by \fBflags\fR will be listed.
 144 .RE
 145 .LP
 146 .SH OPTIONS
 147 The various options supported by lfs are listed and explained below:
 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
 159 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
 160 .TP
 161 .B data_version [-n] <filename>
 162 Display current version of file data. If -n is specified, data version is read
 163 without taking lock. As a consequence, data version could be outdated if there
 164 is dirty caches on filesystem clients, but this will not force data flushes and
 165 has less impact on filesystem.
 166
 167 Even without -n, race conditions are possible and data version should be
 168 checked before and after an operation to be confident the data did not change
 169 during it.
 170 .TP
 171 .B df
 172 See
 173 .BR lfs-df (1)
 174 for details of
 175 .B lfs df
 176 usage.
 177 .TP
 178 .B find
 179 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 'more than n', while \fB-\fR before a numeric value means 'less than n'.
 180
 181 .br
 182 \fBlfs find\fR command allows to use component flags to list files that have
 183 specified \fIflags\fR matched(See \fB Component Flags\fR).
 184 .TP
 185 .B getname [-h]|[path ...]
 186 Report all the Lustre mount points and the corresponding Lustre filesystem
 187 instance. If one or more \fBpath\fR entries are provided, then only the
 188 Lustre instance for these mount points is returned. If the path given is not on
 189 a Lustre instance 'No such device' is reported.
 190 .TP
 191 .B osts
 192 .RB [ path ]
 193 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 194 that is located on a lustre mounted file system then only the OSTs belonging
 195 to that filesystem are displayed.
 196 .TP
 197 .B getstripe [\fB--obd\fR|\fB-O\fR <\fIuuid\fR>] [\fB--quiet\fR|\fB-q\fR]
 198         [\fB--verbose\fR|\fB-v\fR] [\fB--stripe-count\fR|\fB-c\fR]
 199         [\fB--stripe-index\fR|\fB-i\fR] [\fB--mdt-index\fR|\fB-M\fR]
 200         [\fB--fid\fR|\fB-F\fR] [\fB--stripe-size\fR|\fB-S\fR]
 201         [\fB--directory\fR|\fB-d\fR] [\fB--layout\fR|\fB-L\fR]
 202         [\fB--generation\fR|\fB-g\fR]
 203         [\fB--component-id\fR[=\fIcomp_id\fR]|\fB-I\fR[\fIcomp_id\fR]]
 204         [\fB--component-flags\fR[=\fIcomp_flags\fR]] [\fB--component-count\fR]
 205         [\fB--component-start\fR[=[+-]\fIN\fR[kMGTPE]]]
 206         [\fB--component-end\fR[=[+-]\fIN\fR[kMGTPE]]|\fB-E\fR[[+-]\fIN\fR[kMGTPE]]]
 207         [\fB--pool\fR|\fB-p\fR] [\fB--recursive\fR|\fB-r\fR] [\fB--raw\fR|\fB-R\fR]
 208         <\fIdirname\fR|\fIfilename\fR> ...
 209 .br
 210 List the striping information for a given filename or directory tree.
 211 By default the stripe count, size, and offset will be returned. If you
 212 only want specific striping information then the options of
 213 .BR --count ,
 214 .BR --size ,
 215 .BR --index ,
 216 .BR --offset ,
 217 .BR --layout ,
 218 .BR --fid ,
 219 .BR --generation ,
 220 .BR --component-id ,
 221 .BR --component-flags ,
 222 .BR --component-count ,
 223 .BR --component-start ,
 224 .BR --component-end ,
 225 or
 226 .B --pool
 227 can be used to return only the specific fields.
 228 .br
 229 If the
 230 .B --raw
 231 option is specified, the stripe information is printed without substituting the
 232 filesystem's default values for unspecified fields. If the striping EA is not
 233 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
 234 respectively.
 235 In the case where you only want details about the files' object id
 236 information then the
 237 .B --quiet
 238 option is used. Additional information available about striping can be
 239 displayed with
 240 .BR --verbose .
 241 The default behavior when a directory is specified is to list the striping
 242 information for all files within the specified directory (like
 243 .RB ' "ls -l" ') .
 244 This can be expanded with
 245 .B --recursive
 246 which will recurse into all subdirectories.
 247 If you wish to get striping information for only the specified directory, then
 248 .B --directory
 249 can be used to limit the information, like
 250 .RB ' "ls -d" ').
 251 You can limit the returned files to those with objects on a specific OST with
 252 .BR --obd .
 253 To show only the FID use
 254 .BR --fid .
 255 The layout generation can be printed with the
 256 .B --generation
 257 option.
 258 You can limit the displayed content by specifing argument for
 259 .B --component-id|-I
 260 .B --component-flags
 261 .B --component-start
 262 .B --component-end|-E
 263 options. For example, "--component-id=2" or "-I2" will only display the layout
 264 attributes for the component with id equal to 2.
 265
 266 .br
 267 \fBlfs getstripe\fR command allows to use component flags to list files that
 268 have specified \fIflags\fR matched(See \fB Component Flags\fR).
 269 .TP
 270 .B fid2path [--link <linkno>] <fsname|rootpath> <fid> ...
 271 Print out the pathname(s) for the specified \fIfid\fR(s) from the filesystem
 272 mounted at \fBrootpath\fR or named \fBfsname\fR.  If a file has multiple
 273 hard links, then all of the pathnames for that file are printed, unless
 274 \fB--link\fR limits the printing to only the specified link number (starting
 275 at 0, in no particular order).  If multiple fids are specified, but only a
 276 single pathname is needed for each file, use \fB--link 0\fR.
 277 .TP
 278 .B path2fid [--parents] <path> ...
 279 Print out the FIDs for the specified \fBpath(s)\fR.  If multiple pathnames
 280 are given, then they will be printed one per line with the path as prefix.
 281 The \fB--parents\fR switch makes it output the parent FID and name(s) of the
 282 given entries. If an entry has multiple links, these are displayed on a single
 283 line, tab-separated.
 284 .TP
 285 .B pool_list
 286 .RI { filesystem }[ .poolname "] | {" pathname }
 287 List the pools in
 288 .I filesystem
 289 or
 290 .IR pathname ,
 291 or the OSTs in
 292 .IR filesystem.pool .
 293 .TP
 294 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g|-p <uname>|<uid>|<gname>|<gid>|<projid>] <filesystem>
 295 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).
 296 .TP
 297 .B quota -t <-u|-g|-p> <filesystem>
 298 To display block and inode grace times for user (-u) or group (-g) or project (-p) quotas
 299 .TP
 300 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
 301 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.
 302 .TP
 303 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
 304 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>)
 305 .TP
 306 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
 307 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>=""
 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 mkdir
 317 lfs mkdir is documented in the man page: lfs-mkdir(1). NOTE:
 318 .B lfs setdirstripe
 319 is an alias of the command
 320 .B lfs mkdir
 321 .TP
 322 .B mv
 323 lfs mv is deprecated, use lfs
 324 .B migrate
 325 instead.
 326 .TP
 327 .B migrate
 328 See lfs-migrate(1).
 329 .TP
 330 .B setstripe
 331 See lfs-setstripe(1).
 332 .TP
 333 .B --version
 334 Output the build version of the lfs utility. Use "lctl lustre_build_version" to get the version of the Lustre kernel modules
 335 .TP
 336 .B --list-commands
 337 Output a list of the commands supported by the lfs utility
 338 .TP
 339 .B help
 340 Provides brief help on the various arguments
 341 .TP
 342 .B exit/quit
 343 Quit the interactive lfs session
 344 .SH EXAMPLES
 345 .TP
 346 .B $ lfs getstripe -v /mnt/lustre/file1
 347 Lists the detailed object allocation of a given file
 348 .TP
 349 .B $ lfs getstripe -v -I2 /mnt/lustre/file1
 350 Lists the detailed information of the component 2 in a given file
 351 .TP
 352 .B $ lfs getstripe --component-flags=^init -I /mnt/lustre/file1
 353 Print only the component IDs for all the uninstantiated components
 354 .TP
 355 .B $ lfs getstripe --component-flags=init,^stale -I /mnt/lustre/file1
 356 Print only the component(s) that are instantiated but not stale
 357 .TP
 358 .B $ lfs getstripe -E-64M /mnt/lustre/file1
 359 Lists the information of the components in a file which has less than 64M extent end
 360 .TP
 361 .B $ lfs getstripe -I3 --component-start /mnt/lustre/file1
 362 Print only the component start for the component with ID of 3
 363 .TP
 364 .B $ lfs find /mnt/lustre
 365 Efficiently lists all files in a given directory and its subdirectories
 366 .TP
 367 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 368 Recursively list all regular files in given directory more than 30 days old
 369 .TP
 370 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 371 Recursively list all files in a given directory that have objects on OST2-UUID.
 372 .TP
 373 .B $ lfs find --component-count +3 /mnt/lustre
 374 Recursively list all files that have more than 3 components.
 375 .TP
 376 .B $ lfs find --component-flags=init,prefer,^stale /mnt/lustre
 377 Recursively list all files that have at least one component with both 'init' and
 378 \'prefer' flags set, and doesn't have flag 'stale' set.
 379 .TP
 380 .B $ lfs check servers
 381 Check the status of all servers (MDT, OST)
 382 .TP
 383 .B $ lfs osts
 384 List all the OSTs
 385 .TP
 386 .B $ lfs mdts
 387 List all the MDTs
 388 .TP
 389 .B $ lfs quota -u bob /mnt/lustre
 390 List quotas of user `bob'
 391 .TP
 392 .B $ lfs quota -t -u /mnt/lustre
 393 Show grace times for user quotas on /mnt/lustre
 394 .TP
 395 .B $ lfs quotachown -i /mnt/lustre
 396 Change file owner and group
 397 .TP
 398 .B $ lfs quotacheck -ug /mnt/lustre
 399 Quotacheck for user and group - will turn on quotas after making the check.
 400 .TP
 401 .B $ lfs quotaon -ug /mnt/lustre
 402 Turn quotas of user and group on
 403 .TP
 404 .B $ lfs quotaoff -ug /mnt/lustre
 405 Turn quotas of user and group off
 406 .SH NOTES
 407 The usage of \fBlfs hsm_*\fR, \fBlfs setstripe\fR, \fBlfs migrate\fR, \fBlfs setdirstripe\fR,
 408 \fBlfs getdirstripe\fR, \fBlfs mkdir\fR and \fBlfs project\fR are explained in separate
 409 man pages.
 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 lctl (8),
 416 .BR lfs-df (1),
 417 .BR lfs-getdirstripe (1),
 418 .BR lfs-hsm (1),
 419 .BR lfs-mkdir (1),
 420 .BR lfs-migrate (1),
 421 .BR lfs-project (1),
 422 .BR lfs-setdirstripe (1),
 423 .BR lfs-setquota (1),
 424 .BR lfs-setstripe (1),
 425 .BR lustre (7)