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