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
   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 df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
  15 .br
  16 .B lfs find <directory|filename>
  17         \fB[[!] --atime|-A [-+]N] [[!] --mtime|-M [-+]N] [[!] --ctime|-C [+-]N]
  18         \fB[--maxdepth|-D N] [[!] --mdt|-m <uuid|index,...>] [--name|-n pattern]
  19         \fB[[!] --ost|-O <uuid|index,...>] [--print|-p] [--print0|-P]
  20         \fB[[!] --size|-s [-+]N[kMGTPE]]
  21         \fB[[!] --stripe-count|-c [+-]<stripes>]
  22         \fB[[!] --stripe-index|-i <index,...>]
  23         \fB[[!] --stripe-size|-S [+-]N[kMG]]
  24         \fB[--type |-t {bcdflpsD}] [[!] --gid|-g|--group|-G <gname>|<gid>]
  25         \fB[[!] --uid|-u|--user|-U <uname>|<uid>] [[!] --pool <pool>]\fR
  26 .br
  27 .B lfs getname [-h]|[path ...]
  28 .br
  29 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
  30         \fB[--stripe-count|-c ] [--stripe-index|-i] [--mdt-index|-M]
  31         \fB[--stripe-size|-S] [--directory|-d]
  32         \fB[--pool|-p] [--recursive|-r] [--raw|-R] <dirname|filename> ...\fR
  33 .br
  34 .B lfs setstripe [--stripe-size|-S stripe_size] [--stripe-count|-c stripe_count]
  35         \fB[--stripe-index|-i start_ost_index ] [--pool|-p <poolname>]
  36         \fB<directory|filename>\fR
  37 .br
  38 .B lfs setstripe -d <dir>
  39 .br
  40 .B lfs osts
  41 .RB [ path ]
  42 .br
  43 .B lfs pool_list <filesystem>[.<pool>] | <pathname>
  44 .br
  45 .B lfs quota [-q] [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
  46 .br
  47 .B lfs quota -t <-u|-g> <filesystem>
  48 .br
  49 .B lfs quotacheck [-ug] <filesystem>
  50 .br
  51 .B lfs quotaon [-ugf] <filesystem>
  52 .br
  53 .B lfs quotaoff [-ug] <filesystem>
  54 .br
  55 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  56              \fB[--block-softlimit <block-softlimit>]
  57              \fB[--block-hardlimit <block-hardlimit>]
  58              \fB[--inode-softlimit <inode-softlimit>]
  59              \fB[--inode-hardlimit <inode-hardlimit>]
  60              \fB<filesystem>\fR
  61 .br
  62 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  63              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
  64              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
  65              \fB<filesystem>\fR
  66 .br
  67 .B lfs setquota -t <-u|-g>
  68              \fB[--block-grace <block-grace>]
  69              \fB[--inode-grace <inode-grace>]
  70              \fB<filesystem>\fR
  71 .br
  72 .B lfs setquota -t <-u|-g>
  73              \fB[-b <block-grace>] [-i <inode-grace>]
  74              \fB<filesystem>\fR
  75 .br
  76 .br
  77 .B lfs swap_layouts <filename1> <filename2>
  78 .br
  79 .B lfs data_version [-n] \fB<filename>\fR
  80 .br
  81 .B lfs help
  82 .SH DESCRIPTION
  83 .B lfs
  84 can be used to create a new file with a specific striping pattern, determine the default striping pattern, gather the extended attributes (object numbers and location) for a specific file. It can be invoked interactively without any arguments or in a non-interactive mode with one of the arguements supported.
  85 .SH OPTIONS
  86 The various options supported by lctl are listed and explained below:
  87 .TP
  88 .B changelog
  89 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.
  90 .TP
  91 .B changelog_clear
  92 Indicate that changelog records previous to <endrec> are no longer of
  93 interest to a particular consumer <id>, potentially allowing the MDT to
  94 free up disk space. An <endrec> of 0 indicates the current last record.
  95 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
  96 .TP
  97 .B check
  98 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
  99 .TP
 100 .B df [-i] [-h] [--pool|-p <fsname>[.<pool>] [path]
 101 Report filesystem disk space usage or inodes usage (with \fB-i\fR) of each
 102 MDT/OST, or a subset of OSTs if a pool is specified with \fB-p\fR.  By default
 103 print the usage of all mounted Lustre filesystems, otherwise if \fBpath\fR is
 104 specified print only the usage of that filesystem.  If \fB-h\fR is given, the
 105 output is printed in \fIh\fRuman readable format, using SI base-2 suffixes
 106 for \fBM\fRega-, \fBG\fRiga-, \fBT\fRera-, \fBP\fReta-, or \fBE\fRxabytes.
 107 .TP
 108 .B find
 109 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). 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.
 110 .TP
 111 .B getname [-h]|[path ...]
 112 Report all the Lustre mount points and the corresponding Lustre filesystem
 113 instance. If one or more \fBpath\fR entries are provided, then only the
 114 Lustre instance for these mount points is returned. If the path given is not on
 115 a Lustre instance 'No such device' is reported.
 116 .TP
 117 .B osts
 118 .RB [ path ]
 119 List all the OSTs for all mounted filesystems. If a \fBpath\fR is provided
 120 that is located on a lustre mounted file system then only the OSTs belonging
 121 to that filesystem are displayed.
 122 .TP
 123 .B getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
 124         \fB[--count | -c ] [--index | -i | --offset | -o  ]
 125         \fB[--pool | -p ] [--size | -s ] [--directory | -d ]
 126         \fB[--recursive | -r ] [--raw | -R ] <dirname|filename>\fR
 127 .br
 128 List the striping information for a given filename or directory tree.
 129 By default the stripe count, size, and offset will be returned. If you
 130 only want specific striping information then the options of
 131 .BR --count ,
 132 .BR --size ,
 133 .BR --index ,
 134 .BR --offset ,
 135 or
 136 .B --pool
 137 can be used to return only the specific fields.
 138 .br
 139 If the
 140 .B --raw
 141 option is specified, the stripe information is printed without substituting the
 142 filesystem's default values for unspecified fields. If the striping EA is not
 143 set, 0, 0, and -1 will be printed for the stripe count, size, and offset
 144 respectively.
 145 In the case where you only want details about the files' object id
 146 information then the
 147 .B --quiet
 148 option is used. Additional information available about striping can be
 149 displayed with
 150 .BR --verbose .
 151 The default behavior when a directory is specified is to list the striping
 152 information for all files within the specified directory (like
 153 .RB ' "ls -l" ') .
 154 This can be expanded with
 155 .B --recursive
 156 which will recurse into all subdirectories.
 157 If you wish to get striping information for only the specified directory, then
 158 .B --directory
 159 can be used to limit the information, like
 160 .RB ' "ls -d" ').
 161 You can limit the returned files to those with objects on a specific OST with
 162 .BR --obd .
 163 .TP
 164 .B setstripe [--stripe-count|-c stripe_count] [--stripe-size|-S stripe_size]
 165         \fB[--stripe-index|-i start_ost_index] [--pool <poolname>]
 166         \fB<dirname|filename>\fR
 167 .br
 168 To create a new file, or set the directory default, with the specified striping parameters.  The
 169 .I stripe_count
 170 is the number of OSTs to stripe a file over. A
 171 .I stripe_count
 172 of 0 means to use the filesystem-wide default stripe count (default 1), and a
 173 .I stripe_count
 174 of -1 means to stripe over all available OSTs.  The
 175 .I stripe_size
 176 is the number of bytes to store on each OST before moving to the next OST.  A
 177 .I stripe_size
 178 of 0 means to use the filesystem-wide default stripe_size (default 1MB).  The
 179 .I start_ost_index
 180 is the OST index (starting at 0) on which to start striping for this file.  A
 181 .I start_ost_index
 182 of -1 allows the MDS to choose the starting index and it is strongly recommended, as this allows space and load balancing to be done by the MDS as needed.  The
 183 .I poolname
 184 is the name of a predefined pool of OSTs (see
 185 .B lctl
 186 ) that will be used for striping. The
 187 .IR stripe_count ,
 188 .IR stripe_size ,
 189 and
 190 .I start_ost_index
 191 will be used as well; the
 192 .I start_ost_index
 193 must be part of the pool or an error will be returned.
 194 .TP
 195 .B setstripe -d
 196 Delete the default striping on the specified directory.
 197 .TP
 198 .B pool_list
 199 .RI { filesystem }[ .poolname "] | {" pathname }
 200 List the pools in
 201 .I filesystem
 202 or
 203 .IR pathname ,
 204 or the OSTs in
 205 .IR filesystem.pool .
 206 .TP
 207 .B quota [-q] [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
 208 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).
 209 .TP
 210 .B quota -t <-u|-g> <filesystem>
 211 To display block and inode grace times for user (-u) or group (-g) quotas
 212 .TP
 213 .B quotacheck [-ugf] <filesystem> (deprecated as of 2.4.0)
 214 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.
 215 .TP
 216 .B quotaon [-ugf] <filesystem> (deprecated as of 2.4.0)
 217 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>)
 218 .TP
 219 .B quotaoff [-ugf] <filesystem> (deprecated as of 2.4.0)
 220 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>=""
 221 .TP
 222 .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>
 223 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
 224 .TP
 225 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 226 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
 227 .TP
 228 .B swap_layouts <filename1> <filename2>
 229 Swap the data (layout and OST objects) of two regular files. The
 230 two files have to be in the same filesystem, owned by the same user,
 231 reside on the same MDT and writable by the user.
 232
 233 Swapping the layout of two directories is not permitted.
 234 .TP
 235 .B data_version [-n] <filename>
 236 Display current version of file data. If -n is specified, data version is read
 237 without taking lock. As a consequence, data version could be outdated if there
 238 is dirty caches on filesystem clients, but this will not force data flushes and
 239 has less impact on filesystem.
 240
 241 Even without -n, race conditions are possible and data version should be
 242 checked before and after an operation to be confident the data did not change
 243 during it.
 244 .TP
 245 .B help
 246 Provides brief help on the various arguments
 247 .TP
 248 .B exit/quit
 249 Quit the interactive lfs session
 250 .SH EXAMPLES
 251 .TP
 252 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
 253 This creates a file striped on two OSTs with 128kB on each stripe.
 254 .TP
 255 .B $ lfs setstripe -d /mnt/lustre/dir
 256 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
 257 .TP
 258 .B $ lfs getstripe -v /mnt/lustre/file1
 259 Lists the detailed object allocation of a given file
 260 .TP
 261 .B $ lfs find /mnt/lustre
 262 Efficiently lists all files in a given directory and its subdirectories
 263 .TP
 264 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 265 Recursively list all regular files in given directory more than 30 days old
 266 .TP
 267 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 268 Recursively list all files in a given directory that have objects on OST2-UUID.
 269 .tP
 270 .B $ lfs check servers
 271 Check the status of all servers (MDT, OST)
 272 .TP
 273 .B $ lfs osts
 274 List all the OSTs
 275 .TP
 276 .B $ lfs df -h
 277 Lists space usage per OST and MDT in human readable format.
 278 .TP
 279 .B $ lfs df -i
 280 Lists inode usage per OST and MDT
 281 .TP
 282 .B $ lfs df --pool <filesystem>[.<pool>] | <pathname>
 283 List space or inode usage for a specific OST pool
 284 .TP
 285 .B $ lfs quota -u bob /mnt/lustre
 286 List quotas of user `bob'
 287 .TP
 288 .B $ lfs quota -t -u /mnt/lustre
 289 Show grace times for user quotas on /mnt/lustre
 290 .TP
 291 .B $ lfs quotachown -i /mnt/lustre
 292 Change file owner and group
 293 .TP
 294 .B $ lfs quotacheck -ug /mnt/lustre
 295 Quotacheck for user and group - will turn on quotas after making the check.
 296 .TP
 297 .B $ lfs quotaon -ug /mnt/lustre
 298 Turn quotas of user and group on
 299 .TP
 300 .B $ lfs quotaoff -ug /mnt/lustre
 301 Turn quotas of user and group off
 302 .TP
 303 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 304 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 305 .TP
 306 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 307 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 308 .SH BUGS
 309 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 310 .SH AUTHOR
 311 The lfs command is part of the Lustre filesystem.
 312 .SH SEE ALSO
 313 .BR lfs-hsm (1),
 314 .BR lctl (8),
 315 .BR lustre (7)