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] [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 N] [[!] --group|-G <name>]
  21         \fB[[!] --uid|-u N] [[!] --user|-U <name>]
  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-name]
  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 <username>|-g <groupname>] <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> <username|groupname>
  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> <username|groupname>
  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.
  93 .TP
  94 .B find
  95 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.
  96 .TP
  97 .B osts
  98 List all the OSTs for the filesystem
  99 .TP
 100 .B getstripe
 101 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).
 102 .TP
 103 .B setstripe [--size stripe-size] [--count stripe-cnt]
 104         \fB[--offset start-ost] [--pool pool-name]\fR
 105 .br
 106 To create a new file, or set the directory default, with the specified striping parameters.  The
 107 .I stripe-count
 108 is the number of OSTs to stripe a file over. A
 109 .I stripe-count
 110 of 0 means to use the filesystem-wide default stripe count (default 1), and a
 111 .I stripe-count
 112 of -1 means to stripe over all available OSTs.  The
 113 .I stripe-size
 114 is the number of bytes to store on each OST before moving to the next OST.  A
 115 .I stripe-size
 116 of 0 means to use the filesystem-wide default stripe size (default 1MB).  The
 117 .I start-ost
 118 is the OST index (base 10, starting at 0) on which to start striping for this file.  A
 119 .I start-ost
 120 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
 121 .I pool-name
 122 is the name of a predefined pool of OSTs (see
 123 .I lctl
 124 ) that will be used for striping. The
 125 .I stripe-count, stripe-size, start-ost
 126 will be used as well; the
 127 .I start-ost
 128 must be part of the pool or an error will be returned.
 129 .TP
 130 .B setstripe -d
 131 Delete the default striping on the specified directory.
 132 .TP
 133 .B poollist <filesystem>[.<pool>] | <pathname>
 134 List the pools in \fBfilesystem\fR or \fBpathname\fR, or the OSTs in \fBfilesystem.pool\fR
 135 .TP
 136 .B quota [-v] [-o obd_uuid|-i mdt_idx|-I ost_idx] [-u|-g] <username|groupname> <filesystem>
 137 To display disk usage and limits, either for the full filesystem, or for objects on a specific obd. A user or group name 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.
 138 .TP
 139 .B quota -t [-u|-g] <filesystem>
 140 To display block and inode grace times for user (-u) or group (-g) quotas
 141 .TP
 142 .B quotachown
 143 To change files' owner and group on OSTs of the specified filesystem
 144 .TP
 145 .B quotacheck [-ugf] <filesystem>
 146 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)
 147 .TP
 148 .B quotaon [-ugf] <filesystem>
 149 To turn filesystem quotas on. Options specify quota for users (-u) groups (-g) and force (-f)
 150 .TP
 151 .B quotaoff [-ugf] <filesystem>
 152 To turn filesystem quotas off.  Options specify quota for users (-u) groups (-g) and force (-f)
 153 .TP
 154 .B quotainv [-ug] [-f] <filesystem>
 155 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.
 156 .TP
 157 .B setquota  [-u|-g] <name> [--block-softlimit <block-softlimit>] [--block-hardlimit <block-hardlimit>] [--inode-softlimit <inode-softlimit>] [--inode-hardlimit <inode-hardlimit>] <filesystem>
 158 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
 159 .TP
 160 .B setquota -t [-u|-g] [--block-grace <block-grace>] [--inode-grace <inode-grace>] <filesystem>
 161 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
 162 .TP
 163 .B help
 164 Provides brief help on the various arguments
 165 .TP
 166 .B exit/quit
 167 Quit the interactive lfs session
 168 .SH EXAMPLES
 169 .TP
 170 .B $ lfs setstripe -s 128k -c 2 /mnt/lustre/file1
 171 This creates a file striped on two OSTs with 128kB on each stripe.
 172 .TP
 173 .B $ lfs setstripe -d /mnt/lustre/dir
 174 This deletes a default stripe pattern on dir. New files will use the default striping pattern created therein.
 175 .TP
 176 .B $ lfs getstripe -v /mnt/lustre/file1
 177 Lists the detailed object allocation of a given file
 178 .TP
 179 .B $ lfs find /mnt/lustre
 180 Efficiently lists all files in a given directory and its subdirectories
 181 .TP
 182 .B $ lfs find /mnt/lustre -mtime +30 -type f -print
 183 Recursively list all regular files in given directory more than 30 days old
 184 .TP
 185 .B $ lfs find --obd OST2-UUID /mnt/lustre/
 186 Recursively list all files in a given directory that have objects on OST2-UUID.
 187 .tP
 188 .B $ lfs check servers
 189 Check the status of all servers (MDT, OST)
 190 .TP
 191 .B $ lfs osts
 192 List all the OSTs
 193 .TP
 194 .B $ lfs df -h
 195 Lists space usage per OST and MDT in human readable format.
 196 .TP
 197 .B $ lfs df -i
 198 Lists inode usage per OST and MDT
 199 .TP
 200 .B $ lfs quota -u bob /mnt/lustre
 201 List quotas of user `bob'
 202 .TP
 203 .B $ lfs quota -t -u /mnt/lustre
 204 Show grace times for user quotas on /mnt/lustre
 205 .TP
 206 .B $ lfs quotachown -i /mnt/lustre
 207 Change file owner and group
 208 .TP
 209 .B $ lfs quotacheck -ug /mnt/lustre
 210 Quotacheck for user and group - will turn on quotas after making the check.
 211 .TP
 212 .B $ lfs quotaon -ug /mnt/lustre
 213 Turn quotas of user and group on
 214 .TP
 215 .B $ lfs quotaoff -ug /mnt/lustre
 216 Turn quotas of user and group off
 217 .TP
 218 .B $ lfs setquota -u bob --block-softlimit 2000000 --block-hardlimit 1000000 /mnt/lustre
 219 Set quotas of user `bob': 1GB block quota hardlimit and 2 GB block quota softlimit
 220 .TP
 221 .B $ lfs setquota -t -u --block-grace 1000 --inode-grace 1w4d /mnt/lustre
 222 Set grace times for user quotas: 1000 seconds for block quotas, 1 week and 4 days for inode quotas
 223 .SH BUGS
 224 The \fBlfs find\fR command isn't as comprehensive as \fBfind\fR(1).
 225 Report bugs using http://bugzilla.lustre.org.
 226 .SH AUTHOR
 227 The lfs command is part of the Lustre filesystem.  Contact http://www.lustre.org/
 228 .SH SEE ALSO
 229 .BR lctl (8),
 230 .BR lustre (7)