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 exiting 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<dirname|filename>\fR
  23 .br
  24 .B lfs osts
  25 .br
  26 .B lfs getstripe [--obd|-O <uuid>] [--quiet|-q] [--verbose|-v]
  27         \fB[--recursive|-r] <dirname|filename>\fR
  28 .br
  29 .B lfs setstripe [--size|-s stripe-size] [--count|-c stripe-cnt]
  30         \fB[--offset|-o start-ost] [--pool|-p <pool>]
  31         \fB<dir|filename>\fR
  32 .br
  33 .B lfs setstripe -d <dir>
  34 .br
  35 .B lfs poollist <filesystem>[.<pool>] | <pathname>
  36 .br
  37 .B lfs quota [-v] [-o obd_uuid|-I ost_idx|-i mdt_idx] [-u <uname>| -u <uid>|-g <gname>| -g <gid>] <filesystem>
  38 .br
  39 .B lfs quota -t <-u|-g> <filesystem>
  40 .br
  41 .B lfs quotacheck [-ug] <filesystem>
  42 .br
  43 .B lfs quotachown [-i] <filesystem>
  44 .br
  45 .B lfs quotaon [-ugf] <filesystem>
  46 .br
  47 .B lfs quotaoff [-ug] <filesystem>
  48 .br
  49 .B lfs quotainv [-ug] [-f] <filesystem>
  50 .br
  51 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  52              \fB[--block-softlimit <block-softlimit>]
  53              \fB[--block-hardlimit <block-hardlimit>]
  54              \fB[--inode-softlimit <inode-softlimit>]
  55              \fB[--inode-hardlimit <inode-hardlimit>]
  56              \fB<filesystem>\fR
  57 .br
  58 .B lfs setquota <-u|--user|-g|--group> <uname|uid|gname|gid>
  59              \fB[-b <block-softlimit>] [-B <block-hardlimit>]
  60              \fB[-i <inode-softlimit>] [-I <inode-hardlimit>]
  61              \fB<filesystem>\fR
  62 .br
  63 .B lfs setquota -t <-u|-g>
  64              \fB[--block-grace <block-grace>]
  65              \fB[--inode-grace <inode-grace>]
  66              \fB<filesystem>\fR
  67 .br
  68 .B lfs setquota -t <-u|-g>
  69              \fB[-b <block-grace>] [-i <inode-grace>]
  70              \fB<filesystem>\fR
  71 .br
  72 .B lfs help
  73 .SH DESCRIPTION
  74 .B lfs
  75 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.
  76 .SH OPTIONS
  77 The various options supported by lctl are listed and explained below:
  78 .TP
  79 .B changelog
  80 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.
  81 .TP
  82 .B changelog_clear
  83 Indicate that changelog records previous to <endrec> are no longer of
  84 interest to a particular consumer <id>, potentially allowing the MDT to
  85 free up disk space. An <endrec> of 0 indicates the current last record.
  86 Changelog consumers must be registered on the MDT node using \fBlctl\fR.
  87 .TP
  88 .B check
  89 Display the status of MDS or OSTs (as specified in the command) or all the servers (MDS and OSTs)
  90 .TP
  91 .B df
  92 Report filesystem disk space usage or inodes usage of each MDT/OST. Can limit
  93 the scope to a specific OST pool
  94 .TP
  95 .B find
  96 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.
  97 .TP
  98 .B osts
  99 List all the OSTs for the filesystem
 100 .TP
 101 .B getstripe
 102 To list the striping info for a given filename or files in a directory, optionally recursively, for all files in a directory tree: \fB--quiet\fR (don't print object IDs), \fB--verbose\fR (print striping parameters), \fB--recursive\fR (recurse into subdirectories).
 103 .TP
 104 .B setstripe [--size stripe-size] [--count stripe-cnt]
 105         \fB[--offset start-ost] [--pool <pool>]\fR
 106 .br
 107 To create a new file, or set the directory default, with the specified striping parameters.  The
 108 .I stripe-count
 109 is the number of OSTs to stripe a file over. A
 110 .I stripe-count
 111 of 0 means to use the filesystem-wide default stripe count (default 1), and a
 112 .I stripe-count
 113 of -1 means to stripe over all available OSTs.  The
 114 .I stripe-size
 115 is the number of bytes to store on each OST before moving to the next OST.  A
 116 .I stripe-size
 117 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
 118 .I start-ost
 119 is the OST index (base 10, starting at 0) on which to start striping for this file.  A
 120 .I start-ost
 121 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
 122 .I pool
 123 is the name of a predefined pool of OSTs (see
 124 .I lctl
 125 ) that will be used for striping. The
 126 .I stripe-count, stripe-size, start-ost
 127 will be used as well; the
 128 .I start-ost
 129 must be part of the pool or an error will be returned.
 130 .TP
 131 .B setstripe -d
 132 Delete the default striping on the specified directory.
 133 .TP
 134 .B poollist <filesystem>[.<pool>] | <pathname>
 135 List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
 136 .TP
 137 .B quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g <uname>|<uid>|<gname>|<gid>] <filesystem>
 138 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.
 139 .TP
 140 .B quota -t <-u|-g> <filesystem>
 141 To display block and inode grace times for user (-u) or group (-g) quotas
 142 .TP
 143 .B quotachown
 144 To change files' owner and group on OSTs of the specified filesystem
 145 .TP
 146 .B quotacheck [-ugf] <filesystem>
 147 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)
 148 .TP
 149 .B quotaon [-ugf] <filesystem>
 150 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
 151 .TP
 152 .B quotaoff [-ugf] <filesystem>
 153 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
 154 .TP
 155 .B quotainv [-ug] [-f] <filesystem>
 156 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.
 157 .TP
 158 .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>
 159 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
 160 .TP
 161 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 162 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
 163 .TP
 164 .B help
 165 Provides brief help on the various arguments
 166 .TP
 167 .B exit/quit
 168 Quit the interactive lfs session
 169 .SH EXAMPLES
 170 .TP
 171 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
 172 This creates a file striped on two OSTs with 128kB on each stripe.
 173 .TP
 174 .B $ lfs setstripe -d /mnt/lustre/dir
 175 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
 176 .TP
 177 .B $ lfs getstripe -v /mnt/lustre/file1
 178 Lists the detailed object allocation of a given file
 179 .TP
 180 .B $ lfs find /mnt/lustre
 181 Efficiently lists all files in a given directory and its subdirectories
 182 .TP
 183 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 184 Recursively list all regular files in given directory more than 30 days old
 185 .TP
 186 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 187 Recursively list all files in a given directory that have objects on OST2-UUID.
 188 .tP
 189 .B $ lfs check servers
 190 Check the status of all servers (MDT, OST)
 191 .TP
 192 .B $ lfs osts
 193 List all the OSTs
 194 .TP
 195 .B $ lfs df -h
 196 Lists space usage per OST and MDT in human readable format.
 197 .TP
 198 .B $ lfs df -i
 199 Lists inode usage per OST and MDT
 200 .TP
 201 .B lfs df --pool <filesystem>[.<pool>] | <pathname>
 202 List space or inode usage for a specific OST pool
 203 .TP
 204 .B $ lfs quota -u bob /mnt/lustre
 205 List quotas of user `bob'
 206 .TP
 207 .B $ lfs quota -t -u /mnt/lustre
 208 Show grace times for user quotas on /mnt/lustre
 209 .TP
 210 .B $ lfs quotachown -i /mnt/lustre
 211 Change file owner and group
 212 .TP
 213 .B $ lfs quotacheck -ug /mnt/lustre
 214 Quotacheck for user and group - will turn on quotas after making the check.
 215 .TP
 216 .B $ lfs quotaon -ug /mnt/lustre
 217 Turn quotas of user and group on
 218 .TP
 219 .B $ lfs quotaoff -ug /mnt/lustre
 220 Turn quotas of user and group off
 221 .TP
 222 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 223 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 224 .TP
 225 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 226 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 227 .SH BUGS
 228 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 229 Report bugs using http://bugzilla.lustre.org.
 230 .SH AUTHOR
 231 The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
 232 .SH SEE ALSO
 233 .BR lctl (8),
 234 .BR lustre (7)