lustre/doc/lfs.1

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